Skip to content

Commit

Permalink
Merge branch 'v2.0'
Browse files Browse the repository at this point in the history
  • Loading branch information
tariqbuilds committed May 14, 2017
2 parents f248539 + 00f8a31 commit 6f76d95
Show file tree
Hide file tree
Showing 132 changed files with 5,024 additions and 4,894 deletions.
12 changes: 0 additions & 12 deletions .editorconfig

This file was deleted.

3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
vendor
node_modules
*.log
*/linuxDash.min.js.map
temp
137 changes: 65 additions & 72 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,117 +1,110 @@
<br/>
<h1 align="center">
linux-dash
<a href="https://afaqurk.github.io/linux-dash">
<img src="https://github.com/raw/afaqurk/screenshots/master/linux-dash/v2.0-logo.png"/>
</a>
</h1>

<p align="center">
A simple, low-overhead web dashboard for Linux
<small>A simple & low-overhead web dashboard for linux systems</small>
</p>

<p align="center">
<strong>
<a href="http://linuxdash.afaqtariq.com"><i>Demo</i></a> &nbsp;|&nbsp;
<a href="#features"><i>Features</i></a> &nbsp;|&nbsp;
<a href="#installation">
<i>Installation</i></a> &nbsp;|&nbsp;
<a href="#support"><i>Support</i></a>
</strong>
<small>
<a href="https://afaqurk.github.io/linux-dash">Demo</a> &nbsp;|&nbsp;
<a href="https://github.com/afaqurk/linux-dash/wiki">
Docs
</a>
</small>
</p>

<p align="center">
<a href="https://gitter.im/afaqurk/linux-dash">
<img
src="https://badges.gitter.im/gitterHQ/gitter.png"
alt="Linux Dash Gitter chat">
</a>
</p>

<br/>
<p align="center">
<a href="http://linuxdash.afaqtariq.com">
<img
width="80%"
alt="Linux Dash screenshot"
src="http://i.imgur.com/tehGyrQ.gif">
<a href="https://gitter.im/afaqurk/linux-dash">
<img
src="https://badges.gitter.im/gitterHQ/gitter.png"
alt="linux-dash Gitter chat">
</a>
</p>

<br/>

## Features
* A beautiful, simple web-based dashboard for monitoring a linux server
* Only ~1MB on disk! *(.git removed)*
* Live graphs, refresh-able widgets, and a growing # of supported modules
* Drop-in installation for PHP, Node.js, Python, and Go
* **Small** ----- Under 400KB on disk _(with .git removed)!_
* **Simple** ---- A minimalist, beautiful dashboard
* **Easy** ------ Drop-in installation
* **Versatile** -- Choose your stack from Node.js, Go, Python, PHP

## Installation

#### Step 1: Download Linux Dash

Clone the git repo
### Step 1
```sh
git clone https://github.com/afaqurk/linux-dash.git
## 1. clone the repo
git clone --depth 1 https://github.com/afaqurk/linux-dash.git

## 2. go to the cloned directory
cd linux-dash/app/server

```
OR, if you prefer to download manually:

Or download it **[here](https://github.com/afaqurk/linux-dash/archive/master.zip)**.
```sh
## 1. Download the .zip
curl -LOk https://github.com/afaqurk/linux-dash/archive/master.zip && unzip master.zip

#### Step 2: Secure Linux Dash
## 2. navigate to downloaded & unzipped dir
cd linux-dash-master/app/server

Linux Dash does not provide any security or authentication features.
```

**It is strongly recommended** that all Linux Dash installations be protected via a security measure of your choice.
### Step 2

#### Step 3: Start Linux Dash
<h6 align="center">
Linux Dash can be run in: <u>Node.js</u>, PHP, Go, or Python.
<br/>
<sub>
* Node.js is the recommended platform since it has native support for websockets and fast I/O.
</sub>
</h6>
See instructions for preferred server linux-dash server _(all included)_:

First, navigate to the `linux-dash` folder you downloaded or cloned.
* [Node.js](#if-using-nodejs) _(recommended)_
* [Go](#if-using-go)
* [Python](#if-using-python)
* [PHP](#if-using-php)

Then, refer to the section for your preferred platform:
#### If Using Node.js
```sh
## install dependencies
npm install --production

##### Node.js
## start linux-dash (on port 80 by default; may require sudo)
## You may change this with the `LINUX_DASH_SERVER_PORT` environment variable (eg. `LINUX_DASH_SERVER_PORT=8080 node server`)
## or provide a --port flag to the command below
node index.js

Install NPM dependencies
```
npm install
```

Start Linux Dash
#### If Using Go
```sh
## start the server (on port 80 by default; may require sudo)
go run index.go
```
node server/

To build a binary, run `go build && ./server -h`. See [@tehbilly](https://github.com/sergeifilippov)'s notes [here](https://github.com/afaqurk/linux-dash/pull/281) for binary usage options

#### If Using Python
```sh
# Start the server (on port 80 by default; may require sudo).
python index.py
```

<small>Default port for Linux Dash is 80. You may change this with the `LINUX_DASH_SERVER_PORT` environment variable (eg. `LINUX_DASH_SERVER_PORT=8080 node server`) or editing the [server/index.js on line 9](https://github.com/afaqurk/linux-dash/blob/master/server/index.js#L9)</small>
#### If Using PHP

##### PHP
1. Make sure you have the `exec`, `shell_exec`, and `escapeshellarg` functions enabled
2. Restart your web server (Apache, nginx, etc.)
2. Point your web server to `app/` directory under `linux-dash`
2. Restart your web server (Apache, nginx, etc.)
- For PHP + Apache setup follow the [Digital Ocean tutorial](https://www.digitalocean.com/community/tutorials/how-to-install-linux-dash-on-ubuntu-14-04).
- For help with nginx setup, see [this gist](https://gist.github.com/sergeifilippov/8909839) by [@sergeifilippov](https://github.com/sergeifilippov).

##### Go
Go to the `linux-dash/server` folder and run
```
go run index.go
```

To build a binary, run `go build && ./server -h`. See [@tehbilly](https://github.com/sergeifilippov)'s notes [here](https://github.com/afaqurk/linux-dash/pull/281) for binary usage options
## Support

##### Python 2
Run `./python-server.py` will run a server on port 80 which is the default. You can provide a specific port via the `--port` flag.
For general help, please use the [Gitter chat room](https://gitter.im/afaqurk/linux-dash).

## Support
## Security

For help with general setup and configuration issues please use the [Linux Dash Gitter chat room](https://gitter.im/afaqurk/linux-dash).
**It is strongly recommended** that all linux-dash installations be protected via a security measure of your choice.

The following distributions are supported:
* Arch
* Debian 6,7
* Ubuntu 11.04+
* Linux Mint 16+
* CentOS 5, 6
* openSUSE
linux-dash does not provide any security or authentication features.
27 changes: 27 additions & 0 deletions app/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
<!DOCTYPE html>
<html lang="en" ng-app="linuxDash">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Linux Dash : Simple, beautiful server monitoring web dashboard</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="Monitor your Linux server through a simple web dashboard. Open source and free!">
<meta name="apple-mobile-web-app-capable" content="yes">
<link href='//fonts.googleapis.com/css?family=Merriweather:300italic,300|Open+Sans:400,600' rel='stylesheet' type='text/css'>
<link href='linuxDash.min.css' rel='stylesheet' type='text/css'>

<!-- Le HTML5 shim, for IE6-8 support of HTML5 elements -->
<!--[if lt IE 9]>
<script src="https://html5shim.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
</head>
<body>

<nav-bar></nav-bar>

<!-- Templates Get Rendered Here -->
<div id="plugins" ng-view></div>

<!-- Javascript-->
<script src="linuxDash.min.js" type="text/javascript"></script>
</body>
</html>
10 changes: 10 additions & 0 deletions app/linuxDash.min.css

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 6f76d95

Please sign in to comment.