Commit 6059ea1c authored by Afaq Tariq's avatar Afaq Tariq
Browse files

Installation steps back in readme

parent b2f6e619
......@@ -11,7 +11,7 @@
<strong>
<a href="http://linuxdash.afaqtariq.com"><i>Demo</i></a> &nbsp;|&nbsp;
<a href="#features"><i>Features</i></a> &nbsp;|&nbsp;
<a href="https://github.com/afaqurk/linux-dash/wiki/Install-Linux-Dash">
<a href="#installation">
<i>Installation</i></a> &nbsp;|&nbsp;
<a href="#support"><i>Support</i></a>
</strong>
......@@ -43,6 +43,73 @@
* Live graphs, refresh-able widgets, and a growing # of supported modules
* Drop-in installation for PHP, Node.js, Python, and Go
## Installation
#### Step 1: Download Linux Dash
Clone the git repo
```sh
git clone https://github.com/afaqurk/linux-dash.git
```
Or download it **[here](https://github.com/afaqurk/linux-dash/archive/master.zip)**.
<hr/>
#### Step 2: Secure Linux Dash
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.
<hr/>
#### 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 supports websockets.
</sub>
</h6>
First, navigate to the `linux-dash` folder you downloaded or cloned.
Then, refer to the section for your preferred platform:
##### Node.js
Install NPM dependencies
```
npm install
```
Start Linux Dash
```
node server/
```
Default port for Linux Dash is 80. You may change this in [server/index.js on line 9](https://github.com/afaqurk/linux-dash/blob/master/server/index.js#L9)
<br/>
##### PHP
1. Make sure you have the `exec`, `shell_exec`, and `escapeshellarg` functions enabled
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).
<br/>
##### 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
##### Python
Run `./python-server.py` will run a server on port 80.
## Support
For help with general setup and configuration issues please use the [Linux Dash Gitter chat room](https://gitter.im/afaqurk/linux-dash).
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment