|
1 |
| -<br/> |
2 | 1 | <h1 align="center">
|
3 |
| - linux-dash |
| 2 | + <a href="https://afaqurk.github.io/linux-dash"> |
| 3 | + <img src="https://raw.githubusercontent.com/afaqurk/screenshots/master/linux-dash/v2.0-logo.png"/> |
| 4 | + </a> |
4 | 5 | </h1>
|
5 | 6 |
|
6 | 7 | <p align="center">
|
7 |
| - A simple, low-overhead web dashboard for Linux |
| 8 | + <small>A simple & low-overhead web dashboard for linux systems</small> |
8 | 9 | </p>
|
9 | 10 |
|
10 | 11 | <p align="center">
|
11 |
| - <strong> |
12 |
| - <a href="http://linuxdash.afaqtariq.com"><i>Demo</i></a> | |
13 |
| - <a href="#features"><i>Features</i></a> | |
14 |
| - <a href="#installation"> |
15 |
| - <i>Installation</i></a> | |
16 |
| - <a href="#support"><i>Support</i></a> |
17 |
| - </strong> |
| 12 | + <small> |
| 13 | + <a href="https://afaqurk.github.io/linux-dash">Demo</a> | |
| 14 | + <a href="https://github.com/afaqurk/linux-dash/wiki"> |
| 15 | + Docs |
| 16 | + </a> |
| 17 | + </small> |
18 | 18 | </p>
|
19 | 19 |
|
20 |
| -<p align="center"> |
21 |
| - <a href="https://gitter.im/afaqurk/linux-dash"> |
22 |
| - <img |
23 |
| - src="https://badges.gitter.im/gitterHQ/gitter.png" |
24 |
| - alt="Linux Dash Gitter chat"> |
25 |
| - </a> |
26 |
| -</p> |
27 | 20 |
|
28 |
| -<br/> |
29 | 21 | <p align="center">
|
30 |
| - <a href="http://linuxdash.afaqtariq.com"> |
31 |
| - <img |
32 |
| - width="80%" |
33 |
| - alt="Linux Dash screenshot" |
34 |
| - src="http://i.imgur.com/tehGyrQ.gif"> |
| 22 | + <a href="https://gitter.im/afaqurk/linux-dash"> |
| 23 | + <img |
| 24 | + src="https://badges.gitter.im/gitterHQ/gitter.png" |
| 25 | + alt="linux-dash Gitter chat"> |
35 | 26 | </a>
|
36 | 27 | </p>
|
37 | 28 |
|
38 | 29 | <br/>
|
39 | 30 |
|
40 | 31 | ## Features
|
41 |
| -* A beautiful, simple web-based dashboard for monitoring a linux server |
42 |
| -* Only ~1MB on disk! *(.git removed)* |
43 |
| -* Live graphs, refresh-able widgets, and a growing # of supported modules |
44 |
| -* Drop-in installation for PHP, Node.js, Python, and Go |
| 32 | +* **Small** ----- Under 400KB on disk _(with .git removed)!_ |
| 33 | +* **Simple** ---- A minimalist, beautiful dashboard |
| 34 | +* **Easy** ------ Drop-in installation |
| 35 | +* **Versatile** -- Choose your stack from Node.js, Go, Python, PHP |
45 | 36 |
|
46 | 37 | ## Installation
|
47 | 38 |
|
48 |
| -#### Step 1: Download Linux Dash |
49 |
| - |
50 |
| -Clone the git repo |
| 39 | +### Step 1 |
51 | 40 | ```sh
|
52 |
| -git clone https://github.com/afaqurk/linux-dash.git |
| 41 | +## 1. clone the repo |
| 42 | +git clone --depth 1 https://github.com/afaqurk/linux-dash.git |
| 43 | + |
| 44 | +## 2. go to the cloned directory |
| 45 | +cd linux-dash/app/server |
| 46 | + |
53 | 47 | ```
|
| 48 | +OR, if you prefer to download manually: |
54 | 49 |
|
55 |
| -Or download it **[here](https://github.com/afaqurk/linux-dash/archive/master.zip)**. |
| 50 | +```sh |
| 51 | +## 1. Download the .zip |
| 52 | +curl -LOk https://github.com/afaqurk/linux-dash/archive/master.zip && unzip master.zip |
56 | 53 |
|
57 |
| -#### Step 2: Secure Linux Dash |
| 54 | +## 2. navigate to downloaded & unzipped dir |
| 55 | +cd linux-dash-master/app/server |
58 | 56 |
|
59 |
| -Linux Dash does not provide any security or authentication features. |
| 57 | +``` |
60 | 58 |
|
61 |
| -**It is strongly recommended** that all Linux Dash installations be protected via a security measure of your choice. |
| 59 | +### Step 2 |
62 | 60 |
|
63 |
| -#### Step 3: Start Linux Dash |
64 |
| -<h6 align="center"> |
65 |
| -Linux Dash can be run in: <u>Node.js</u>, PHP, Go, or Python. |
66 |
| -<br/> |
67 |
| -<sub> |
68 |
| -* Node.js is the recommended platform since it has native support for websockets and fast I/O. |
69 |
| -</sub> |
70 |
| -</h6> |
| 61 | +See instructions for preferred server linux-dash server _(all included)_: |
71 | 62 |
|
72 |
| -First, navigate to the `linux-dash` folder you downloaded or cloned. |
| 63 | +* [Node.js](#if-using-nodejs) _(recommended)_ |
| 64 | +* [Go](#if-using-go) |
| 65 | +* [Python](#if-using-python) |
| 66 | +* [PHP](#if-using-php) |
73 | 67 |
|
74 |
| -Then, refer to the section for your preferred platform: |
| 68 | +#### If Using Node.js |
| 69 | +```sh |
| 70 | +## install dependencies |
| 71 | +npm install --production |
75 | 72 |
|
76 |
| -##### Node.js |
| 73 | +## start linux-dash (on port 80 by default; may require sudo) |
| 74 | +## You may change this with the `LINUX_DASH_SERVER_PORT` environment variable (eg. `LINUX_DASH_SERVER_PORT=8080 node server`) |
| 75 | +## or provide a --port flag to the command below |
| 76 | +node index.js |
77 | 77 |
|
78 |
| -Install NPM dependencies |
79 |
| -``` |
80 |
| -npm install |
81 | 78 | ```
|
82 | 79 |
|
83 |
| -Start Linux Dash |
| 80 | +#### If Using Go |
| 81 | +```sh |
| 82 | +## start the server (on port 80 by default; may require sudo) |
| 83 | +go run index.go |
84 | 84 | ```
|
85 |
| -node server/ |
| 85 | + |
| 86 | +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 |
| 87 | + |
| 88 | +#### If Using Python |
| 89 | +```sh |
| 90 | +# Start the server (on port 80 by default; may require sudo). |
| 91 | +python index.py |
86 | 92 | ```
|
87 | 93 |
|
88 |
| -<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> |
| 94 | +#### If Using PHP |
89 | 95 |
|
90 |
| -##### PHP |
91 | 96 | 1. Make sure you have the `exec`, `shell_exec`, and `escapeshellarg` functions enabled
|
92 |
| -2. Restart your web server (Apache, nginx, etc.) |
| 97 | +2. Point your web server to `app/` directory under `linux-dash` |
| 98 | +2. Restart your web server (Apache, nginx, etc.) |
93 | 99 | - For PHP + Apache setup follow the [Digital Ocean tutorial](https://www.digitalocean.com/community/tutorials/how-to-install-linux-dash-on-ubuntu-14-04).
|
94 | 100 | - For help with nginx setup, see [this gist](https://gist.github.com/sergeifilippov/8909839) by [@sergeifilippov](https://github.com/sergeifilippov).
|
95 | 101 |
|
96 |
| -##### Go |
97 |
| -Go to the `linux-dash/server` folder and run |
98 |
| -``` |
99 |
| -go run index.go |
100 |
| -``` |
101 |
| - |
102 |
| -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 |
| 102 | +## Support |
103 | 103 |
|
104 |
| -##### Python 2 |
105 |
| -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. |
| 104 | +For general help, please use the [Gitter chat room](https://gitter.im/afaqurk/linux-dash). |
106 | 105 |
|
107 |
| -## Support |
| 106 | +## Security |
108 | 107 |
|
109 |
| -For help with general setup and configuration issues please use the [Linux Dash Gitter chat room](https://gitter.im/afaqurk/linux-dash). |
| 108 | +**It is strongly recommended** that all linux-dash installations be protected via a security measure of your choice. |
110 | 109 |
|
111 |
| -The following distributions are supported: |
112 |
| -* Arch |
113 |
| -* Debian 6,7 |
114 |
| -* Ubuntu 11.04+ |
115 |
| -* Linux Mint 16+ |
116 |
| -* CentOS 5, 6 |
117 |
| -* openSUSE |
| 110 | +linux-dash does not provide any security or authentication features. |
0 commit comments