Add README

main
mj-saunders 2022-11-04 01:07:06 +04:00
parent 2c20d5bc61
commit 1cc04a6aab
1 changed files with 19 additions and 0 deletions

19
README.md 100644
View File

@ -0,0 +1,19 @@
# ICanHasServer
Monitor and report on the status of a list of servers.
Any servers in a list of `urls` that yield a bad response are collated and sent
via email to all recipients.
The `urls` along with a list of `recipients` are sourced from a separate file in
the `cwd`; it is expected to have a single email address per line.
If the environment variable `WATCHDOG_LOG` is set, all output will be
redirected there.
## Dependencies
- curl: Polling the servers
- msmtp: Sending email; requires separate configuration
**NOTE** Currently only useful for services running over HTTP