update docs to match new functionality

This commit is contained in:
Alex Tau 2025-08-16 12:08:49 +03:00
parent 878a4fc092
commit 731b0b32fc
3 changed files with 157 additions and 40 deletions

View file

@ -1,6 +1,6 @@
# lego-monitoring
Simple system monitoring service. Sends alerts in Telegram. Currently supports monitoring:
Simple system monitoring service. Sends alerts in Telegram and/or reports status to [Healthchecks](https://healthchecks.io/). Currently supports monitoring:
* CPU/RAM/network usage
* temperature readings
* [vulnix](https://github.com/nix-community/vulnix) readings (NixOS only)
@ -57,7 +57,7 @@ cp config.example.json config.json
```
Edit `config.json` to suit your usage scenario. The default configuration only sends alerts on service's start and stop.
You may refer to the NixOS option documentation, as its options are the same, except JSON uses snake_case instead of lowerCamelCase.
You may refer to the NixOS option documentation, as its options are the same, except JSON uses snake_case instead of lowerCamelCase, and `enable` NixOS options just make a config section present or absent in JSON.
Then enable and start the service: