diff --git a/README.md b/README.md index 85d191f..4c5fe70 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,27 @@ -# Alert-to-notify +# alerttonotify -Receives HTTP requests from alertmanager. Sends to DBUS notify. +Receives Alertmanager webhook notifications and forwards them via NATS to a dbus notification service. -# Usage +## Configuration -TODO +All configuration is via environment variables: +| Variable | Required | Description | +|---|---|---| +| `NATS_URL` | Yes | NATS server URL | +| `NATS_NKEY` or `NATS_NKEY_FILE` | Yes | NKey seed for NATS authentication | +| `ALERTTONOTIFY_ADDR` | No | HTTP listen address (default `:5001`) | + +## Building + +```bash +# With Go +go build -v ./... + +# With Nix +nix build +``` + +## Usage + +Point an Alertmanager webhook receiver at `http://:5001/alert`.