diff options
| -rw-r--r-- | readme.md | 44 |
1 files changed, 42 insertions, 2 deletions
@@ -1,5 +1,45 @@ # statuspage -A simple configurable status page for your hosted services. Reports issues via email. +A simple configurable status page for your hosted services. Reports issues via +email. -TODO: Documentation +## Building + +The usual rust build system. Just use `cargo build --release` if unsure and use +the resulting binary in `target/release/statuspage`. Once this is "stable +software" I will submit a PKGBUILD to the AUR. + +## Configuration + +The configuration file uses YAML and is supplied by path in the first argument +of the server. Until I make better documentation, you can infer usage from this +example: + +```yaml +title: "metamuffin.org service status" +bind: 127.0.0.1:8000 +interval: 60 # check interval in seconds + +mail: # the entire mail section is optional + from: status@example.org + to: [admin@example.org] + smtp_auth: !plain # can be !plain, !starttls or !tls + smtp_server: 127.0.0.1 + smtp_port: 8025 +# smtp_username: admin # optional smtp auth +# smtp_password: hunter2 + +services: + - title: keks-meet + url: https://meet.metamuffin.org/ # url shown on the page. + # each service has a number of "checks" that need to + # be successful for the service to be considered working. + checks: + - !pacman keks-meet-server # this uses pacman -Q to check the installed version of some software + - !systemd keks-meet-server # this checks the ActiveState of a systemd service + - !http { url: https://meet.metamuffin.org/ } # this checks that status code of a HTTP request for success + + - title: failing service + checks: + - !shell { title: "Do nothing unsuccessfully", command: "false" } # this runs a command and checks the exit code +``` |