{"id":13579126,"url":"https://github.com/femto-code/Raspberry-Pi-Dashboard","last_synced_at":"2025-04-05T20:33:10.992Z","repository":{"id":40271105,"uuid":"272681327","full_name":"femto-code/Raspberry-Pi-Dashboard","owner":"femto-code","description":"Web-App Dashboard to monitor Raspberry Pi hardware and software status. Nothing more than Webserver + PHP required.","archived":false,"fork":false,"pushed_at":"2024-06-26T12:52:43.000Z","size":2759,"stargazers_count":296,"open_issues_count":11,"forks_count":26,"subscribers_count":9,"default_branch":"release","last_synced_at":"2025-03-30T17:09:59.970Z","etag":null,"topics":["dashboard","monitoring","php","raspberry","raspberry-pi","raspberry-pi-dashboard","raspberrypi","reboot","rpi","rpi-dashboard","rpi-hardware","shutdown","web-app","web-application","web-interface"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/femto-code.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-06-16T10:44:24.000Z","updated_at":"2025-03-24T15:42:18.000Z","dependencies_parsed_at":"2024-06-26T15:49:44.098Z","dependency_job_id":"d8fd4baf-5cba-4d0d-abcf-25c1dcc750a5","html_url":"https://github.com/femto-code/Raspberry-Pi-Dashboard","commit_stats":null,"previous_names":[],"tags_count":23,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/femto-code%2FRaspberry-Pi-Dashboard","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/femto-code%2FRaspberry-Pi-Dashboard/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/femto-code%2FRaspberry-Pi-Dashboard/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/femto-code%2FRaspberry-Pi-Dashboard/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/femto-code","download_url":"https://codeload.github.com/femto-code/Raspberry-Pi-Dashboard/tar.gz/refs/heads/release","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247399854,"owners_count":20932875,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["dashboard","monitoring","php","raspberry","raspberry-pi","raspberry-pi-dashboard","raspberrypi","reboot","rpi","rpi-dashboard","rpi-hardware","shutdown","web-app","web-application","web-interface"],"created_at":"2024-08-01T15:01:36.762Z","updated_at":"2025-04-05T20:33:06.685Z","avatar_url":"https://github.com/femto-code.png","language":"PHP","readme":"![Intro](img/logo.png?raw=true \"Raspberry Pi Dashboard - Project Logo\")\n\u003cdiv align=\"center\"\u003eView and manage your Pi system through your web browser!\u003c/div\u003e\n\u003cp align=\"center\"\u003e\u003csub\u003eWritten in plain HTML5, CSS3, JavaScript and PHP (backend). \u003cb\u003eNo extra software required!\u003c/b\u003e\u003c/sub\u003e\u003c/p\u003e\n\u003cbr\u003e\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://github.com/femto-code/Raspberry-Pi-Dashboard/stargazers\"\u003e\u003cimg src=\"https://img.shields.io/github/stars/femto-code/Raspberry-Pi-Dashboard?color=yellow\" alt=\"Stars Badge\"/\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/femto-code/Raspberry-Pi-Dashboard/network/members\"\u003e\u003cimg src=\"https://img.shields.io/github/forks/femto-code/Raspberry-Pi-Dashboard?color=orange\" alt=\"Forks Badge\"/\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/femto-code/Raspberry-Pi-Dashboard/pulls\"\u003e\u003cimg src=\"https://img.shields.io/github/issues-pr/femto-code/Raspberry-Pi-Dashboard\" alt=\"Pull Requests Badge\"/\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/femto-code/Raspberry-Pi-Dashboard/issues\"\u003e\u003cimg src=\"https://img.shields.io/github/issues/femto-code/Raspberry-Pi-Dashboard\" alt=\"Issues Badge\"/\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/femto-code/Raspberry-Pi-Dashboard/graphs/contributors\"\u003e\u003cimg alt=\"GitHub contributors\" src=\"https://img.shields.io/github/contributors/femto-code/Raspberry-Pi-Dashboard?color=2b9348\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/femto-code/Raspberry-Pi-Dashboard/blob/master/LICENSE\"\u003e\u003cimg src=\"https://img.shields.io/github/license/femto-code/Raspberry-Pi-Dashboard?color=2b9348\" alt=\"License Badge\"/\u003e\u003c/a\u003e\n\u003cbr\u003e\n\u003ca href=\"https://github.com/femto-code/Raspberry-Pi-Dashboard/\"\u003e\u003cimg src=\"https://img.shields.io/github/repo-size/femto-code/Raspberry-Pi-Dashboard?color=important\" alt=\"License Badge\"/\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/femto-code/Raspberry-Pi-Dashboard/\"\u003e\u003cimg src=\"https://img.shields.io/tokei/lines/github/femto-code/Raspberry-Pi-Dashboard?color=yellowgreen\" alt=\"License Badge\"/\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/femto-code/Raspberry-Pi-Dashboard/releases\"\u003e\u003cimg src=\"https://img.shields.io/github/v/release/femto-code/Raspberry-Pi-Dashboard?color=success\" alt=\"License Badge\"/\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/femto-code/Raspberry-Pi-Dashboard/commits\"\u003e\u003cimg src=\"https://img.shields.io/github/last-commit/femto-code/Raspberry-Pi-Dashboard\" alt=\"License Badge\"/\u003e\u003c/a\u003e\n\u003c/div\u003e\n\u003cbr\u003e\n\u003cp align=\"center\"\u003e\u003ca href=\"https://github.com/femto-code/Raspberry-Pi-Dashboard/issues\"\u003eReport a bug\u003c/a\u003e | \u003ca href=\"https://github.com/femto-code/Raspberry-Pi-Dashboard/discussions\"\u003eRequest a new feature\u003c/a\u003e | \u003ca href=\"https://github.com/femto-code/Raspberry-Pi-Dashboard/pulls\"\u003eHelp develop this project\u003c/a\u003e\u003c/p\u003e\n\n## Features\n\n- Live surveillance of RPi hardware (CPU temperature, frequency, load etc.) with customizable warning thresholds\n- Detailed software/hardware information (web server, PHP, storage / partition workload, core voltage, plugged USB devices, kernel version, model specifications, OS, CPU, network config)\n- Protected access with password login ([configure password](https://github.com/femto-code/Raspberry-Pi-Dashboard#configure-password-manually))\n- Shutdown / Reboot your Raspberry Pi with scheduling options ([setup instructions](https://github.com/femto-code/Raspberry-Pi-Dashboard#enable-shutdown--reboot-optional))\n- Responsive mobile web app\n- Dark Theme (manual / auto)\n\n### 🆕 Use the installer script to set up the dashboard!\n\n## Screenshots\n\n![Preview](img/preview.png?raw=true \"Preview of dashboard in a web browser\")\n\n| Mobile Light Theme                                | Mobile Dark Theme                               |\n|:-------------------------------------------------:|:-----------------------------------------------:|\n| ![](img/m2.png?raw=true)                          |                ![](img/m1.png?raw=true)         |\n\n## Use installer script (alpha)\n\n```bash\nwget -O install.sh https://github.com/femto-code/Raspberry-Pi-Dashboard/raw/release/installer.sh\nbash install.sh\n```\n\n## Manual download and installation\n\n### Prerequisites\n\n- Running web server (e.g. *Lighttpd* or *Apache*) with *PHP* installed\n- Installed *Git* (comes preinstalled on Raspberry Pi OS / formerly Raspbian as well as other Linux distros)\n- Valid permissions set within `/var/www/html`\n\n#### Valid permissions\n\nThe 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):\n\n1. Make sure `www-data` group exists and add your current user to that system group:\u003cbr\u003e\n_(if you are using another distro than Raspberry Pi OS the username of web server can differ)_\u003cbr\u003e\n`sudo groupadd www-data`\u003cbr\u003e\n`sudo usermod -a -G www-data www-data`\u003cbr\u003e\n`sudo usermod -a -G www-data \u003cyourlogin\u003e` (replace `\u003cyourlogin\u003e` with your username)\n\n1. Give the ownership of web folder to the `www-data` group and *your* user.\u003cbr\u003eThe 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:\u003cbr\u003e\n`sudo chown -R \u003cyourlogin\u003e:www-data /var/www/html` (replace `\u003cyourlogin\u003e` with your username)\u003cbr\u003e\n`sudo chmod -R 755 /var/www/html`\n\n3. Reboot your RPi or log out and back in (for permission changes to take effect)\n\n### Setup project\n\n- clone the project into your web folder:\u003cbr\u003e`git clone https://github.com/femto-code/Rasberry-Pi-Dashboard.git /var/www/html/\u003cyour_subfolder_name\u003e`\u003cbr\u003e(replace `\u003cyour_subfolder_name\u003e` with a name of your choice accordingly, you can also rename this base folder at any time afterwards)\n- ***Alternatively*** download this repo as a ZIP file and extract it\n- Run in a terminal to set valid permissions:\n  - `sudo chown -R \u003cyourlogin\u003e:www-data /var/www/html/\u003cyour_subfolder_name\u003e`\u003cbr\u003e(replace `\u003cyourlogin\u003e` with your username)\n  - `sudo chmod -R 775 /var/www/html/\u003cyour_subfolder_name\u003e`\n  - this will allow the `www-data` user exclusively to write/edit (7**7**5) files **only in your dashboard folder**!\n\u003e 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.\n- **DONE!** Open web browser with URL: `http://\u003cIP_OF_YOUR_RPI\u003e/\u003cyour_subfolder_name\u003e`\n\n## Additional configuration / Help\n\n#### Display core voltage (or other hardware info) output (optional)\n- If you want to see advanced hardware information (core voltage, advanced model information) on your dashboard instance:\n  - run in a terminal: `sudo usermod -aG video www-data` \n\u003eIf you do not use Raspberry Pi OS, but e.g. Ubuntu, you do have to install `libraspberrypi-bin` by running `sudo apt install libraspberrypi-bin`.\n\n##### Background\nThe `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.\n- only comes preinstalled on *Raspberry Pi OS*\n- in case of problems: please comment on [#12](https://github.com/femto-code/Raspberry-Pi-Dashboard/issues/12) (or [new issue](https://github.com/femto-code/Raspberry-Pi-Dashboard/issues/new))\n\n#### Enable shutdown / reboot (optional)\n\n\u003e Recommended only, if your RPi is **not** accessible from outside your local (LAN) network!\n\nIn order to use the remote shutdown functionality you have to give the user `www-data` advanced rights for running one specific command:\n1. Run `sudo visudo` to open the editor for adjusting user rights\n2. **Be careful what you change here!**\u003cbr\u003eJust add the following at the **end** of the file: \u003cbr\u003e`www-data ALL=NOPASSWD: /sbin/shutdown`\n3. **Reboot** your RPi to enable shutdown from another device (connected to same local network as your RPi).\n\n#### Configure password (manually)\n\n- 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\n  - in case of wrong permissions (user `www-data` cannot change settings for you - [see issue #22](https://github.com/femto-code/Raspberry-Pi-Dashboard/issues/22) or [read here](https://github.com/femto-code/Raspberry-Pi-Dashboard#valid-permissions) for help and instructions to solve)\n  - forgotten password (and access to dashboard therefore impossible)\n\n1. Go to [https://www.md5-generator.de/](https://www.md5-generator.de/) and generate *MD5 encrypted passphrase*.\n2. Open `local.config` or create it and apply your custom passphrase string (generated in **step 1**) as follows (don't alter other lines):\n```\n[...]\n'general' =\u003e\n  array (\n    [...]\n    'pass' =\u003e 'YOUR_MD5_PASSPHRASE_HERE',\n    [...]\n  ),\n  [...]\n```\n\n\u003e **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.\n\n## License\n\n[**GPL-3.0**](LICENSE).\n\n---\n\n`Raspberry Pi and the Raspberry Pi Logo are registred trademarks of the Raspberry Pi Foundation`\n","funding_links":[],"categories":["PHP","monitoring","Projects"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffemto-code%2FRaspberry-Pi-Dashboard","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffemto-code%2FRaspberry-Pi-Dashboard","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffemto-code%2FRaspberry-Pi-Dashboard/lists"}