Chapter 3. Backup and Recovery Setup

Once you have pg_probackup3 installed, complete the following setup:

  • Initialize the backup catalog.

  • Add a new backup instance to the backup catalog.

  • Configure the database cluster to enable pg_probackup3 backups.

  • Optionally, configure SSH for running pg_probackup3 operations in the remote mode.

  • Optionally, configure S3 for running pg_probackup3 connected to the S3 storage.

Initializing the Backup Catalog

pg_probackup3 stores all WAL and backup files in the corresponding subdirectories of the backup catalog.

Before initializing the backup catalog, make sure the following prerequisites are fulfilled:

  • pg_probackup3 is connected to the Postgres Pro server.

  • The user launching pg_probackup3 has full access to the backup_dir directory.

To initialize the backup catalog, run the following command:

pg_probackup3 init -B backup_dir

where backup_dir is the path to the backup catalog. If the backup_dir already exists, it must be empty. Otherwise, pg_probackup3 returns an error.

pg_probackup3 creates the backup_dir backup catalog, with the following subdirectories:

  • wal/ — directory for WAL files.

  • backups/ — directory for backup files.

Once the backup catalog is initialized, you can add a new backup instance.