Document the backup and restore procedure in BACKUP.md

What to back up (the database file, and CREDENTIALS_ENCRYPTION_KEY kept apart from it), two ways to take a
backup (stop and copy, or a VACUUM INTO snapshot while the app runs, using only Node and the app's own database
library since the container has no sqlite3), checking a backup, taking one before every upgrade, keeping
backups safe, a nightly script with rotation, step-by-step restore (an older backup restores into a newer
version, not the reverse; what a wrong key looks like), and how the encrypted export in Settings -> Backup
differs from a real backup.

The commands were run against a scratch database made with the real migrations: a snapshot taken while the
app was writing, an older version's database upgrading itself when the current version started, the wrong-key
error, and the rotation line. They were not run through docker compose exec in the real container.

DATABASE.md pointed at SQLite's .backup command, which the container doesn't have; it now points here.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
This commit is contained in:
bobbanandClaude Sonnet 5.5 committed 2026-10-08 00:28:58 +02:00
1 parent c693600780
commit 51ad309e35
3 files changed
+298 -3

No files matched your search

+2 -1
View File
@@ -364,7 +364,8 @@ caches nothing, so an installed copy always shows the current build.
**More documentation**: [ROLES.md](ROLES.md) — who can see and do what;
[NOTIFICATIONS.md](NOTIFICATIONS.md) — every notification the app sends and when;
[INTEGRATIONS.md](INTEGRATIONS.md) — the credentials each integration needs;
[DATABASE.md](DATABASE.md) — the database tables, columns and relationships.
[DATABASE.md](DATABASE.md) — the database tables, columns and relationships;
[BACKUP.md](BACKUP.md) — what to back up, how (also while it runs), how to restore, and how to check it.
## Requirements