Skip to content

purpledalek/SimplePiStats

Repository files navigation

SimplePiStats

A simple UI designed for people running their Raspberry Pi as a server, and who quick and easy to read stats and control of their system.

Please ensure you are using Raspbian Bullseye for the internet speed test to work and that git is installed before running the install command

How to install/update

Simply change directory (cd) into the directory where you want to store SimplePiStats, then run the following command:

bash <(curl -s https://raw.githubusercontent.com/purpledalek/SimplePiStats/main/install.sh)

If you with to use SimplePiStats without a virtual environment (venv), use the following command instead:

bash <(curl -s https://raw.githubusercontent.com/purpledalek/SimplePiStats/main/non-venv_install.sh)

How to use

Type the following into a web browser <your pi's local ip address>:5555. If you need help finding your Pi's local IP address, simply ssh into the Pi, and type in hostname -I, your Pi's local IP address is everything before the space. If you wish to change which port SimplePiStats runs on, you can change the port value in the config in settings.

How to read the CPU state

:] Means your Pi's CPU is happy! (Under 40%)

:| Means your Pi's CPU is under a bit of load, but it's still okay (Between 40% and 75%)

>:[ Means your Pi is Angry. (Over 75%)

How to read the temperature

🔥 Means your Pi's temperature is around normal. (Below 50°C)

🔥🔥 Means your Pi's temperature is a little bit warm. (Between 50 and 70°C)

🔥🔥🔥 Means your Pi's H O T! (above 70°C, and you should probably do something rather quickly.)

(Numbers can be accessed for these statistics in Settings if you want a more accurate readout)

Editing config file

You can either edit the config file by clicking the Edit config button in settings, or in the command line with your text editor of choice. The correct syntax for each section is outlined below. N.B. Editing the config.ini file in the command line will require a restart of the SimplePiStats service for the changes to take effect

Commands

commands = ["<name that you want on command button> : <command that you run in the console>"] (please note that file paths given in commands MUST be absolute)

Drives

drives = ["<absolute path to drive location> --exclude=<Any directories you want to exclude> --exclude=<You can do this as many directories as you want for a drive by adding another --exclude flag followed by the new path to exclude>"]

Services

services = ["<name of the service you want to show>/<reference to the port number you want to link to, if any>*"]

For any of these sections, you denote a new command/drive/service by adding it as a new list item.

*You can add "--no_stop" or "--no_restart" after a service name (or port if applicable) if you wish to not see the specified button. Adding "--no_stop --no_restart" will hide both buttons

How to change the data background color

You can either change the background color of the data boxes using the color picker in settings, or by editing the hex value in the config.ini file

Please note: images may be unstable on iPhone, refreshing is the only known fix for this issue

Adding custom CSS

You can add a custom CSS file by putting it in the static folder, then adding the filename to the config. For example if you have a CSS file called myCustomStyle.css, you can put that in the static folder and then add "myCustomStyle.css" to the custom_css line of the config. Any changes made to elements in your custom css file will overwrite the default style for that element.

Possible features

  • The ability to display Docker container information
  • More icons for popular services

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published