Skip to content

Data and backups ​

Back up the database and configuration. Sandbox files and source-system data are outside the Orpheus PostgreSQL database.

PreservePurpose
PostgreSQLSessions, runs, accepted messages, profiles, accounts and encrypted API keys
ENV_ENCRYPTION_KEYDecrypt stored environment values and model API keys
orpheus.toml and Mattermost workflowsReproduce configuration
GitLab review workflows and connector settingsRestore project routing, review policies and connection settings
Secrets and SAML filesService connections and user sign-in
S3 credential storeAccount authorization files

If you use Space, back up its separate database too. It stores schedules, occurrence history and browser sessions. Full agent answers remain in the Orpheus database.

PostgreSQL backup ​

From the example Compose directory:

sh
docker compose exec -T db pg_dump -U orpheus -d orpheus -Fc > orpheus.dump

Keep a protected copy away from the server. Test recovery into a separate empty database, not over the live database:

sh
pg_restore --no-owner --no-acl --dbname="$RESTORE_DATABASE_URL" orpheus.dump

Install PostgreSQL client tools for this command. RESTORE_DATABASE_URL must point to a test database. Preserve the encryption key and configuration corresponding to the backup.

Restored history does not recreate a deleted sandbox. Do not run a restored worker alongside production against the same tasks. Finished documents and comments should remain in the destination system.

docker compose down preserves the volume. down -v removes it.

Space database ​

From examples/space:

sh
docker compose exec -T db pg_dump -U orpheus_space -d orpheus_space -Fc > orpheus-space.dump

Restore this backup to a separate Space database. Keep the test Space worker stopped so restored schedules cannot submit work to production Orpheus.