MMDVMHost-Dashboard/README.md

# MMDVMHost-Dashboard
Dashboard for MMDVMHost (by G4KLX)
==================================

About
=====
MMDVMHost-Dashboard is a web-dashboard for visualization of different data like
system temperatur, cpu-load ... and it shows a last-heard-list.

It relies on MMDVMHost by G4KLX (see https://github.com/g4klx/MMDVMHost). At 
this place a big thank you to Jonathan for his great work he did with this 
software.

Based on G4KLX code, mod by EA4GKQ

Required are
============
* Webserver like lighttpd or similar
* php5


Installation
============
* Please ensure to not put loglevels at 0 in MMDVM.ini.
* Copy all files into your webroot and enjoy working with it.
* Create a config/config.php by calling setup.php and giving suitable values
* If Dashboard is working, remove setup.php from your webroot

For detailled installation see `linux-step-by-step.md` within this repository.

Usage
=====
To use the dashboard simply call the corresponding address in a webbrowser. The webbrowser has to be javascript-enabled because of the usage of DataTables, that would only be functional with Javascript enabled for this site!

Features
========
At the moment there are several information-sections shown:
* System Info: 
  Here you'll find live info about the host-system itself like CPU-freq, temperature, system-load, cpu-usage, uptime and cpu-idle-time.
* Repeater Info:
  Here are some basic repeater info and link-states
* Enabled Modes
  This is a list of enabled modes. If green, it's enabled, if grey, it's disabled. If it is red, there is an error-state with MMDVMHost or ircddbgateway.
* Last Heard List of today's x callsigns:
  This is a list of the last x callsigns heard in general in the system over all modes and directions. X is to be configured in /config/config.php
* Today's last 10 local transmissions:
  For better debugging/calibrating etc. the last 10 local transmissions (RF-side of the repeater) are listed.

New features by EA4GKQ
======================
* Buttons toolbar, security-hint: to make this function secure, please enable htpasswd-function for folder "scripts"!
* LastHeard table are sorted 
* Some mods to improve mobile experience

Contact
=======
Feel free to contact the author via email: dg9vh[@]darc.de

Feel free to contact the mod author via email: ea4gkq[@]ure.es
Initial commit 2016-04-29 15:20:07 +02:00			`# MMDVMHost-Dashboard`
			`Dashboard for MMDVMHost (by G4KLX)`
First attempt of dashboard 2016-04-30 15:38:12 +02:00			`==================================`

Updating Readme.md 2016-05-04 18:36:38 +02:00			`About`
			`=====`
			`MMDVMHost-Dashboard is a web-dashboard for visualization of different data like`
			`system temperatur, cpu-load ... and it shows a last-heard-list.`
First attempt of dashboard 2016-04-30 15:38:12 +02:00
Updating Readme.md 2016-05-04 18:36:38 +02:00			`It relies on MMDVMHost by G4KLX (see https://github.com/g4klx/MMDVMHost). At`
			`this place a big thank you to Jonathan for his great work he did with this`
			`software.`
Loglevels in Readme 2016-05-01 22:31:53 +02:00
EA4GKQ mod 2016-06-24 18:45:34 +02:00			`Based on G4KLX code, mod by EA4GKQ`

Updating Readme.md 2016-05-04 18:36:38 +02:00			`Required are`
			`============`
Update README.md 2016-09-12 09:16:25 +02:00			`* Webserver like lighttpd or similar`
reformatting 2016-05-12 22:36:20 +02:00			`* php5`

Updating Readme.md 2016-05-04 18:36:38 +02:00
			`Installation`
			`============`
			`* Please ensure to not put loglevels at 0 in MMDVM.ini.`
			`* Copy all files into your webroot and enjoy working with it.`
creating setup-routine to run basic configuration in browser. Reorganized some config-constants 2016-05-20 14:16:33 +02:00			`* Create a config/config.php by calling setup.php and giving suitable values`
			`* If Dashboard is working, remove setup.php from your webroot`
First attempt of dashboard 2016-04-30 15:38:12 +02:00
improved documentation 2016-05-15 22:35:00 +02:00			For detailled installation see `linux-step-by-step.md` within this repository.

enable javaascript 2016-09-01 11:18:10 +02:00			`Usage`
			`=====`
			`To use the dashboard simply call the corresponding address in a webbrowser. The webbrowser has to be javascript-enabled because of the usage of DataTables, that would only be functional with Javascript enabled for this site!`

improved documentation 2016-05-15 22:35:00 +02:00			`Features`
			`========`
			`At the moment there are several information-sections shown:`
			`* System Info:`
			`Here you'll find live info about the host-system itself like CPU-freq, temperature, system-load, cpu-usage, uptime and cpu-idle-time.`
			`* Repeater Info:`
			`Here are some basic repeater info and link-states`
			`* Enabled Modes`
			`This is a list of enabled modes. If green, it's enabled, if grey, it's disabled. If it is red, there is an error-state with MMDVMHost or ircddbgateway.`
			`* Last Heard List of today's x callsigns:`
			`This is a list of the last x callsigns heard in general in the system over all modes and directions. X is to be configured in /config/config.php`
			`* Today's last 10 local transmissions:`
			`For better debugging/calibrating etc. the last 10 local transmissions (RF-side of the repeater) are listed.`
Update README.md 2016-06-24 18:53:58 +02:00
Update README.md 2016-06-24 18:50:58 +02:00			`New features by EA4GKQ`
			`======================`
improved buttons of ea4gkq to be enabled via setup-switch 2016-06-26 18:57:22 +02:00			`* Buttons toolbar, security-hint: to make this function secure, please enable htpasswd-function for folder "scripts"!`
Update README.md 2016-06-24 18:50:58 +02:00			`* LastHeard table are sorted`
			`* Some mods to improve mobile experience`
improved documentation 2016-05-15 22:35:00 +02:00
First attempt of dashboard 2016-04-30 15:38:12 +02:00			`Contact`
			`=======`
EA4GKQ mod 2016-06-24 18:45:34 +02:00			`Feel free to contact the author via email: dg9vh[@]darc.de`
Update README.md 2016-06-24 18:53:58 +02:00
EA4GKQ mod 2016-06-24 18:45:34 +02:00			`Feel free to contact the mod author via email: ea4gkq[@]ure.es`