Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Porting System Stats / Management #153

Merged
merged 11 commits into from
Oct 26, 2020
14 changes: 10 additions & 4 deletions .wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ CLI
Clonezilla
Cloudflare
CloudPrint
Cloudshell
CloudShell
conf
config
configs
Expand Down Expand Up @@ -132,6 +132,7 @@ Jellyfin
Joulinar
journald
jRiver
JSON
JustBoom
Kbit
KiB
Expand All @@ -141,6 +142,7 @@ Kodi
Koel
Komga
LASP
lcd
LEDs
LEMP
LESP
Expand Down Expand Up @@ -193,7 +195,7 @@ NanoPi
NAS
natively
ncc
NetData
Netdata
Nextcloud
nextcloud
NFS
Expand All @@ -210,6 +212,7 @@ NZBGet
occ
OctoPrint
octoprint
odroid
Odroid
Odroids
Ok
Expand All @@ -228,7 +231,7 @@ php
phpBB
phpinfo
phpMyAdmin
PhpSysInfo
phpSysInfo
Pi-hole
PiJuice
Pinebook
Expand Down Expand Up @@ -280,6 +283,7 @@ Signalyst
SMB
smb
sn
SNMP
Sonarr
SPC
SPI
Expand All @@ -293,6 +297,7 @@ StephanStS
sudo
symlink
Syncthing
syslog
systemd
TasmoAdmin
Tasmota
Expand Down Expand Up @@ -327,8 +332,9 @@ VNC
VNCSERVER
VPN
vsftpd
Waveshare
WebIOPi
Webmin
webmin
webserver
Webservers
Webserves
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
18 changes: 9 additions & 9 deletions docs/dietpi_optimised_software.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,15 +156,15 @@
- [**Remot3.it - (Weaved) Access your device over the internet**](../software/remote_desktop/#remot3it-weaved-access-your-device-over-the-internet)
- [**VirtualHere - Share physically attached USB devices from your SBC over the network**](../software/remote_desktop/#virtualhere-share-physically-attached-usb-devices-from-your-sbc-over-the-network)

## System Stats / Management

- [DietPi-Cloudshell - Lightweight system stats for your LCD display or monitor.](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5&start=20#p204)
- [Raspcontrol - Web interface system stats](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5&start=20#p89)
- [Linux Dash - Web interface system stats](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5&start=20#p108)
- [PhpSysInfo - Web interface system stats](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5&start=30#p451)
- [RPi Monitor - Web interface system stats](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5&start=50#p1503)
- [NetData - Web interface system stats](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5&start=60#p1611)
- [Webmin - Remote system management with web interface](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5&start=80#p3047)
## [System Stats / Management](../software/system_stats/#system-stats-management/)

- [**DietPi-CloudShell - Lightweight system stats for your LCD display or monitor**](../software/system_stats/#dietpi-cloudshell-lightweight-system-stats-for-your-lcd-display-or-monitor)
- [**Raspcontrol - Web interface system stats**](../software/system_stats/#raspcontrol-web-interface-system-stats)
- [**Linux Dash - Web interface system stats**](../software/system_stats/#linux-dash-web-interface-system-stats)
- [**phpSysInfo - Web interface system stats**](../software/system_stats/#phpsysinfo-web-interface-system-stats)
- [**RPi-Monitor - Web interface system stats**](../software/system_stats/#rpi-monitor-web-interface-system-stats)
- [**Netdata - Web interface system stats**](../software/system_stats/#netdata-web-interface-system-stats)
- [**webmin - Remote system management with web interface**](../software/system_stats/#webmin-remote-system-management-with-web-interface)

## [System Security](../software/system_security/)

Expand Down
2 changes: 1 addition & 1 deletion docs/software/dns_servers.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Pi-hole is a DNS sinkhole with web interface that will block ads for any device

The web interface of Pi-hole can be accessed via:

- URL= `http://<your.IP/domain/admin>`
- URL= `http://<your.IP>/admin`
- Password = `<yourGlobalSoftwarePassword>` (default: dietpi)

=== "Configuration"
Expand Down
258 changes: 249 additions & 9 deletions docs/software/system_stats.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,257 @@

## Overview

- [DietPi-Cloudshell - Lightweight system stats for your LCD display or monitor.](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5&start=20#p204)
- [Raspcontrol - Web interface system stats](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5&start=20#p89)
- [Linux Dash - Web interface system stats](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5&start=20#p108)
- [PhpSysInfo - Web interface system stats](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5&start=30#p451)
- [RPi Monitor - Web interface system stats](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5&start=50#p1503)
- [NetData - Web interface system stats](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5&start=60#p1611)
- [Webmin - Remote system management with web interface](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5&start=80#p3047)
- [**DietPi-CloudShell - Lightweight system stats for your LCD display or monitor**](#dietpi-cloudshell-lightweight-system-stats-for-your-lcd-display-or-monitor)
- [**Raspcontrol - Web interface system stats**](#raspcontrol-web-interface-system-stats)
- [**Linux Dash - Web interface system stats**](#linux-dash-web-interface-system-stats)
- [**phpSysInfo - Web interface system stats**](#phpsysinfo-web-interface-system-stats)
- [**RPi-Monitor - Web interface system stats**](#rpi-monitor-web-interface-system-stats)
- [**Netdata - Web interface system stats**](#netdata-web-interface-system-stats)
- [**webmin - Remote system management with web interface**](#webmin-remote-system-management-with-web-interface)

??? info "How do I run **DietPi-Software** and install **Optimised software** ?"
To install any of the **DietPi Optimised Software** listed below run from the command line:
```
dietpi-launcher
```
and selected _DietPi-Software_. or launch directly the tool:
```
dietpi-software
```

Choose **Software optimised** and select one or more items. Finally click on `Install`. DietPi will do all the necessary steps to install and start these software items.

![DietPi software](../assets/images/dietpi-software.jpg)

To see all the DietPi configurations options, review [DietPi Tools](../../dietpi_tools) section.

[Return to the **Optimised Software list**](../../dietpi_optimised_software)

!!! warning "Documentation in progress..."
## DietPi-CloudShell - Lightweight system stats for your LCD display or monitor

CloudShell is a Network Attached Storage (NAS) solution with RAID support. It supports a color LCD and IR receiver.
CloudShell turns your Odroid CloudShell, Odroid 3.5 LCD Touchscreen Shield, Waveshare32, or monitor into a dedicated lightweight system stats display.

### Sample screenshots

The following screenshots shall give an overview over the displaying features of *CloudShell*.

=== "CPU usage"

![DietPi system stat and maintenance software CloudShell CPU usage dialog](../assets/images/dietpi-software-systemstat-cloudshare-cpuusage.jpg){: style="width:400px"}

=== "Memory usage"

![DietPi system stat and maintenance software CloudShell memory usage dialog](../assets/images/dietpi-software-systemstat-cloudshare-memoryusage.jpg){: style="width:400px"}

=== "Storage details"

![DietPi system stat and maintenance software CloudShell storage details dialog](../assets/images/dietpi-software-systemstat-cloudshare-storagedetails.png){: style="width:400px"}

=== "Network details"

![DietPi system stat and maintenance software CloudShell network details dialog](../assets/images/dietpi-software-systemstat-cloudshare-networkstats.jpg){: style="width:400px"}

=== "Pi-hole stats"

![DietPi system stat and maintenance software CloudShell Pi-hole dialog](../assets/images/dietpi-software-systemstat-cloudshare-piholestats.jpg){: style="width:400px"}

Video: <https://youtu.be/O-W8Z33as_U>.

### Configuration

=== "Configuration"

Launch the DietPi-CloudShell control panel:
`dietpi-cloudshell`

![DietPi system stat and maintenance software CloudShell configuration](../assets/images/dietpi-software-systemstat-cloudshare-configuration.png){: style="width:600px"}

=== "Scenes"

*CloudShell* offers scenes with predefined display outputs resp. layouts.
Scenes are configured in the *Scenes* dialog within `dietpi-cloudshell`.

![DietPi system stat and maintenance software CloudShell scenes configuration](../assets/images/dietpi-software-systemstat-cloudshare-scenes.png){: style="width:600px"}

=== "Power saving"

This feature will allow you to automatically power down the screen and disable DietPi-CloudShell processing during a specific time.
Please note this feature requires DietPi-CloudShell to be launched with `dietpi-autostart`, or run `dietpi-cloudshell` from the main screen (`tty1`).
If you make changes to DietPi-CloudShell over SSH, once saved, please reboot the system to ensure this feature becomes activated.

Power saving: `Auto screen off`

### Touchscreen support

=== "Waveshare32"

See <http://www.waveshare.com/3.2inch-rpi-lcd-b.htm>.
This is available for all Raspberry PI and Odroid versions. DietPi will automatically configure your system for the device.
Simply run `dietpi-config` -\> *Display Options* then select `waveshare32`.
After a reboot, your `waveshare32` will become active.

![DietPi system stat and maintenance software CloudShell Waveshare32 touchscreen](../assets/images/dietpi-software-systemstat-cloudshell-wavesharesupport.png){: style="width:400px"}

=== "Odroid 3.5 LCD shield"

See <https://www.hardkernel.com/shop/c1-3-2inch-tfttouchscreen-shield/>.
This is available for all Odroid versions. DietPi will automatically configure your system for the device.
Simply run `dietpi-config` -\> *Display Options* then select `odroid-lcd35`.
After a reboot, your *odroid-lcd35* will become active.

![DietPi system stat and maintenance software CloudShell general touchscreen](../assets/images/dietpi-software-systemstat-cloudshell-touchscreensupport.jpg){: style="width:400px"}

=== "Other touchscreens"

The display feature of *CloudShell* works generally with any LCD display or monitor with a resolution of at least 320x240.

See also

- <https://www.hardkernel.com/shop/cloudshell-for-xu4/>
- <https://www.hardkernel.com/shop/cloudshell-2-for-xu4/>
- <https://wiki.odroid.com/accessory/add-on_boards/xu4_cloudshell2/xu4_cloudshell2>

## Raspcontrol - Web interface system stats

Raspcontrol allows you to monitor your system stats from a web page. It also supports restarting and powering off your device.

![DietPi system stat and maintenance software Raspcontrol](../assets/images/dietpi-software-systemstat-raspcontrol.png){: style="width:500px"}

=== "Access to Raspcontrol"

The web interface of *Raspcontrol* can be accessed via:

- URL = `http://<your.IP>/raspcontrol`
- Username = `root`
- Password = `dietpi`

=== "Change login credentials"

The login credentials can be modified editing the file `/etc/raspcontrol/database.aptmnt`.

=== "Troubleshooting"

If no page is displayed: Raspcontrol will only work if OpenSSH-Server is installed.
Run `dietpi-software` and select OpenSSH-Server from the menu to change.

See also <https://wikipedia.org/wiki/Raspcontrol>.

## Linux Dash - Web interface system stats

Linux Dash allows you to monitor your system stats from a web page.

- Also Installs: [LASP webserver stack](../webserver_stack/)

![DietPi system stat and maintenance software Linux Dash](../assets/images/dietpi-software-systemstat-linuxdash.png){: style="width:500px"}

=== "Access to Linux Dash"

The web interface of *Linux Dash* can be accessed via:

- URL = `http://<your.IP>/linuxdash/app`

See also <https://github.com/afaqurk/linux-dash/wiki>.

## phpSysInfo - Web interface system stats

Allows you to monitor your system stats from a web page. The display output can be customized via an ini file.

- Also Installs: [LASP webserver stack](../webserver_stack/)

![DietPi system stat and maintenance software phpSysInfo](../assets/images/dietpi-software-systemstat-phpsysinfo.png){: style="width:500px"}

=== "Access to phpSysInfo"

The web interface of *phpSysInfo* can be accessed via:

- URL = `http://<your.IP>/phpsysinfo`

=== "Customization"

This is done via the file `phpsysinfo.ini` which is located in the phpSysInfo main directory (typical `/var/www/phpsysinfo`). An example file `phpsysinfo.ini.new` is present and gives inline information about all configuration options. Just walk through this file and discover all these bells an whistles.

See also <https://phpsysinfo.github.io/phpsysinfo/>.

## RPi-Monitor - Web interface system stats

RPi-Monitor is a slick, lightweight system stats monitor with web interface.

![DietPi system stat and maintenance software RPi-Monitor](../assets/images/dietpi-software-systemstat-rpimonitor.png){: style="width:500px"}

=== "Main features"

The main features of *RPi-Monitor* are:

- Collecting, storing and presenting metrics
- It's flexibly configurable
- It's user extendable
- Metrics sharing can be done via JSON file or via SNMP
- Alert option

=== "Access to RPi-Monitor"

The web interface of *RPi-Monitor* can be accessed via:

- URL = `http://<your.IP>:8888`

=== "Configuration"

The configuration is described there: <https://xavierberger.github.io/RPi-Monitor-docs/20_index.html>.

See also <https://github.com/XavierBerger/RPi-Monitor>.

## Netdata - Web interface system stats

Netdata is a slick and feature-rich system stats monitor, with web interface.

![DietPi system stat and maintenance software Netdata](../assets/images/dietpi-software-systemstat-netdata.png){: style="width:500px"}

=== "Access to Netdata"

The web interface of *Netdata* can be accessed via:

- URL = `http://<your.IP>:19999`

=== "Troubleshooting"

Depending on your system, by default Netdata might be not accessible from remote browsers. If this is the case, open the configuration file
`/etc/netdata/netdata.conf`
and change the line
`bind socket to IP = 127.0.0.1`
to match either the local network IP or static public IP of your server depending on your needs.
Alternatively comment it e.g. if your server does not have a static public IP but you require remote access.

=== "Security hardening"

Note that having Netdata accessible to anyone gives potential attackers a bunch of useful information where to start hacking.
About how to limit access to Netdata, check as well: <https://docs.netdata.cloud/web/server/>.

See also <https://wikipedia.org/wiki/Netdata> resp. <https://learn.netdata.cloud/docs/overview/what-is-netdata>.

## webmin - Remote system management with web interface

The webmin package is a web based feature-rich remote system management tool. Many system settings can easily be set using the web interface dialogs.

![DietPi system stat and maintenance software webmin](../assets/images/dietpi-software-systemstat-webmin.png){: style="width:500px"}

=== "Access to webmin"

The web interface of *webmin* can be accessed via:

- URL = `https://<your.IP>:10000`
- Username = `root`
- Password = root password at time of installation (default: `dietpi`)

???+ hint "Use https"

Please ensure https URL is typed, http will not function

=== "System logging"

The Webmin system logging panel still depends on a classical file logger, like Rsyslog. However DietPi will not impose this logging overhead on systems by default. If you need to see system logs via the *webmin online panel*, you can either configure a custom *syslog* daemon or install *Rsyslog* manually:
`apt install rsyslog`

The links redirect to the old documentation available on [DietPi.com Forum](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5). **We need your help to create and update this documentation ! Thank you** :octicons-heart-16: :octicons-heart-16:
DietPi comes with *systemd* and the related *journald* system logger, which can be accessed via the command `journalctl`.

See also <https://wikipedia.org/wiki/Webmin> resp. <https://www.webmin.com/>.