Salta ai contenuti
Engram Docs

Backup & Restore

Questi contenuti non sono ancora disponibili nella tua lingua.

Engram’s state lives in three places. All three need backing up.

What to back up

Section titled “What to back up”
  1. Postgres: notes, metadata, users, DEKs (encrypted), Oban jobs
  2. MinIO (or your S3 bucket): attachments
  3. ENCRYPTION_MASTER_KEY: stored outside the cluster, see Encryption Setup

Qdrant can be rebuilt from scratch by reindexing. It’s a derivative of Postgres data. Backing it up is optional and only saves the time of re-embedding.

Postgres

Section titled “Postgres”

Use pg_dump:

Terminal window
docker compose exec -T postgres \
  pg_dump -U engram engram --clean --if-exists \
  | gzip > engram-db-$(date +%F).sql.gz

For larger deployments, set up streaming WAL backups with a tool like pgBackRest or Barman. Both have first-class tutorials for Postgres in Docker; pick whichever your ops setup already uses.

MinIO

Section titled “MinIO”

mc mirror is the simplest path:

Terminal window
mc mirror --overwrite local/engram-attachments remote/engram-backup

Where local is your MinIO alias and remote is wherever you ship backups.

Restore

Section titled “Restore”

Order matters:

  1. Restore Postgres first. The DEKs in the DB are still wrapped by ENCRYPTION_MASTER_KEY.
  2. Restore the master key. Without it, Postgres data is bytea garbage.
  3. Restore the attachment bucket. Notes reference attachments by key. If attachments are missing, notes still load but their embeddings/attachments 404.
  4. Boot the app. It runs migrations if needed, then the boot canary verifies the master key matches the DB.
  5. (Optional) Reindex Qdrant. If Qdrant wasn’t backed up, you can rebuild it by re-enqueuing every note’s embedding job. The Oban worker pipeline will repopulate Qdrant from Postgres. A first-class mix engram.reindex task is on the roadmap; until then, an IEx loop over Engram.Notes.list_all/0 + the EmbedNote worker does the job. Reindexing only costs you the re-embedding time, not data integrity.

Disaster recovery checklist

Section titled “Disaster recovery checklist”
  • Postgres dump is older than 24h? Bad. Cron it.
  • Master key is in 2+ separate physical locations? Required.
  • Attachment bucket has versioning enabled? Strongly recommended.
  • Restore drill done at least once? Do it before you need it.

What an Engram restore does NOT recover

Section titled “What an Engram restore does NOT recover”
  • MCP OAuth tokens issued to clients are invalidated by a restore (they reference state in DB). Clients need to re-connect.
  • WebSocket sync state. Obsidian plugins reconnect automatically and reconcile against the restored DB.
  • Anything written after the last backup. Plan your RPO accordingly.