From 991d0d1a08c9730942d53313f9015f8f610dc8bb Mon Sep 17 00:00:00 2001 From: Paul Campbell Date: Sun, 28 Jul 2024 18:29:20 +0100 Subject: [PATCH] docs: add missing notification config details --- crates/cli/README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/crates/cli/README.md b/crates/cli/README.md index 3e359dc..607a542 100644 --- a/crates/cli/README.md +++ b/crates/cli/README.md @@ -100,6 +100,16 @@ This is the address and port that your reverse proxy should route traffic to. - **addr** - the IP address the server should bind to - **port** - the IP port the server should bind to +#### notification + +The server should be able to notify the user when manual intervention is required. +Currently this is only available via sending a Webhook message. + +- **type** - one of `None` or `Webhook` +- **webhook** - the URL to POST the notification to + +See [Notifications](#notifications) for more details. + #### webhook Your forges need to know where they should route webhooks to. This should be