diff --git a/README.md b/README.md index 9ed4deb..64119f9 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,23 @@ -# Uptime Kuma Health Push Monitoring +# Uptime Kuma Linux Server Health Monitor -Run this script via a cronjob to be notified about ZFS pool health and disk usage. \ No newline at end of file +A Bash script that monitors system usage stats and alerts if they rise above configurable limits. + +Run via a cron job every minute. + +## One-line installer + +Copy-paste to install the script and push status to Uptime Kuma every 60 seconds. +Then just edit `/opt/uptimekuma.sh` (if installed as root) or `$HOME/.local/bin/uptimekuma.sh` (if installed as user) +to configure the `PUSH_KEY` and customize alert parameters. + +### As root: + +```bash +mkdir -p /opt && wget -O /opt/uptimekuma.sh https://source.netsyms.com/Netsyms/uptime-kuma-server-health/raw/branch/main/uptimekuma.sh && chmod +x /opt/uptimekuma.sh && crontab -l | { cat; echo "* * * * * /opt/uptimekuma.sh"; } | crontab - +``` + +### As user: + +```bash +mkdir -p $HOME/.local/bin && wget -O $HOME/.local/bin/uptimekuma.sh https://source.netsyms.com/Netsyms/uptime-kuma-server-health/raw/branch/main/uptimekuma.sh && chmod +x $HOME/.local/bin/uptimekuma.sh && crontab -l | { cat; echo "* * * * * $HOME/.local/bin/uptimekuma.sh"; } | crontab - +``` \ No newline at end of file