Back up PostgreSQL

Back up the PostgreSQL metadata databases. They store users, workspaces, and platform state.

circle-check

What to back up

Deployments use two databases on the same PostgreSQL host:

  • Backend Database

  • Core API Database

If you use external PostgreSQL

This is the recommended setup for production.

Back up both databases using your standard PostgreSQL tooling.

Examples:

  • Managed snapshots

  • PITR

  • pg_dump (logical backup)

circle-info

Make restores part of the plan. A backup without a tested restore is not a backup.

If you use the bundled PostgreSQL

Use this for dev/test only.

The Compose bundle typically creates a Docker volume named database-data.

Back up the Docker volume (for example using docker-volume-backuparrow-up-right).

It's recommended to use a managed PostgresSQL database host instead of the one created by Syntho docker compose manifest. Syntho application creates two databases on this host:

  • syntho-backend for Backend service

  • syntho-core for Core API service

To change the application to use an external database add the entries below to the .env file

After changing database settings restart the application

circle-exclamation

Last updated

Was this helpful?