linuxer41/automate-postgres-backup repository overview

⁠Backup Postgres Docker containers to Google Cloud Storage

Inspired by postgres-backup-s3 and based on the work of Nullpixel⁠.

This docker image allows for scheduled backups of a postgres docker container to a Google Cloud Storage bucket.

⁠Features

• Backs up a postgres database to a Google Cloud Storage bucket.
• Backups are compressed using gzip.
• Backups are encrypted using AES-256. (Password is set in the environment variable ENCRYPTION_PASSWORD, function is disabled for now)
• Backups are scheduled using cron.
• Backups are versioned using a timestamp.
• Backups are automatically deleted after a set number of days.
• Backups are automatically deleted after a set number of backups.
• works with postgres 9.5+ (Change version in POSTGRES_VERSION environment variable)

⁠Usage

This image is published on the docker hub.

⁠Environment variables

⁠Scheduling

The SCHEDULE environment variable is used to determine how often the backup should occur. It uses the cron⁠ format. Additionally, you can use the basic inline format (@every number[h, d, w, m, y]) to specify the schedule. For example, @every 6h will run the backup every 6 hours.

⁠Google Cloud Service Account

We recommend creating a new, write-only service account to the storage bucket you wish to backup to (with the storage.objects.list and storage.objects.create permissions).

⁠Docker Compose

Below is a sample Docker Compose service.

dbbackups:
    image: "linuxer41/automate-postgres-backup:latest"
    depends_on:
        - database
    networks:
        - internet
        - api-internal
    environment:
        SCHEDULE: "@every 6h"
        POSTGRES_HOST: "database"
        POSTGRES_DATABASE: "SomeDatabase"
        POSTGRES_USER: "postgres"
        POSTGRES_PASSWORD: "postgres"
        GCLOUD_KEYFILE_BASE64: "BASE64_PROJECT_KEYFILE_HERE"
        GCLOUD_PROJECT_ID: "hello-world"
        GCS_BACKUP_BUCKET: "gs://my-backup-bucket-name"
        BACKUP_RETENTION_DAYS: "7"
        BACKUP_RETENTION_COUNT: "10"
        POSTGRES_VERSION: "15"
        ENCRYPTION_PASSWORD: "password"

Note: the internet network exists as api-internal is an internal network with no connection to the internet. To enable backing up to the cloud, the service has to be on an external network which can access the internet. api-internal is the network which the database is on, so that the database hostname resolves to that service.