fix: update the readmes to be more clear
This commit is contained in:
parent
dc7b8cbadd
commit
574a3a103e
6 changed files with 216 additions and 147 deletions
28
remote/discord-bot/README.md
Normal file
28
remote/discord-bot/README.md
Normal file
|
|
@ -0,0 +1,28 @@
|
|||
# Discord Bot
|
||||
|
||||
Receives webhooks from the cache service and posts door status updates to a Discord channel as embeds.
|
||||
|
||||
- Green embed = door open
|
||||
- Red embed = door closed
|
||||
- Gray embed = Pi offline
|
||||
|
||||
Validates inbound webhooks with a Bearer token. Maintains a persistent Discord gateway connection with automatic reconnection.
|
||||
|
||||
## API
|
||||
|
||||
| Method | Path | Auth | Description |
|
||||
|--------|------|------|-------------|
|
||||
| `POST` | `/webhook` | Bearer | Status update from the cache service |
|
||||
| `GET` | `/health` | — | Health check |
|
||||
|
||||
## Configuration
|
||||
|
||||
NixOS options under `services.noisebell-discord`:
|
||||
|
||||
| Option | Default | Description |
|
||||
|--------|---------|-------------|
|
||||
| `domain` | required | Caddy virtual host domain |
|
||||
| `discordTokenFile` | required | Discord bot token file |
|
||||
| `channelId` | required | Discord channel ID to post to |
|
||||
| `webhookSecretFile` | required | Shared secret with the cache service |
|
||||
| `port` | `3001` | Listen port |
|
||||
Loading…
Add table
Add a link
Reference in a new issue