Documentation: guides in docs/, and the reference docs brought up to date

- New docs/ folder: SSO, API, Prometheus and Grafana, webhooks, heartbeats and calendar, how monitoring works, and an index; the old root API.md is split across them
- Read API: alerts carry snoozedUntil
- DATABASE.md: table and migration counts, indexes, relations, integration config, settings and internal flags, delete rules, retention
- ROLES.md: the sidebar table rebuilt from the menu
- NOTIFICATIONS.md, INTEGRATIONS.md, BACKUP.md, AGENT_UPDATE.md: what had drifted
- README: links to the guides; accounts cannot be deleted in the app

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
This commit is contained in:
bobbanandClaude Sonnet 5.5 committed 2026-10-21 00:09:43 +02:00
1 parent 24ae8db380
commit c2e76262ca
17 files changed
+1773 -334

No files matched your search

+33 -23
View File
@@ -19,49 +19,59 @@ page's own top-level link.
| Menu item | Path | Viewer | Operator | Admin |
|---|---|:---:|:---:|:---:|
| Dashboard | `/` | ✅ | ✅ | ✅ |
| My work | `/my-work` | ❌ | ✅ | ✅ |
| **Infrastructure** | | | | |
| Servers | `/servers` | ✅ | ✅ | ✅ |
| Proxmox | `/proxmox` | ✅ | ✅ | ✅ |
| Synology | `/synology` | ✅ | ✅ | ✅ |
| Proxmox Backup | `/pbs` | ✅ | ✅ | ✅ |
| Backup coverage | `/backups` | ✅ | ✅ | ✅ |
| Inventory | `/inventory` | ✅ | ✅ | ✅ |
| Dependencies (Map → Dependencies) | `/map?view=dependencies` | ✅ | ✅ | ✅ |
| Endpoints | `/endpoints` | ✅ | ✅ | ✅ |
| Change log | `/changes` | — | ✅ | ✅ |
| Docker | `/docker` | ✅ | ✅ | ✅ |
| Tailscale | `/tailscale` | ✅ | ✅ | ✅ |
| Map (Connections, and Dependencies) | `/map` | ✅ | ✅ | ✅ |
| Inventory (and Racks, Labels, Lifecycle) | `/inventory` | ✅ | ✅ | ✅ |
| Admin Links | `/admin-links` | ✅ | ✅ | ✅ |
| **Backups** | | | | |
| Backup coverage | `/backups` | ✅ | ✅ | ✅ |
| Proxmox Backup | `/pbs` | ✅ | ✅ | ✅ |
| **Network** | | | | |
| DNS | `/dns` | ✅ | ✅ | ✅ |
| Domains | `/domains` | ✅ | ✅ | ✅ |
| DNS (and Domains) | `/dns` | ✅ | ✅ | ✅ |
| Network devices | `/network/devices` | ✅ | ✅ | ✅ |
| Proxy hosts | `/proxy-hosts` | ✅ | ✅ | ✅ |
| IP Addresses | `/ipam` | ✅ | ✅ | ✅ |
| Ports | `/ports` | ✅ | ✅ | ✅ |
| Consistency | `/consistency` | ✅ | ✅ | ✅ |
| **Monitoring** | | | | |
| Endpoints | `/endpoints` | ✅ | ✅ | ✅ |
| Alert rules | `/alert-rules` | ✅ | ✅ | ✅ |
| Heartbeats | `/heartbeats` | ✅ | ✅ | ✅ |
| Uptime Kuma | `/uptime-kuma` | ✅ | ✅ | ✅ |
| Home Assistant | `/home-assistant` | ✅ | ✅ | ✅ |
| **Automation** | | | | |
| Semaphore | `/semaphore` | ✅ | ✅ | ✅ |
| Gitea | `/gitea` | ✅ | ✅ | ✅ |
| Secrets | `/secrets` | ✅ | ✅ | ✅ |
| **Operations** | | | | |
| Alerts | `/alerts` | ✅ | ✅ | ✅ |
| Maintenance | `/maintenance` | ✅ | ✅ | ✅ |
| Updates | `/updates` | ✅ | ✅ | ✅ |
| Uptime Kuma | `/uptime-kuma` | ✅ | ✅ | ✅ |
| osTicket | `/osticket` | ✅ | ✅ | ✅ |
| Admin Links | `/admin-links` | ✅ | ✅ | ✅ |
| Generator | `/generator` | ✅ | ✅ | ✅ |
| Secrets (a top-level entry) | `/secrets` | ✅ | ✅ | ✅ |
| **Operations** | | | | |
| Alerts (Now, History, Noise) | `/alerts` | ✅ | ✅ | ✅ |
| Maintenance | `/maintenance` | ✅ | ✅ | ✅ |
| Updates (and Patch plans) | `/updates` | ✅ | ✅ | ✅ |
| Coming up | `/coming-up` | ✅ | ✅ | ✅ |
| To do | `/todo` | ✅ | ✅ | ✅ |
| Monthly report | `/reports` | ✅ | ✅ | ✅ |
| Change log (and the raw audit log, `?view=audit`) | `/changes` | ❌ | ✅ | ✅ |
| **Administration** | | | | |
| Integrations | `/integrations` | ✅ | ✅ | ✅ |
| Diagnostic Log (Integrations → Call log) | `/integrations?view=calls` | ❌ | ❌ | ✅ |
| Generator | `/generator` | ✅ | ✅ | ✅ |
| Users | `/users` | ❌ | ❌ | ✅ |
| Sessions (Users → Signed in now) | `/users?view=sessions` | ❌ | ❌ | ✅ |
| Audit Log (Change log → Raw audit log) | `/changes?view=audit` | ❌ | ✅ | ✅ |
| Diagnostic Log (Integrations → Call log) | `/integrations?view=calls` | ❌ | ❌ | ✅ |
| Settings | `/settings` | ❌ | ❌ | ✅ |
| Privacy (footer link, not in a group) | `/privacy` | ✅ | ✅ | ✅ |
| **Outside the menu** | | | | |
| API tokens (user menu) | `/api-tokens` | ✅ | ✅ | ✅ |
| Privacy (footer link) | `/privacy` | ✅ | ✅ | ✅ |
So in practice: **every page is visible to every role except the five
under Administration** — Users (with Signed in now) and Settings need admin; the
Call log tab of Integrations needs admin (operators and viewers see Integrations without it); the raw audit log, a tab of the Change log, needs operator or admin.
Sessions, the Audit Log, the Diagnostic Log and Dependencies were pages of their own once; their old addresses redirect to the sections above.
So in practice: **every page is visible to every role except a few** — *My work* and the *Change log* (with the raw audit log) need operator; *Users* (with *Signed in now*) and *Settings* need
admin; and the *Call log* tab of Integrations needs admin (operators and viewers see Integrations without it). The sections that used to be pages of their own — Sessions, the audit log, the
Diagnostic Log, Dependencies, Domains — now live inside those pages, and their old addresses redirect there.
## Being able to see a page isn't the same as being able to change things