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:
1 parent
24ae8db380
commit
c2e76262ca
17 files changed
+1773
-334
No files matched your search
@@ -23,7 +23,7 @@ holds `docker-compose.yml`, `.env` and `data/`, and the service is called `homel
|
||||
|
||||
You don't need the snippets below for the everyday case: Homelab Manager takes a backup of its own
|
||||
database **every day** (03:30 in the notification time zone, the newest 14 kept — both changeable, and it
|
||||
can be switched off), checks each one as it makes it, and keeps them in `data/backups/` with the same
|
||||
can be switched off; backups you make by hand, upload or restore from are kept too: the newest ten, three and three), checks each one as it makes it, and keeps them in `data/backups/` with the same
|
||||
names the snippets use. **Settings → Data → Backup** shows them and does the rest:
|
||||
|
||||
- **Back up now** makes one on the spot. **Download** takes a copy to your computer (the quickest way
|
||||
@@ -51,7 +51,7 @@ tool), and it does not replace a restore drill. Access to all of it is for admin
|
||||
|
||||
| What | Where | Why | If you lose it |
|
||||
|---|---|---|---|
|
||||
| **The database** | `data/homelab-manager.sqlite` | Everything: users and roles, servers and their agent tokens (as hashes), scheduled tasks, secrets, IP addresses, DNS caches, domains, ports, tags, maintenance windows, both logs, settings, the integrations and DNS providers (with their credentials, encrypted), the alert-ticket memory | You start from nothing — see [If there is no backup](#if-there-is-no-backup) |
|
||||
| **The database** | `data/homelab-manager.sqlite` | Everything: users and roles, servers and their agent tokens (as hashes) with their history (load, memory, disks), scheduled tasks, secrets, IP addresses, DNS caches, domains, ports, tags, notes, to-do items, runbooks, the hardware inventory, endpoint checks and heartbeats with their results, your own alert rules, maintenance windows and snoozes, dependencies, incidents, what was read from UniFi, Proxmox and Synology storage, and Home Assistant, both logs, settings, the integrations and DNS providers (with their credentials, encrypted), the alert-ticket memory | You start from nothing — see [If there is no backup](#if-there-is-no-backup) |
|
||||
| **`CREDENTIALS_ENCRYPTION_KEY`** | `.env` | Decrypts every stored credential: integration tokens and passwords, DNS provider credentials, and the Gotify/ntfy/SMTP/webhook credentials | The database restores, but every credential in it is unreadable and has to be entered again |
|
||||
| **The rest of `.env`** | `.env` | `SESSION_SECRET`, `APP_BASE_URL`, the Authentik client id and secret | `SESSION_SECRET`: everyone has to sign in again, nothing more. The Authentik values can be copied from Authentik again |
|
||||
| Your `docker-compose.yml` and the image version | next to `.env` | So you can bring it back the way it was. Note which **version** each backup came from (the image tag, or the git commit) | Re-create it from the README |
|
||||
@@ -282,7 +282,9 @@ settings over the current ones and adds integrations and providers that don't ex
|
||||
by type and name; it never overwrites an existing one.
|
||||
|
||||
It does **not** contain servers (and their agent tokens), tasks, secrets, IP addresses, domains,
|
||||
ports, tags, maintenance windows, the users, or either log. So it is the right thing for moving
|
||||
ports, tags, maintenance windows, the users, or either log — nor the other data the app keeps: endpoint
|
||||
checks, heartbeats, alert rules, notes and to-do items, the inventory, dependencies, the Home Assistant
|
||||
watch list, incidents or any history. So it is the right thing for moving
|
||||
your *configuration* to a new instance, or as a second copy of the part that is tedious to
|
||||
re-enter. It is **not** a backup of the system: use the database backup for that.
|
||||
|
||||
|
||||
Reference in new issue
Block a user