Written in plain HTML5, CSS3, JavaScript and PHP (backend). No extra software required!
Report a bug | Request a new feature | Help develop this project
- Live surveillance of RPi hardware (CPU temperature, frequency, load etc.) with customizable warning thresholds
- Detailed software/hardware information (web server, PHP, storage / partition workload, core voltage, plugged USB devices, kernel version, model specifications, OS, CPU, network config)
- Protected access with password login (configure password)
- Shutdown / Reboot your Raspberry Pi with scheduling options (setup instructions)
- Responsive mobile web app
- Dark Theme (manual / auto)
| Mobile Light Theme | Mobile Dark Theme |
|---|---|
 |
 |
wget -O install.sh https://github.com/femto-code/Raspberry-Pi-Dashboard/raw/release/installer.sh
bash install.sh- Running web server (e.g. Lighttpd or Apache) with PHP installed
- Installed Git (comes preinstalled on Raspberry Pi OS / formerly Raspbian as well as other Linux distros)
- Valid permissions set within
/var/www/html
The following configuration is the commonly recommended set-up for your web server folder and is meant to be secure to a certain level (with the minimum need of permissions):
-
Make sure
www-datagroup exists and add your current user to that system group:
(if you are using another distro than Raspberry Pi OS the username of web server can differ)
sudo groupadd www-data
sudo usermod -a -G www-data www-data
sudo usermod -a -G www-data <yourlogin>(replace<yourlogin>with your username) -
Give the ownership of web folder to the
www-datagroup and your user.
The following commands ensure that you have full access on the files within the web folder while group members (www-data) cannot edit/write for security reasons:
sudo chown -R <yourlogin>:www-data /var/www/html(replace<yourlogin>with your username)
sudo chmod -R 755 /var/www/html -
Reboot your RPi or log out and back in (for permission changes to take effect)
- clone the project into your web folder:
git clone https://github.com/femto-code/Rasberry-Pi-Dashboard.git /var/www/html/<your_subfolder_name>
(replace<your_subfolder_name>with a name of your choice accordingly, you can also rename this base folder at any time afterwards) - Alternatively download this repo as a ZIP file and extract it
- Run in a terminal to set valid permissions:
sudo chown -R <yourlogin>:www-data /var/www/html/<your_subfolder_name>
(replace<yourlogin>with your username)sudo chmod -R 775 /var/www/html/<your_subfolder_name>- this will allow the
www-datauser exclusively to write/edit (775) files only in your dashboard folder!
An erroneous permission typically results in the situation where the user responsible for web server (e.g.
www-data) does not have rights to create/modify the local config file for saving your dashboard adjustments (your custom thresholds, password etc.). In this case, the dashboard won't work at all and will throw this error.
- DONE! Open web browser with URL:
http://<IP_OF_YOUR_RPI>/<your_subfolder_name>
- If you want to see advanced hardware information (core voltage, advanced model information) on your dashboard instance:
- run in a terminal:
sudo usermod -aG video www-data
- run in a terminal:
If you do not use Raspberry Pi OS, but e.g. Ubuntu, you do have to install
libraspberrypi-binby runningsudo apt install libraspberrypi-bin.
The vcgencmd command (specifically dedicated to RPi firmware) is a system command that requires certain hardware rights. Therefore one has to grant this particular right (to read hardware info) to e.g. www-data (under which web server is running). This is achieved by adding this user to a designated system group called video, which the standard user pi is part of by default.
- only comes preinstalled on Raspberry Pi OS
- in case of problems: please comment on #12 (or new issue)
Recommended only, if your RPi is not accessible from outside your local (LAN) network!
In order to use the remote shutdown functionality you have to give the user www-data advanced rights for running one specific command:
- Run
sudo visudoto open the editor for adjusting user rights - Be careful what you change here!
Just add the following at the end of the file:www-data ALL=NOPASSWD: /sbin/shutdown - Reboot your RPi to enable shutdown from another device (connected to same local network as your RPi).
- Please be aware that there is a more user-friendly way now by using the dashboards options modal. However, the following manual way of changing the password might be helpful
- in case of wrong permissions (user
www-datacannot change settings for you - see issue #22 or read here for help and instructions to solve) - forgotten password (and access to dashboard therefore impossible)
- in case of wrong permissions (user
- Go to https://www.md5-generator.de/ and generate MD5 encrypted passphrase.
- Open
local.configor create it and apply your custom passphrase string (generated in step 1) as follows (don't alter other lines):
[...]
'general' =>
array (
[...]
'pass' => 'YOUR_MD5_PASSPHRASE_HERE',
[...]
),
[...]
If your RaspberryPi is on a private part of the network and you don't want to use a password, you can disable it.
To do this, in the local.config file, set the loginWithPassword parameter to 0.
If there is no loginWithPassword parameter in your local.config file, simply add it after the pass option.
Example:
[...]
'general' =>
array (
[...]
'pass' => 'YOUR_MD5_PASSPHRASE_HERE',
'loginWithPassword' => '0',
[...]
),
[...]
- Remember password and enjoy!
As always: Make sure to change the default password (which is root) and choose a more secure one at first setup and consider more security if your dashboard is accessible on the network.
Raspberry Pi and the Raspberry Pi Logo are registred trademarks of the Raspberry Pi Foundation