docs: add dashboard and announce API documentation
Made-with: Cursor
This commit is contained in:
22
README.md
22
README.md
@@ -39,10 +39,14 @@ Full documentation: [`docs/api.md`](docs/api.md)
|
||||
| `/shows` | GET | -- | List all shows (paginated) |
|
||||
| `/shows/by-episode/{episode_number}` | GET | -- | Look up show by episode number |
|
||||
| `/shows/{show_id}` | GET | -- | Specific show by internal ID |
|
||||
| `/login` | GET/POST | -- | Login page |
|
||||
| `/logout` | GET | Session | Clear session |
|
||||
| `/dashboard` | GET | Session | Live playlist dashboard |
|
||||
| `/admin/refresh` | POST | Bearer | Trigger immediate SoundCloud fetch |
|
||||
| `/admin/tracks` | POST | Bearer | Add track to current show |
|
||||
| `/admin/tracks/{track_id}` | DELETE | Bearer | Remove track from current show |
|
||||
| `/admin/tracks/{track_id}/position` | PUT | Bearer | Move track to new position |
|
||||
| `/admin/announce` | POST | Bearer/Session | Announce track to IRC |
|
||||
|
||||
## Configuration
|
||||
|
||||
@@ -59,6 +63,24 @@ Environment variables (prefix `NTR_`):
|
||||
| `NTR_SHOW_DAY` | `2` | Day of week for show (0=Mon, 2=Wed) |
|
||||
| `NTR_SHOW_HOUR` | `22` | Hour (Eastern Time) when the show starts |
|
||||
|
||||
## Dashboard
|
||||
|
||||
An optional web dashboard for announcing tracks to IRC during live shows.
|
||||
Nick opens the dashboard, sees the current and previous week's playlist, and
|
||||
clicks "Announce" next to a track to push it to the configured IRC channel
|
||||
via connected bot plugins.
|
||||
|
||||
Enable by setting these environment variables:
|
||||
|
||||
| Variable | Default | Description |
|
||||
|----------|---------|-------------|
|
||||
| `NTR_WEB_USER` | *(required)* | Dashboard login username |
|
||||
| `NTR_WEB_PASSWORD` | *(required)* | Dashboard login password |
|
||||
| `NTR_SECRET_KEY` | *(required)* | Secret key for cookie signing |
|
||||
|
||||
Bot plugins (Sopel and Limnoria) connect to the API's WebSocket endpoint
|
||||
to receive announcements. See plugin READMEs for configuration.
|
||||
|
||||
## Development
|
||||
|
||||
```bash
|
||||
|
||||
Reference in New Issue
Block a user