Skip to content

Commit c5ef095

Browse files
committed
updated README for 1.5
1 parent 5315767 commit c5ef095

File tree

1 file changed

+35
-15
lines changed

1 file changed

+35
-15
lines changed

README.md

Lines changed: 35 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -7,29 +7,49 @@ A simple, low-overhead web dashboard for GNU / Linux. (~1MB)
77
![Linux Dash screenshot](https://raw.githubusercontent.com/afaqurk/screenshots/master/linux-dash/system-status-full.png)
88

99
## Features
10-
* A beautiful, simple web-based dashboard for monitoring server info
11-
* Only 1MB on disk! (with .git removed)
12-
* Live graphs, refresh-able widgets, and a growing # of supported modules
13-
* Drop-in install for servers with Apache2 or nginx + PHP
14-
* Easy to customize and extend
15-
* Support for wide range of linux server flavors [(See Support section)](#support)
10+
* A beautiful, simple web-based dashboard for monitoring a linux server
11+
* Only 1MB on disk! (.git removed)
12+
* Live graphs, refresh-able widgets, and a growing # of supported modules
13+
* Drop-in install for PHP (Apache, NGINX) and Node.js
1614

1715
## Installation
1816

19-
1. Make sure you have `php5-json` installed and enabled
20-
2. Make sure you have the `exec`, `shell_exec`, and `escapeshellarg` functions enabled
21-
3. [Download the source](https://github.com/afaqurk/linux-dash/archive/master.zip) or clone the repo
22-
4. Place it in `/var/www/` (for Apache); For nginx setup, see [this gist](https://gist.github.com/sergeifilippov/8909839) by [@sergeifilippov](https://github.com/sergeifilippov)
17+
### PHP
18+
19+
1. Make sure you have the `exec`, `shell_exec`, and `escapeshellarg` functions enabled
20+
2. Go to the web root for your server
21+
- `/var/www/` by default for Apache
22+
- For help with nginx setup, see [this gist](https://gist.github.com/sergeifilippov/8909839) by [@sergeifilippov](https://github.com/sergeifilippov).
23+
3. Get a copy of Linux Dash by one of the following methods:
24+
- Use composer, run `composer create-project afaqurk/linux-dash -s dev`
25+
- Or clone the git repo: `git clone https://github.com/afaqurk/linux-dash.git`
26+
- Or [download the source](https://github.com/afaqurk/linux-dash/archive/master.zip)
27+
28+
### Node.js
29+
30+
1. Get a copy of Linux Dash by one of the following methods
31+
- Clone the git repo: `git clone https://github.com/afaqurk/linux-dash.git`
32+
- Or [download the source](https://github.com/afaqurk/linux-dash/archive/master.zip)
33+
2. Go into the linux-dash folder and run `npm install`
34+
3. Start Linux Dash by running: `node server`
35+
36+
## Security
2337

2438
**Please note: If you would like to limit access to linux-dash, please add
2539
`.htaccess` or other security measure.**
2640

2741
## Goals for v2.0
28-
- [ ] Backend ported to Python from PHP
29-
- [ ] Add config file
30-
- [ ] Segregate core code-base and modules
31-
- Each module in a separate directory with front-end template, back-end file, bash script
32-
- [ ] Add project to package managers
42+
- [x] Backend ported to ~~ Python ~~ shell scripts & python from PHP
43+
- [x] Add config file
44+
- [x] Segregate core code-base and modules
45+
- [ ] Each module in a separate directory with front-end template, back-end file, bash script
46+
- Add project to package managers
47+
- [x] npm
48+
- [x] composer
49+
- [ ] aur
50+
- [ ] apt
51+
- [x] Bonus: multiple server side languages supported
52+
- node & php currently
3353

3454
## Support
3555
* OS

0 commit comments

Comments
 (0)