The pgdump running mode executes either a pg_dump or pg_dumpall database backup against another PostgreSQL database.

MODE: pgdump

Environment Variables


Name Default Description
MODE None Set to pgdump to run as pg_dump job
PGDUMP_DB None Name of the database the backup is being performed on.
PGDUMP_HOST None Hostname of the database the backup is being performed on.
PGDUMP_PASS None Password for the PostgreSQL role being used.
PGDUMP_USER None Username for the PostgreSQL role being used.


Name Default Description
PGDUMP_ALL TRUE Run pg_dump instead of pg_dumpall. Set to false to enable pg_dump.
PGDUMP_CUSTOM_OPTS None Advanced options to pass into pg_dump or pg_dumpall.
PGDUMP_FILENAME dump Name of the file created by the pgdump container.
PGDUMP_PORT 5432 Port of the PostgreSQL database to connect to.
CRUNCHY_DEBUG FALSE Set this to true to enable debugging in logs. Note: this mode can reveal secrets in logs.

For a list of advanced options for configuring the PGDUMP_CUSTOM_OPTS variable, see the official documentation:

Dump Location

Backups are stored in a mounted backup volume location, using the database host name plus -backups as a sub-directory, then followed by a unique backup directory based upon a date/timestamp. It is left to the user to perform database backup archives in this current version of the container. This backup location is referenced when performing a database restore.