vnspc/postgres-backup repository overview

⁠PostgreSQL backup to AWS S3

This project provides Docker images to periodically back up a PostgreSQL database to AWS S3, and to restore from the backup as needed.

⁠📦 Requirements

The Docker & Docker Compose system requirements are Linux Ubuntu as the OS (other operating systems are supported as well), an absolute minimum 512MB RAM (2GB recommended)

In order to install docker Ubuntu, you will need to meet the following requirements:

• OS: Linux Ubuntu
• Memory: 512MB RAM (2GB Recommended)
• Disk: Sufficient amount to run the Docker containers you wish to use
• CPU: Dependant on the applications you wish to run in the containers

⁠📋 Features

• Images are tagged by the major Postgres version supported: 14, 15 or 16.
• The SCHEDULE variable determines backup frequency. See go-cron schedules documentation here⁠. Omit to run the backup immediately and then exit.
• If PASSPHRASE is provided, the backup will be encrypted using GPG.
• Run docker exec <container name> sh backup.sh to trigger a backup ad-hoc.
• If BACKUP_KEEP_DAYS is set, backups older than this many days will be deleted from S3.
• Set S3_ENDPOINT if you're using a non-AWS S3-compatible storage provider.

⁠🔧 Installation

1. Install Docker and Docker-Compose

• Docker Install documentation⁠
• Docker-Compose Install documentation⁠

1. Bring up your stack by running

git clone https://github.com/trants/postgres-backup.git \
    && cd postgres-backup \
    && cp .env.example .env

1. Edit environment variable

# PostgreSQL
POSTGRES_DATABASE=database
POSTGRES_USER=user
POSTGRES_PASSWORD=password

# Backup
SCHEDULE=@weekly
BACKUP_KEEP_DAYS=7
PASSPHRASE=platonic-subdued-curvy-tweet-backroom
S3_REGION=us-east-1
S3_BUCKET=my-s3-bucket
S3_PREFIX=prefix
S3_ACCESS_KEY_ID=
S3_SECRET_ACCESS_KEY=
POSTGRES_HOST=postgres

1. Start PostgreSQL backup to AWS S3

docker-compose up -d

⁠📝 Usage

Example compose.yaml

version: "3.9"

services:
  postgres:
    container_name: postgres
    restart: unless-stopped
    image: postgres:16
    environment:
      - POSTGRES_DATABASE=${POSTGRES_DATABASE:-database}
      - POSTGRES_USER=${POSTGRES_USER:-user}
      - POSTGRES_PASSWORD=${POSTGRES_PASSWORD:-password}
    networks:
      - network-bridge

  backup:
    container_name: postgres-backup
    restart: unless-stopped
    image: vnspc/postgres-backup:16
    environment:
      - SCHEDULE=${SCHEDULE:-@weekly}
      - BACKUP_KEEP_DAYS=${BACKUP_KEEP_DAYS:-7}
      - PASSPHRASE=${PASSPHRASE:-passphrase}
      - S3_REGION=${S3_REGION:-region}
      - S3_BUCKET=${S3_BUCKET:-bucket}
      - S3_PREFIX=${S3_PREFIX:-prefix}
      - S3_ACCESS_KEY_ID=${S3_ACCESS_KEY_ID:-key}
      - S3_SECRET_ACCESS_KEY=${S3_SECRET_ACCESS_KEY:-secret}
      - POSTGRES_HOST=${POSTGRES_HOST:-postgres}
    depends_on:
      - postgres
    networks:
      - network-bridge

networks:
  network-bridge:
    driver: bridge
    name: network-bridge

⁠Restore

⁠... from latest backup

docker exec <container name> sh restore.sh

⁠... from specific backup

docker exec <container name> sh restore.sh <timestamp>

⁠📨 Message

I hope you find this useful. If you have any questions, please create an issue.

⁠🔐 Security

If you discover any security related issues, please email [email protected]⁠ instead of using the issue tracker.

⁠📖 License

This software is released under the BSD 3-Clause⁠ License. Please see the LICENSE⁠ file or https://trants.me/LICENSE.txt⁠ for more information.

⁠✨ Contributors

Thanks goes to these wonderful people (emoji key⁠):

Son Tran Thanh ⁠ 💻⁠ 📝⁠

This project follows the all-contributors⁠ specification. Contributions of any kind welcome!