write a readme

This commit is contained in:
Alex Tau 2025-06-14 15:18:58 +03:00
parent 8b18d407d7
commit 4558cf9e6f
7 changed files with 116 additions and 4 deletions

View file

@ -38,7 +38,16 @@ in
"vulnix"
]);
default = [ ];
description = "List of enabled check sets. Each check set is a module which checks something and generates alerts based on check results.";
description = ''
List of enabled check sets. Each check set is a module which checks something and generates alerts based on check results. Available check sets:
* start -- send an alert when lego-monitoring is started
* stop -- send an alert when lego-monitoring is stopped
* remind -- periodically (daily by default) remind about ongoing unresolved alerts
* cpu -- alerts when CPU usage is above threshold
* ram -- alerts when RAM usage is above threshold
* temp -- alerts when temperature readings are above thresholds
* net -- alerts when network usage is above threshold
* vulnix -- periodically scans system for known CVEs, alerts if any are found (NixOS only)'';
};
telegram = {