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

+3 -2
View File
@@ -559,8 +559,9 @@ file and its backups as sensitive anyway.
secrets, IP addresses, domains, ports, tags, maintenance windows or logs.
- **A full backup** is a copy of the SQLite file, together with the value of
`CREDENTIALS_ENCRYPTION_KEY` — without that key the stored integration
credentials can't be decrypted. Copy the file while the app is stopped, or use
SQLite's `.backup` command, so you don't capture it mid-write.
credentials can't be decrypted. Copy the file while the app is stopped, or take a
snapshot while it runs, so you don't capture it mid-write. [BACKUP.md](BACKUP.md)
has the commands (the container has no `sqlite3` tool), a nightly script, and how to restore.
## Changing the schema