selfhost-utils/README.md

22 lines
1023 B
Markdown
Raw Normal View History

2022-04-01 00:02:23 +02:00
# Selfhost utilities
A collection of utilities for self hosters.
2022-04-06 19:26:56 +02:00
Every utility is in a folder with its relevant configuration and is completely separated from the other, so you can install only the ones you need.
2022-04-01 00:02:23 +02:00
## HEALTHCHECK
A simple server health check.
2022-04-09 22:48:28 +02:00
Allows to keep under control the machine vitals (cpu usage, raid status, thermals...) and alter the sysadmin in case of anomalies.
2022-04-06 19:26:56 +02:00
Sends an email and/or executes a command in case of alarm (high temperature, RAID disk failed etc...).
2022-04-01 10:27:04 +02:00
As an example, the command may be a ntfy call to obtain a notification on a mobile phone or desktop computer.
Meant to be run with a cron (see healthcheck.cron.example).
Tested on Debian 11, but should run on almost any standard linux box.
![Email](images/healthcheck_email_notification.png)
![Ntfy](images/healthcheck_ntfy_notification.png)
2022-04-01 00:02:23 +02:00
2022-04-06 19:26:56 +02:00
Please see [healthcheck documentation](healthcheck/README.md)
2022-04-01 10:27:04 +02:00
# License
This whole repository is released under GNU General Public License version 3: see http://www.gnu.org/licenses/