stffabi/postgres-backup

postgres-backup镜像说明

镜像概述

该镜像基于Alpine Linux构建，体积仅36MB，用于定期备份PostgreSQL数据库。通过cronjob执行pg_dump命令生成备份文件，备份文件按日期时间命名，并自动创建最新备份的软链接（/backup/latest.psql.gz）。

核心功能

• 定时备份：通过CRON_TIME设置备份频率（默认每天0点）
• 自动管理：支持设置MAX_BACKUPS限制备份数量，自动清理旧备份
• 初始化操作：启动时可执行INIT_BACKUP创建初始备份，或INIT_RESTORE_LATEST恢复最新备份
• 灵活配置：支持自定义数据库连接参数（主机、端口、用户、密码等）
• 轻量高效：基于Alpine Linux，镜像体积小，资源占用低

使用场景

• 生产环境PostgreSQL数据库的定期自动备份
• 开发/测试环境数据的快照备份与恢复
• 需要轻量级备份方案的容器化部署场景

配置说明

以下环境变量可用于配置镜像：

• UID/GID：运行备份任务的用户/组ID，默认65534
• PG_HOST：PostgreSQL数据库主机地址
• PG_PORT：数据库端口，默认5432
• PG_USER：数据库用户名
• PG_PASS：数据库密码
• PG_DB：需备份的数据库名称（可选，默认备份所有数据库）
• EXTRA_OPTS：传递给pg_dump的额外参数
• CRON_TIME：备份定时规则，默认0 0 * * *（每天0点）
• MAX_BACKUPS：保留的最大备份数量（默认无限制）
• INIT_BACKUP：启动时是否创建初始备份（设置任意值启用）
• INIT_RESTORE_LATEST：启动时是否恢复最新备份（设置任意值启用）
• NO_CRON：是否禁用定时任务（需配合INIT_BACKUP使用，执行单次备份后退出）

部署示例

直接指定数据库参数运行

bash
docker run -d \
    --env PG_HOST=postgresdb.host \
    --env PG_PORT=5432 \
    --env PG_USER=admin \
    --env PG_PASS=password \
    --volume /host/backup/folder:/backup \
    stffabi/postgres-backup

链接PostgreSQL容器运行（自动使用默认参数）

bash
# 启动PostgreSQL容器
docker run -d -e PG_ALLOW_EMPTY_PASSWORD=true --name postgresdb postgres
# 启动备份容器并链接
docker run -d --link postgresdb:postgres -v /host/backup/folder:/backup stffabi/postgres-backup

恢复备份

查看备份列表

bash
docker exec postgres-backup ls /backup

从指定备份恢复

bash
docker exec postgres-backup /restore.sh /backup/2015.08.06.171901.psql.gz

支持

如有问题，请在https://github.com/stffabi/docker-postgres-backup/issues%E6%8F%90%E4%BA%A4Issue%E3%80%82