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

+16
View File
@@ -27,6 +27,7 @@ number when it is worth installing the agent again for.
| 4 (Linux) | Also reports failed services, disk health (SMART) and ZFS pool state; reads `pacman`; and can replace itself when automatic updates are switched on. |
| 4 (Windows) | Also reports failed services, disk health and Storage Spaces pools (below), and what the machine is (maker, model, serial number). |
| 6 (Linux), 5 (Windows) | Also says **what it couldn't collect and why** (no `smartctl`, no systemd, a package manager that didn't answer, Windows Update that timed out …), shown on the server's page with what to do about it (below). |
| 7 (Linux), 6 (Windows) | Also says **which operating system it runs** (distribution and release, or Windows product and build), so the server's page can say when that release stops being supported (below). |
| 5 (Linux) | Also says what the machine is — maker, model and serial number, read from the firmware — so the inventory can fill itself in (below). |
Reports are always read leniently — a field an older agent doesn't send is simply left alone, and a field
@@ -244,6 +245,21 @@ what is written there with what the agent says, when you choose to.
To see exactly what a host finds, as root: `sudo /usr/local/bin/homelab-manager-agent.sh --check-updates` — it prints the
update figures, the failed services, the SMART readings and the ZFS pools, says whether it would update itself, and changes nothing.
## What the machine runs (Linux version 7, Windows version 6)
Each agent says which operating system it runs, in the report's `system.os`: `{ id, name, version }`.
- **Linux** reads `/etc/os-release` — `ID` (lower case, e.g. `ubuntu`, `debian`, `rocky`), `VERSION_ID` and `PRETTY_NAME`. On a **Proxmox VE** host (where `pveversion` exists) it says `proxmox-ve` and the
release instead, since the Debian underneath is not what needs watching.
- **Windows** says `windows`, the product name without "Microsoft " (e.g. "Windows Server 2022 Standard") and the build number — which is how client and server releases are told apart.
The server keeps it with the machine and compares the release with a built-in table of end-of-support dates (Ubuntu, Debian, CentOS, RHEL and its rebuilds, Fedora, Alpine, openSUSE Leap, Proxmox VE, Windows
client and server). A server's page shows it in its *System* row with *supported*, *ends in N days* or *support ended*; one past its end — or inside the warning window under Settings → Notifications (*Flag an
operating system whose support ends within*, 90 days) — is on the Alerts page, and `operatingSystem` is in the read API. A release the table does not know is shown without a badge, never guessed at. An agent
older than this version reports no OS and the server shows nothing for it.
`sudo /usr/local/bin/homelab-manager-agent.sh --check-updates` prints what it found.
## How the update check works — and why a server may stay "not reported"
The agent only *asks*; it never installs, downloads or refreshes anything.