linux-dash README

The project's README from github.com/tariqbuilds/linux-dash. As one markdown file: README.md.

v2.0
A simple & low-overhead web dashboard for linux systems

Demo  |  Docs

linux-dash Gitter chat


Features

Installation

Step 1

## 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:

## 1. Download the .zip
curl -LOk https://github.com/afaqurk/linux-dash/archive/master.zip && unzip master.zip

## 2. navigate to downloaded & unzipped dir
cd linux-dash-master/app/server

Step 2

See instructions for preferred server linux-dash server (all included):

If Using Node.js

## install dependencies
npm install --production

## 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
## Additionally, the server will listen on every network interface (`0.0.0.0`).
## You may change this with the `LINUX_DASH_SERVER_HOST` environment variable (eg. `LINUX_DASH_SERVER_HOST=127.0.0.1 node server`)
## or provide a --host flag to the command below
node index.js

If Using Go

## start the server (on port 80 by default; may require sudo)
go run index.go

To build a binary, run go build && ./server -h. See @tehbilly's notes here for binary usage options

If Using Python

# Start the server (on port 80 by default; may require sudo).
python index.py

If Using PHP

  1. Make sure you have the exec, shell_exec, and escapeshellarg functions enabled
  2. Point your web server to app/ directory under linux-dash
  3. Restart your web server (Apache, nginx, etc.)

Support

For general help, please use the Gitter chat room.

Security

It is strongly recommended that all linux-dash installations be protected via a security measure of your choice.

Linux Dash does not provide any security or authentication features.

linux-dash (tariqbuilds/linux-dash)

server-monitoring
Searching Database…

10.6K ·GitHub
Linux-dash
What is this?Linux Dash is a simple, low-overhead web dashboard for Linux machines: one small page in your browser showing live stats about the server it runs on.
Is this a cloud service, or do I host it myself?You host it yourself — the project includes its own server scripts that you run on the Linux box, and then you open the dashboard page in a browser.
How do I get it running?Download the project, start one of the included server scripts for your stack of choice, and open the dashboard URL. The README bills it as a drop-in installation.
Do I need Node.js specifically, or will something else work?Any of four stacks works — Node.js (the recommended one), Go, Python, or PHP — with the matching server included, so pick whatever the machine already runs.
Does it have any login or access control?None. The README strongly recommends putting your own security measure in front of it, because Linux Dash itself ships no authentication features.
How heavy is it on the server?Very light — the whole project is under 400KB on disk with .git removed, and low overhead is one of its headline features.
Can I run it on plain PHP hosting such as Apache?Yes — point your web server (Apache or nginx) at the app/ directory, make sure the exec, shell_exec and escapeshellarg functions are enabled, then restart the web server. The README links a Digital Ocean tutorial for the PHP + Apache setup.
Does the dashboard update in real time?Yes — the Node.js server is built on express and websockets, so stats are pushed to the browser live rather than on manual refresh.
Will it run on my Mac or Windows server?No — it is built for Linux systems; host it on a Linux box and open the dashboard from any machine with a browser.
What are similar projects?dockge, omnyssh, walle-web, Checkmate, antigravity_phone_chat, Crucix, Profile-Toolkit-for-FSLogix, wekan
Which topics is it in?server-monitoring, express, websocket, sysadmin, real-time, monitoring, dashboard, ui, web-app, gui, free, tool
Creator
tariqbuilds
Size
4.6 MB
Stars
10.6K
Updated
CommitMar 22Release2.0May 14
Age
13y
Commits · 90 Days