mj-saunders
/
icanhasserver
3
2
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Include basic usage info in README

main
mj-saunders 2022-11-04 01:10:26 +04:00
parent 1cc04a6aab
commit 2c094fe894
1 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -10,10 +10,20 @@ 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 If the environment variable `WATCHDOG_LOG` is set, all output will be
redirected there. redirected there.
**NOTE** Currently only useful for services running over HTTP
## Dependencies ## Dependencies
- curl: Polling the servers - curl: Polling the servers
- msmtp: Sending email; requires separate configuration - msmtp: Sending email; requires separate configuration
**NOTE** Currently only useful for services running over HTTP
## Usage
Create the following files in the script directory:
- `urls`
- One url per line
- `recipients`
- One email address per line