Files
notes/docs/home-server/backups.md
T

132 lines
6.3 KiB
Markdown

---
schema_version: 1
id: home-server.backups
type: reference
scope: [jupiter, backrest, restic, google-drive, recovery]
sensitivity: private-infrastructure
last_reviewed: "2026-10-16"
sources:
- kind: owner-report
reference: "Backrest plan JSON, destination, key custody and no restore test, 2026-10-06"
- kind: owner-report
reference: "Updated four-service Backrest plan and deployed Portainer bind mount/container name, 2026-10-06"
- kind: owner-report
reference: "Only restic key has independent custody; no independent credential recovery or backup/restore evidence, 2026-10-06"
- kind: owner-report
reference: "Updated six-directory Backrest plan including Authentik and Wardrowbe, deployed Authentik hook container names confirmed; independent recovery custody unchanged, 2026-10-16"
- kind: repository
repository: jupiter-stacks
revision: d09df456ad331b8beb9a40615114ea8aae2dced5
paths:
- stacks/backrest/docker-compose.yml
- stacks/gitea/docker-compose.yml
- stacks/paperless-ngx/docker-compose.yml
- stacks/vaultwarden/docker-compose.yml
- stacks/authentik/docker-compose.yml
- stacks/wardrowbe/docker-compose.yml
related: [home-server.reference, home-server.storage, home-server.portainer, home-server.authentication, home-server.operations]
update_triggers: [backup-plan-change, destination-change, hook-change, credential-change, restore-test]
unknowns:
- last-successful-backup-and-repository-check
- google-drive-repository-path
- measured-rpo-and-rto
---
# Backups
| Setting | Value |
| --- | --- |
| Engine | Backrest / restic; plan `jupiter-backup` |
| Repository | `jayo60013-gdrive`; Google Drive; account `jayo60013` |
| Schedule | `0 3 * * *`; UTC; daily 03:00 |
| Retention | `policyKeepLastN: 4`; last four snapshots, not four days |
| Encryption key | iCloud password app; no key stored here |
| Independent credential recovery | None beyond the restic encryption key |
| Backup / integrity evidence | None supplied |
| Restore test | Never performed |
## Coverage
Backrest bind-mounts host `/data` at container `/userdata:ro`.
| Host source | Plan path |
| --- | --- |
| `/data/authentik` | `/userdata/authentik` |
| `/data/gitea` | `/userdata/gitea` |
| `/data/paperless-ngx` | `/userdata/paperless-ngx` |
| `/data/portainer` | `/userdata/portainer` |
| `/data/vaultwarden` | `/userdata/vaultwarden` |
| `/data/wardrowbe` | `/userdata/wardrowbe` |
Case-insensitive exclusions: `/userdata/gitea/gitea/packages`,
`/userdata/wardrowbe/redis`.
`excludes: []`; CLI `--skip-if-unchanged` supplied despite
plan `skipIfUnchanged: false`. Unchanged runs may create no snapshot.
## Consistency hooks
Stop timeout `120s`; chains use `&&`. Errors: `ON_ERROR_FATAL`,
except Portainer, Wardrowbe and Authentik restart hooks (`ON_ERROR_IGNORE`).
Rows below group the supplied hooks by service; the plan lists Wardrowbe's
hooks before Authentik's.
| Event | Ordered commands / containers |
| --- | --- |
| `SNAPSHOT_START` | Stop `paperless` -> `paperless_db` |
| `SNAPSHOT_START` | Stop `gitea_runner` -> `gitea` -> `gitea_db` |
| `SNAPSHOT_START` | Stop `vaultwarden` |
| `SNAPSHOT_START` | Stop `portainer` |
| `SNAPSHOT_END`, `SNAPSHOT_ERROR` | Start `paperless_db` -> `paperless` |
| `SNAPSHOT_END`, `SNAPSHOT_ERROR` | Start `gitea_db` -> `gitea` -> `gitea_runner` |
| `SNAPSHOT_END`, `ANY_ERROR` | Start `vaultwarden` |
| `SNAPSHOT_END`, `SNAPSHOT_ERROR` | Start `portainer`; ignore hook failure |
| `SNAPSHOT_START` | Stop `wardrowbe-frontend`, `wardrowbe-backend`, `wardrowbe-worker`, `wardrowbe-image-worker` in one command -> stop `wardrowbe-postgres`, `wardrowbe-redis` |
| `SNAPSHOT_END`, `SNAPSHOT_ERROR` | Start `wardrowbe-postgres`, `wardrowbe-redis` -> wait for PostgreSQL and Redis -> start backend, worker, image-worker, frontend; ignore hook failure |
| `SNAPSHOT_START` | Stop `authentik-server`, `authentik-worker` in one command -> stop `authentik-postgresql` |
| `SNAPSHOT_END`, `SNAPSHOT_ERROR` | Start `authentik-postgresql` -> wait for PostgreSQL -> start `authentik-server`, `authentik-worker`; ignore hook failure |
Cold filesystem copies of applications/databases; no database dumps supplied.
Paperless broker stays running. Paperless/Gitea restart chains use `docker start`
without waiting for database readiness.
Wardrowbe waits inside the containers using `pg_isready -U wardrowbe -d wardrowbe`
then `redis-cli ping`; Authentik uses `pg_isready -U authentik -d authentik`.
These are `until` loops with two-second sleeps and no explicit deadline in the
commands. Starting multiple application containers in one command does not
establish application readiness or dependency ordering.
The owner confirms the three Authentik hook names match deployed containers.
Repository Compose explicitly names only `authentik-server`; worker/database
names must be preserved or the hooks updated when recreating the stack.
Hook failure can leave services stopped; Portainer, Wardrowbe and Authentik
restart failures do not fail the backup operation. Authentik downtime also
interrupts new OIDC logins and proxy-protected access, including the Backrest UI.
Application readiness and recovery are not demonstrated by the plan.
## Backrest state
| Host path | Container path |
| --- | --- |
| `/data/backrest/data` | `/data` |
| `/data/backrest/config` | `/config`; plan/repository configuration `config.json` |
| `/data/backrest/rclone` | `/root/.config/rclone` |
| `/home/jay/data/backrest/cache` | `/cache` |
| `/data/backrest/restore` | `/restore` |
| `/var/run/docker.sock` | `/var/run/docker.sock`; lifecycle hooks |
## Recovery limits
Only the six listed directories are covered, subject to the exclusions above.
Authentik identity/MFA state and Wardrowbe PostgreSQL/uploads are included;
Wardrowbe Redis is excluded. SSD-backed Wardrowbe model/cache paths are outside
the plan. No supplied coverage for Traefik, Backrest configuration, Docker named
volumes, OS, or Mercury. Authelia is retired; old data retention is unconfirmed.
Full-host recovery requires independently retrievable repository credentials,
configuration and restic key. Key custody alone does not establish recoverability.
No independent Google Drive/rclone credential recovery or Backrest-config
recovery arrangement exists. Recovering backed-up Portainer state is not a
substitute for first being able to retrieve the backup.
`/restore` is on the same RAID array; not an independent backup.