docker-postgres-backup-local/README.md

postgres-backup-local

Backup PostgresSQL to local filesystem with periodic backups and rotate backups. Based on schickling/postgres-backup-s3. It can backup multiple databases from the same host by setting all databases in POSTGRES_DB separated by comas or spaces.

Usage

Docker:

$ docker run -e POSTGRES_HOST=postgres -e POSTGRES_DB=dbname -e POSTGRES_USER=user -e POSTGRES_PASSWORD=password  prodrigestivill/postgres-backup-local

Docker Compose:

version: '2'
services:
    postgres:
        image: postgres
        restart: always
        environment:
            - POSTGRES_DB=database
            - POSTGRES_USER=username
            - POSTGRES_PASSWORD=password
         #  - POSTGRES_PASSWORD_FILE=/run/secrets/db_password <-- alternative for POSTGRES_PASSWORD (to use with docker secrets)
    pgbackups:
        image: prodrigestivill/postgres-backup-local
        restart: always
        volumes:
            - /var/opt/pgbackups:/backups
        links:
            - postgres
        depends_on:
            - postgres
        environment:
            - POSTGRES_HOST=postgres
            - POSTGRES_DB=database
            - POSTGRES_USER=username
            - POSTGRES_PASSWORD=password
         #  - POSTGRES_PASSWORD_FILE=/run/secrets/db_password <-- alternative for POSTGRES_PASSWORD (to use with docker secrets)
            - POSTGRES_EXTRA_OPTS=-Z9 --schema=public --blobs
            - SCHEDULE=@daily
            - BACKUP_KEEP_DAYS=7
            - BACKUP_KEEP_WEEKS=4
            - BACKUP_KEEP_MONTHS=6
            - HEALTHCHECK_PORT=80

Environment Variables

Most variables are the same as postgres official image.

env variable	description
POSTGRES_HOST	postgres connection parameter; postgres host.
POSTGRES_DB	coma list of postgres databases to connect to.
POSTGRES_USER	postgres connection parameter; postgres user to connect with.
POSTGRES_PASSWORD	postgres connection parameter; postgres password to connect with.
POSTGRES_PASSWORD_FILE	alternative to POSTGRES_PASSWORD, to use with docker secrets.
POSTGRES_EXTRA_OPTS	additional options to supply pg_dump when creating back-ups.
SCHEDULE	cron-schedule specifying the interval between taking postgres backups.
BACKUP_KEEP_DAYS	number of days to keep backups before removing.
BACKUP_KEEP_WEEKS	number of weeks to keep backups before removing.
BACKUP_KEEP_MONTHS	number of months to keep backups before removing.
HEALTHCHECK_PORT	Port listening for cron-schedule health check.

Manual Backups

By default it makes daily backups but you can start a manual one by running the command /backup.sh.

Example running only manual backup on Docker:

$ docker run -e POSTGRES_HOST=postgres -e POSTGRES_DB=dbname -e POSTGRES_USER=user -e POSTGRES_PASSWORD=password  prodrigestivill/postgres-backup-local /backup.sh

Automatic Periodic Backups

You can change the SCHEDULE environment variable like -e SCHEDULE="@daily" to change its default frequency, by default is daily.

More information about the scheduling can be found here.

Folders daily, weekly and monthly are created and populated using hard links to save disk space.