default: n example: archive-async=y
default: 128MiB allowed: [0B, 4PiB] example: archive-get-queue-max=1GiB
default: y example: archive-missing-retry=n
allowed: [0B, 4PiB] example: archive-push-queue-max=1TiB
default: 1m allowed: [100ms, 1d] example: archive-timeout=30
example: annotation=source="Sunday backup for website database"
default: y example: archive-check=n
default: n example: archive-copy=y
default: y example: archive-mode-check=n
default: n example: backup-standby=y
example: checksum-page=n
example: exclude=junk/
default: y example: expire-auto=y
default: 1GiB allowed: [1B, 1TiB] example: manifest-save-threshold=8GiB
default: y example: resume=n
default: n example: start-fast=y
default: n example: stop-auto=y
default: 1MiB example: buffer-size=2MiB
default: [path of executed pgbackrest binary] example: cmd=/var/lib/pgsql/bin/pgbackrest_wrapper.sh
default: ssh example: cmd-ssh=/usr/bin/ssh
default: y example: compress=n
default (depending on compress-type): bz2 - 9 gz - 6 lz4 - 1 zst - 3 allow range (depending on compress-type): bz2 - [1, 9] gz - [-1, 9] lz4 - [-5, 12] zst - [-7, 22] example: compress-level=9
default: 1 allowed: [-5, 12] example: compress-level-network=1
default: gz example: compress-type=none
default: 30m allowed: [100ms, 7d] example: db-timeout=600
default: n example: delta=y
default: 1m allowed: [100ms, 1h] example: io-timeout=120
default: /tmp/pgbackrest example: lock-path=/backup/db/lock
default: y example: neutral-umask=n
default: 1 allowed: [1, 999] example: process-max=4
default: 31m allowed: [100ms, 7d] example: protocol-timeout=630
default: y example: sck-keep-alive=n
default: /var/spool/pgbackrest example: spool-path=/backup/db/spool
allowed: [1, 32] example: tcp-keep-alive-count=3
allowed: [1, 3600] example: tcp-keep-alive-idle=60
allowed: [1, 900] example: tcp-keep-alive-interval=30
default: warn example: log-level-console=error
default: info example: log-level-file=debug
default: off example: log-level-stderr=error
default: /var/log/pgbackrest example: log-path=/backup/db/log
default: y example: archive-header-check=n
default: y example: page-header-check=n
example: pg-version-force=15
example: repo1-azure-account=pg-backup
example: repo1-azure-container=pg-backup
default: blob.core.windows.net example: repo1-azure-endpoint=blob.core.usgovcloudapi.net
example: repo1-azure-key=T+9+aov82qNhrcXSNGZCzm9mjd4d75/oxxOr6r1JVpgTLA==
default: shared example: repo1-azure-key-type=sas
default: host example: repo1-azure-uri-style=path
default: n example: repo1-block=y
default: n example: repo1-bundle=y
default: 2MiB allowed: [8KiB, 1PiB] example: repo1-bundle-limit=10MiB
default: 20MiB allowed: [1MiB, 1PiB] example: repo1-bundle-size=10MiB
example: repo1-cipher-pass=zWaf6XtpjIVZC5444yXB+cgFDFl7MxGlgkZSaoPvTGirhPygu4jOKOXf9LO4vjfO
default: none example: repo1-cipher-type=aes-256-cbc
example: repo1-gcs-bucket=/pg-backup
default: storage.googleapis.com example: repo1-gcs-endpoint=localhost
example: repo1-gcs-key=/etc/pgbackrest/gcs-key.json
default: service example: repo1-gcs-key-type=auto
example: repo1-gcs-user-project=my-project
default: n example: repo1-hardlink=y
example: repo1-host=repo1.domain.com
example: repo1-host-ca-file=/etc/pki/tls/certs/ca-bundle.crt
example: repo1-host-ca-path=/etc/pki/tls/certs
example: repo1-host-cert-file=/path/to/client.crt
default: [path of executed pgbackrest binary] example: repo1-host-cmd=/usr/lib/backrest/bin/pgbackrest
default: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_FILE example: repo1-host-config=/conf/pgbackrest/pgbackrest.conf
default: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_INCLUDE_PATH example: repo1-host-config-include-path=/conf/pgbackrest/conf.d
default: CFGOPTDEF_CONFIG_PATH example: repo1-host-config-path=/conf/pgbackrest
example: repo1-host-key-file=/path/to/client.key
default (depending on repo-host-type): tls - 8432 allowed: [0, 65535] example: repo1-host-port=25
default: ssh example: repo1-host-type=tls
default: pgbackrest example: repo1-host-user=repo-user
default: /var/lib/pgbackrest example: repo1-path=/backup/db/backrest
allowed: [1, 9999999] example: repo1-retention-archive=2
default: full example: repo1-retention-archive-type=diff
allowed: [1, 9999999] example: repo1-retention-diff=3
allowed: [1, 9999999] example: repo1-retention-full=2
default: count example: repo1-retention-full-type=time
allowed: [0, 9999999] example: repo1-retention-history=365
example: repo1-s3-bucket=pg-backup
example: repo1-s3-endpoint=s3.amazonaws.com
example: repo1-s3-key=AKIAIOSFODNN7EXAMPLE
example: repo1-s3-key-secret=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
default: shared example: repo1-s3-key-type=auto
example: repo1-s3-kms-key-id=bceb4f13-6939-4be3-910d-df54dee817b7
example: repo1-s3-region=us-east-1
default: n example: repo1-s3-requester-pays=n
example: repo1-s3-role=authrole
example: repo1-s3-sse-customer-key=bceb4f13-6939-4be3-910d-df54dee817b7
example: repo1-s3-token=AQoDYXdzEPT//////////wEXAMPLEtc764bNrC9SAPBSM22 ...
default: host example: repo1-s3-uri-style=path
example: repo1-sftp-host=sftprepo.domain
example: repo1-sftp-host-fingerprint=f84e172dfead7aeeeae6c1fdfb5aa8cf
default: strict example: repo1-sftp-host-key-check-type=accept-new
example: repo1-sftp-host-key-hash-type=sha256
default: 22 allowed: [1, 65535] example: repo1-sftp-host-port=22
example: repo1-sftp-host-user=pg-backup
example: repo1-sftp-known-host=/home/postgres/.ssh/known_hosts
example: repo1-sftp-private-key-file=~/.ssh/id_ed25519
example: repo1-sftp-private-key-passphrase=BeSureToGenerateAndUseASecurePassphrase
example: repo1-sftp-public-key-file=~/.ssh/id_ed25519.pub
example: repo1-storage-ca-file=/etc/pki/tls/certs/ca-bundle.crt
example: repo1-storage-ca-path=/etc/pki/tls/certs
example: repo1-storage-host=127.0.0.1
default: 443 allowed: [1, 65535] example: repo1-storage-port=9000
example: repo1-storage-tag=key1=value1
part sizefor AWS S3,
chunk sizefor GCS, and
block sizefor Azure. No attempt is made to validate configured chunk sizes so selecting an invalid value will lead to errors from the storage service or undefined behavior.
default (depending on repo-type): azure - 4MiB gcs - 4MiB s3 - 5MiB allowed: [64KiB, 1TiB] example: repo1-storage-upload-chunk-size=16MiB
default: y example: repo1-storage-verify-tls=n
example: repo-target-time=2024-08-08 12:12:12+00
default: posix example: repo1-type=cifs
default: preserve example: archive-mode=off
example: db-exclude=db_main
example: db-include=db_main
default: n example: link-all=y
example: link-map=pg_xlog=/data/xlog
example: recovery-option=primary_conninfo=db.mydomain.com
example: tablespace-map=ts_01=/db/ts_01
example: tablespace-map-all=/data/tablespace
default: localhost example: tls-server-address=*
example: tls-server-auth=client-cn=stanza1,stanza2
example: tls-server-ca-file=/path/to/server.ca
example: tls-server-cert-file=/path/to/server.crt
default: postgres example: pg1-database=backupdb
example: pg1-host=db.domain.com
example: pg1-host-ca-file=/etc/pki/tls/certs/ca-bundle.crt
example: pg1-host-ca-path=/etc/pki/tls/certs
example: pg1-host-cert-file=/path/to/client.crt
default: [path of executed pgbackrest binary] example: pg1-host-cmd=/usr/lib/backrest/bin/pgbackrest
default: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_FILE example: pg1-host-config=/conf/pgbackrest/pgbackrest.conf
default: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_INCLUDE_PATH example: pg1-host-config-include-path=/conf/pgbackrest/conf.d
default: CFGOPTDEF_CONFIG_PATH example: pg1-host-config-path=/conf/pgbackrest
example: pg1-host-key-file=/path/to/client.key
default (depending on pg-host-type): tls - 8432 allowed: [0, 65535] example: pg1-host-port=25
default: ssh example: pg1-host-type=tls
default: postgres example: pg1-host-user=db_owner
example: pg1-path=/data/db
default: 5432 allowed: [0, 65535] example: pg1-port=6543
example: pg1-socket-path=/var/run/postgresql