System Stats & Management¶

DietPi-Dashboard is accessible by default at TCP port 5252:

• URL: http://<your.IP>:5252
• Password: <your software password> (default: dietpi)

The DietPi-Dashboard executable and its configuration file can be found at:

/opt/dietpi-dashboard

The configuration file is located at:

/opt/dietpi-dashboard/config.toml

When doing changes, you need to restart the service afterwards:

systemctl restart dietpi-dashboard

Password protection is enabled by default from DietPi v7.9 on. If you installed it before, you’ll need to enable it via configuration file. For this, create a SHA512 hash of the PASSWORD you want to use for logging into the web interface, and a random 64-character secret which is used to generate a token to transfer and store securely in your browser. Apply those to the configuration file and restart the service for the changes to take effect:

hash=$(echo -n 'PASSWORD' | sha512sum | mawk '{print $1}')
secret=$(openssl rand -hex 32)
G_CONFIG_INJECT 'pass[[:blank:]]' 'pass = true' /opt/dietpi-dashboard/config.toml
GCI_PASSWORD=1 G_CONFIG_INJECT 'hash[[:blank:]]' "hash = \"$hash\"" /opt/dietpi-dashboard/config.toml
GCI_PASSWORD=1 G_CONFIG_INJECT 'secret[[:blank:]]' "secret = \"$secret\"" /opt/dietpi-dashboard/config.toml
unset -v hash secret
systemctl restart dietpi-dashboard

To change the password, just replace the hash in the config file and restart the service.

If you want to force a logout of all browsers without changing the password, you can instead change the secret. Generate an apply a new secret to the configuration file and restart the service. Every client and browser will then need to login again to continue using the DietPi-Dashboard, as the stored token that is based on password and secret has been invalidated.

From DietPi v8.0 on, you can install DietPi-Dashboard as backend only node, with does not include an own web interface. Such backend only nodes can then be accessed from another full DietPi-Dashboard frontend/web interface. Additional nodes would need to be added manually into configuration file located at:

/opt/dietpi-dashboard/config.toml

When doing changes, you need to restart the service afterwards:

systemctl restart dietpi-dashboard

DietPi-Dashboard by default is started as systemd service and can hence be controlled with the following commands:

systemctl status dietpi-dashboard

systemctl stop dietpi-dashboard

systemctl start dietpi-dashboard

systemctl restart dietpi-dashboard

Service logs can be reviewed with the following command:

journalctl -u dietpi-dashboard

You can easily update DietPi-Dashboard by reinstalling it and restarting the service for the change to take effect:

dietpi-software reinstall 200
systemctl restart dietpi-dashboard

Launch the DietPi-CloudShell control panel:

dietpi-cloudshell

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

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

See https://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, select Display Options, then select waveshare32.
After a reboot, your Waveshare32 will become active.

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, select Display Options, then select odroid-lcd35.
After a reboot, your Odroid 3.5 LCD will become active.

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

The web interface of Linux Dash can be accessed via:

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

The web interface of phpSysInfo can be accessed via:

• URL = http://<your.IP>/phpsysinfo

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.

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

The web interface is accessible via port 8888:

• URL = http://<your.IP>:8888

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

The web interface is accessible via port 19999:

• URL = http://<your.IP>:19999

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 DietPi 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. But note that an unprotected publicly accessible Netdata web interface is a potential security risk. Head over to the “Security hardening” tab to learn more about how to restrict access to Netdata.

Once saved, you will need to restart the service to implement the changes by entering the below into the terminal:

systemctl restart netdata

Note that having Netdata accessible to anyone gives potential attackers a bunch of useful information where to start hacking.
To learn about how to limit access to Netdata, please refer to their documentation regarding the configuration of access lists.

The web interface is accessible via port 10000:

• URL = https://<your.IP>:10000
• Username = root
• Password = <your software password> (default: dietpi)

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

DietPi comes with systemd and the related journald system logger, which can be accessed via the command journalctl.

The Docker configuration files are located at:

• Docker: /etc/docker/daemon.json
• containerd: /etc/containerd/config.toml

Since Docker is installed via APT packages, it can be updated by running the following commands:

apt update
apt install docker-ce containerd.io docker-ce-cli

Docker logs can be accessed using next command:

journalctl -u docker -u containerd

Docker offers plugins on its website (e.g. Docker Plugins amd64 stable), some of them are not installed by the Docker installation by default resp. are no install option from dietpi-software (like the Docker Compose plugin is one).
These additional plugins can be installed by the user as described below.

Docker Buildx CLI plugin:

apt install docker-buildx-plugin

Docker vulnerability scan CLI plugin:

apt install docker-scan-plugin

For running container rootless:

apt install docker-ce-rootless-extras

Docker downloads image file chunks to /mnt/dietpi_userdata/docker-data/tmp when generating a Docker image. After this, the file chunks are deleted as they are only temporary files.
In case of a slower disk (e.g. SD Card) this takes a longer time due to the SD Card reading/writing speed. To speedup the image generation, a tmpfs file system can be used.
A drawback of using a tmpfs is the required RAM, i.e. enough RAM memory (e.g. > 2 GB) should be present for the tmpfs.

The tmpfs file system can be added manually via the file /etc/fstab by entering a line (e.g. in the TMPFS area) like:

tmpfs /mnt/dietpi_userdata/docker-data/tmp tmpfs size=2G,noatime,lazytime,nodev,nosuid

The size= option should be adjusted to the systems RAM size: Only a part of the total RAM size should be used to avoid low memory issues.
After changing the file /etc/fstab the tmpfs needs to be activated. This can be done via a file system remount via

mount -o remount /mnt/dietpi_userdata/docker-data/tmp

or a system reboot.

To update Docker Compose to the latest version, simply reinstall it:

dietpi-software reinstall 134

The web interface is accessible via port 9002¹:

• URL = http://<your.IP>:9002

To update Portainer, simply reinstall it:

dietpi-software reinstall 185

The default installation of K3s creates a single-node cluster. If you want to have a multi-node setup, you need to configure the nodes to speak to the others.

In /boot/dietpi.txt, edit the SOFTWARE_K3S_EXEC parameter to set command (server or agent). You can add other command-line parameters after the command.

Example:

SOFTWARE_K3S_EXEC=server --disable=local-storage

If you need to add many command-line parameters, it is recommended to put them in a file instead, keeping only the command (server or agent) in /boot/dietpi.txt. During installation, if /boot/dietpi-k3s.yaml exists, it is copied to /etc/rancher/k3s/config.yaml, and used by K3s. The format of this file is documented in the K3s docs.

When running in server mode, K3s generates a kubeconfig file at /etc/rancher/k3s/k3s.yaml. Copy this to your client machine, and edit the server setting to point to the hostname of the server.

Place the file in the default location (~/.kube/config), or point to it using the KUBECONFIG environment-variable.

You should now be able to interact with your Kubernetes cluster using kubectl:

kubectl get nodes
kubectl get pods -A

• Service: journalctl -u k3s

To create a cluster out of two or more already-running MicroK8s instances, use the microk8s add-node command:

microk8s add-node

From the node you wish to join to this cluster, run the following:

microk8s join 192.168.1.230:25000/92b2db237428470dc4fcfc4ebbd9dc81/2c0cb3284b05

Use the --worker flag to join a node as a worker not running the control plane, e.g.:

microk8s join 192.168.1.230:25000/92b2db237428470dc4fcfc4ebbd9dc81/2c0cb3284b05 --worker

For most commands, you can use microk8s in front like below.

microk8s kubectl get nodes
microk8s kubectl get namespaces

MicroK8s does provide a few “addons”, which can be seen below with the enable and disable command.

microk8s status # to view the addons
microk8s enable dns # to enable addons
microk8s enable dashboard # to enable Kubernetes dashboard

Per-node log files can be in:

/var/log/pods

The metrics endpoint of Prometheus Node Exporter is exposed at TCP port 9100 and can be accessed via:

• URL = http://<your.IP>:9100/metrics

Your Prometheus server needs to be configured in order to scrape Node Exporter metrics. Full configuration of the Prometheus server is outside the scope of this documentation, but here is a sample prometheus.yml file for reference:

global:
  scrape_interval: 15s

scrape_configs:
- job_name: your.hostname
  static_configs:
  - targets: ['your.IP:9100']

There are many pre-made templates of Grafana dashboards for visualizing data collected from a Prometheus Node Exporter. A good starting point is Node Exporter Full. You can import it directly into your Grafana instance by using ID 1860.

Since Prometheus Node Exporter runs as a systemd service, it can be controlled with the following commands:

systemctl status node_exporter

systemctl start node_exporter

systemctl stop node_exporter

systemctl restart node_exporter

Prometheus Node Exporter runs as a systemd service, hence logs can be viewed with the following command:

journalctl -u node_exporter

Prometheus Node Exporter can be updated by simply reinstalling it:

dietpi-software reinstall 99

The Homer dashboard can be accessed via:

• URL: http://<your.IP>/homer

You may bookmark this and save it as your browser’s home page, or alternatively look into tools like Nginx Proxy Manager and a DNS server such as AdGuard Home to give it a nice internal domain name such as homer.box.

To configure entries and icons for Homer, you can edit it’s config file /var/www/homer/assets/config.yml. Example contents:

services:
  - name: "Selfhosted"
    icon: "fas fa-cloud"
    items:
      - name: "Adguard Home"
        logo: "assets/icons2/adguard.png"
        subtitle: "A blackhole for the internet"
        tag: "Selfhosted"
        url: "https://adguard.box"
        target: "_blank"
      - name: "Nginx"
        logo: "assets/icons2/nginx.png"
        subtitle: "Reverse proxy - load balancer"
        tag: "Selfhosted"
        url: "https://nginx.box"
        target: "_blank"
      - name: "Shiori"
        logo: "assets/icons2/shiori.png"
        subtitle: "Web archiving + Read later"
        tag: "Selfhosted"
        url: "https://shiori.box"
        target: "_blank"
      - name: "Nextcloud"
        logo: "assets/icons2/nextcloud.png"
        subtitle: "A google suite alternative"
        tag: "Selfhosted"
        url: "https://nextcloud.box"
        target: "_blank"

In the example above, a column titled Selfhosted is being made which contains 4 entries. In the same directory as the config.yml, an icons2 folder exists, which contains icon images.

To update Homer simply re-run the installer by executing

dietpi-software reinstall 205

Remark: The dietpi-software script update procedure preserves the file config.yml automatically, there is no necessity for the user to do a restore manually.

If other files in /var/www/homer were previously changed by the user, they need to be copied in place (from the backup location /mnt/dietpi_userdata/homer_backup). As an example for a changed file manifest.json this could be done via:

cd /mnt/dietpi_userdata/homer_backup
mv manifest.json /var/www/homer/assets

To apply the Dracula theme to Homer execute these steps:

1. Get theme:

   curl -fL 'https://raw.githubusercontent.com/dracula/homer/master/custom.css' -o /var/www/homer/assets/custom.css
   curl -fL 'https://raw.githubusercontent.com/dracula/homer/master/dracula-background.png' -o /var/www/homer/assets/dracula-background.png
   

2. Edit your config.yml with:

   nano /var/www/homer/assets/config.yml
   

3. Add the following lines:

   # Will load Dracula theme
   stylesheet:
   - "assets/custom.css"
   

Source code: dracula/homer

To apply the macOS styled theme to Homer execute these steps:

1. Get theme:

   cd /tmp
   curl -fLO 'https://github.com/walkxcode/homer-theme/archive/main.tar.gz'
   tar xf main.tar.gz
   rm main.tar.gz
   cp homer-theme-main/assets/custom.css /var/www/homer/assets/custom.css
   cp homer-theme-main/assets/wallpaper.jpeg /var/www/homer/assets/wallpaper.jpeg
   cp homer-theme-main/assets/wallpaper-light.jpeg /var/www/homer/assets/wallpaper-light.jpeg
   cp -R homer-theme-main/assets/fonts /var/www/homer/assets/
   rm -R homer-theme-main
   

2. Edit your config.yml with:

   nano /var/www/homer/assets/config.yml
   

3. Add the following lines (make sure to remove content for colors, theme, and columns if they previously existed):

   stylesheet:
   - "assets/custom.css"
   
   columns: "3" # You can change this to any number that is a factor of 12: (1, 2, 3, 4, 6, 12)
   theme: default
   colors:
     light:
       highlight-primary: "#fff5f2"
       highlight-secondary: "#fff5f2"
       highlight-hover: "#bebebe"
       background: "#12152B"
       card-background: "rgba(255, 245, 242, 0.8)"
       text: "#ffffff"
       text-header: "#fafafa"
       text-title: "#000000"
       text-subtitle: "#111111"
       card-shadow: rgba(0, 0, 0, 0.5)
       link: "#3273dc"
       link-hover: "#2e4053"
       background-image: "../assets/wallpaper-light.jpeg" # Change wallpaper.jpeg to the name of your own custom wallpaper!
     dark:
       highlight-primary: "#181C3A"
       highlight-secondary: "#181C3A"
       highlight-hover: "#1F2347"
       background: "#12152B"
       card-background: "rgba(24, 28, 58, 0.8)"
       text: "#eaeaea"
       text-header: "#7C71DD"
       text-title: "#fafafa"
       text-subtitle: "#8B8D9C"
       card-shadow: rgba(0, 0, 0, 0.5)
       link: "#c1c1c1"
       link-hover: "#fafafa"
       background-image: "../assets/wallpaper.jpeg"
   

Source code: walkxcode/homer-theme

To apply the Catppuccin theme to Homer execute these steps:

1. Get theme:

   apt install git
   git clone https://github.com/mrpbennett/catppucin-homer
   

2. Choose one of the css files, they all have varying colour schemes, and copy it to Homer, for example the catppuccin-macchiato style sheet:

   cp catppuccin-homer/flavours/catppuccin-macchiato.css /var/www/homer/assets
   

3. Edit the config.yml file with:

   nano /var/www/homer/assets/config.yml
   

4. Add the following lines (change macchiato to the wanted theme):

   # Will load catppuccin theme.
   stylesheet:
   - "assets/catppuccin-macchiato.css"
   

Source code: mrpbennett/catppucin-homer