https://github.com/morgankryze/pi-health
Lightweight health monitoring websocket server for Raspberry Pi (CPU % and °C, RAM %).
https://github.com/morgankryze/pi-health
cpu-monitoring homelab rpi
Last synced: 4 months ago
JSON representation
Lightweight health monitoring websocket server for Raspberry Pi (CPU % and °C, RAM %).
- Host: GitHub
- URL: https://github.com/morgankryze/pi-health
- Owner: MorganKryze
- License: mit
- Created: 2024-08-08T23:33:46.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-08T21:01:32.000Z (9 months ago)
- Last Synced: 2025-04-08T23:41:57.973Z (6 months ago)
- Topics: cpu-monitoring, homelab, rpi
- Language: Python
- Homepage:
- Size: 160 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT
Awesome Lists containing this project
README
# Pi-Health
> Lightweight health monitoring websocket server for Raspberry Pi (CPU % and °C, RAM %).
## Getting Started
### Introduction
This project is a lightweight health monitoring websocket server for Raspberry Pi. It provides the CPU usage in percentage and temperature in Celsius degrees, as well as the RAM usage in percentage through websocket channels.
### Prerequisites
- Raspberry Pi (tested on zero/3/4/5)
- Network connectivity
- `git` installed
- `docker` & `docker compose` installed
### Install
First, we clone the project locally using `git`:
```bash
git clone --depth=1 https://github.com/MorganKryze/Pi-Health.git
```
> [!NOTE]
> The `--depth=1` option is used to clone only the last commit of the repository, which is useful to save time and space.
Move to the project directory:
```bash
cd Pi-Health
```
Open the `.env` file using an editor (`nano`, `vim`, ...) and set the `PORT` variable to the desired exposed port (default is `9876`).
Then, we can pull the docker image the project using `docker compose`:
```bash
docker compose pull
```
When the image is pulled, we can build the project using `docker compose`:
```bash
docker compose up -d
```
> [!TIP]
> The `-d` option is used to run the container in the background (detached mode).
### Usage
Once the container is running, you can connect using a websocket client to the server with the following URL:
```bash
ws://:/general/debug
```
> [!NOTE]
> You may want to access these information from a remote machine, so you will need to use an NGINX reverse proxy or a Cloudflare tunnel (for example) to expose the service to the internet.
The available channels are:
- `general/debug`: simple incrementing debug channel
- `sensor/cpu_usage`: CPU usage in percentage
- `sensor/cpu_temp`: CPU temperature in Celsius degrees
- `sensor/ram_usage`: RAM usage in percentage
## Supported platforms
Built for arm Linux machines (Raspberry Pi). Will only need to change the functions that get the CPU and RAM usage to work on other platforms.
## Future improvements
- Add disk space usage
- Add network connection status
- Add a web interface to display the data
## Contributing
If you want to contribute to the project, you can follow the steps described in the [CONTRIBUTING](CONTRIBUTING) file.
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE) file for details.