robwithhair/postgres-backup-s3

postgres-backup-s3

镜像概述

本Docker镜像用于将PostgreSQL数据库备份到Amazon S3存储服务，支持定期自动备份，帮助用户保障数据库数据的安全性和可恢复性。

核心功能

1. 实现PostgreSQL数据库到S3存储的完整备份；
2. 通过SCHEDULE环境变量设置定期自动备份（如每日、每周等）；
3. 支持自定义S3备份文件命名规则（是否覆盖现有文件）；
4. 可添加PostgreSQL备份额外参数（如指定schema、包含blobs等）。

使用场景

• 企业/个人项目中需定期备份PostgreSQL数据库到云端存储的场景；
• 需将数据库备份持久化到S3以防止本地数据丢失的场景；
• 希望自动化执行备份任务、减少人工操作的场景。

配置说明

需配置以下环境变量：

S3相关

• S3_ACCESS_KEY_ID：S3访问密钥ID
• S3_SECRET_ACCESS_KEY：S3秘密访问密钥
• S3_BUCKET：目标S3桶名称
• S3_REGION：S3桶所在区域（可选）
• S3_PREFIX：备份文件在S3中的路径前缀（可选）
• S3_FILENAME：自定义备份文件名（可选，设置后覆盖原有文件）

PostgreSQL相关

• POSTGRES_DATABASE：需备份的数据库名称
• POSTGRES_USER：数据库用户名
• POSTGRES_PASSWORD：数据库密码
• POSTGRES_HOST：数据库主机地址
• POSTGRES_EXTRA_OPTS：备份额外参数（如--schema=public --blobs）

定期备份

• SCHEDULE：调度规则（如@daily表示每日备份，参考cron预定义规则）

部署示例

Docker命令

sh
docker run -e S3_ACCESS_KEY_ID=你的密钥ID -e S3_SECRET_ACCESS_KEY=你的秘密密钥 -e S3_BUCKET=你的桶名称 -e S3_PREFIX=backup -e POSTGRES_DATABASE=数据库名 -e POSTGRES_USER=用户名 -e POSTGRES_PASSWORD=密码 -e POSTGRES_HOST=localhost robwithhair/postgres-backup-s3

Docker Compose配置

yaml
postgres:
  image: postgres
  environment:
    POSTGRES_USER: 用户名
    POSTGRES_PASSWORD: 密码

pgbackups3:
  image: robwithhair/postgres-backup-s3
  links:
    - postgres
  environment:
    SCHEDULE: '@daily'
    S3_REGION: 区域名（如ap-southeast-1）
    S3_ACCESS_KEY_ID: 你的密钥ID
    S3_SECRET_ACCESS_KEY: 你的秘密密钥
    S3_BUCKET: 你的桶名称
    S3_PREFIX: backup
    POSTGRES_DATABASE: 数据库名
    POSTGRES_USER: 用户名
    POSTGRES_PASSWORD: 密码
    POSTGRES_EXTRA_OPTS: '--schema=public --blobs'