linuxdash

README

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

Demo  |  Docs

Features

• 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

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

• Node.js (recommended)
• Go
• Python
• PHP

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.)

• For PHP + Apache setup follow the Digital Ocean tutorial.
• For help with nginx setup, see this gist by @sergeifilippov.

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.

Documentation

Index

• Constants
• Variables
• func DashServe(w http.ResponseWriter, r *http.Request, f func(module string) ([]byte, error))
• func ExecuteShell(module string) ([]byte, error)
• func ExtractShell(module string) string
• func MakeDashServe(f func(module string) ([]byte, error)) http.HandlerFunc

Constants

const Shebang = `#!/bin/bash`

Variables

var DashStatic, _ = fs.Sub(assetsFs, "static")

var LinuxJsonApiSh string

var PingHosts []byte

Functions

func DashServe

func DashServe(w http.ResponseWriter, r *http.Request, f func(module string) ([]byte, error))

func ExecuteShell

func ExecuteShell(module string) ([]byte, error)

func ExtractShell

func ExtractShell(module string) string

func MakeDashServe

func MakeDashServe(f func(module string) ([]byte, error)) http.HandlerFunc