Niklas Ye
44b2eb2cc3
The README was 1,240 lines of reference material and still described a SQLite quick start. It is now a short tour (highlights, screenshots of the web UI, an accurate quick start against Postgres), and each topic has its own page under docs/ with an index: deployment, configuration, Alertmanager, incidents, notifications, escalation, dead man's switches, single sign-on, web UI, API and development. SERVICE-ACCOUNTS.md is rewritten from a proposal into a reference, and TEAM-LOOKUP.md is gone with the endpoint it described. The "Upgrading to ..." sections for an unreleased product are dropped. Claude-Session: https://claude.ai/code/session_016mBLURvJoMuUEr9cB2RpUN
1.2 KiB
1.2 KiB
Terminal Duty documentation
The README is the short tour. These pages hold the detail.
Running it
- Deployment: Docker, the Helm chart, the database, backups, and the operator.
- Configuration: environment variables and settings.
- Single sign-on: OIDC, group mapping, the terminal device flow.
Using it
- The web UI: sessions, the Team and Admin tabs.
- Alertmanager configuration: routes, integration keys and webhooks.
- Alerts and incidents: correlation, lifecycle, on-call assignment, stale-alert expiry.
- Push notifications: ntfy pages and acknowledging from them.
- Escalation: ladders, repeats and the fallback topic.
- Dead man's switches: noticing that alerts stopped arriving.
Integrating and contributing
- API reference: every endpoint, authentication and error shape.
- Service accounts: non-human credentials for automation.
- Development and releasing: tests, the CI gate, the release pipeline.