jet/noisebell
jet/noisebell
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

fix: update the readmes to be more clear

Browse source
This commit is contained in:
Jet 2026-03-16 23:42:34 -07:00
parent dc7b8cbadd
commit 574a3a103e
No known key found for this signature in database
6 changed files with 216 additions and 147 deletions
Download patch file Download diff file Expand all files Collapse all files

20
remote/rss-service/README.md Normal file
View file

@ -0,0 +1,20 @@
# RSS Service
Serves an Atom feed of door status history. Stateless — it fetches from the cache service's `/history` endpoint on each request and renders the last 7 days as Atom XML.
## API
| Method | Path | Description |
|--------|------|-------------|
| `GET` | `/feed` | Atom feed |
| `GET` | `/health` | Health check |
## Configuration
NixOS options under `services.noisebell-rss`:
| Option | Default | Description |
|--------|---------|-------------|
| `domain` | required | Caddy virtual host domain |
| `cacheUrl` | required | Cache service URL (e.g. `http://localhost:3000`) |
| `port` | `3002` | Listen port |