thomaslule/postgres-mail-backup

postgres-mail-backup镜像说明

镜像概述

postgres-mail-backup是一个Docker镜像，可定时执行PostgreSQL数据库备份，并将导出的备份文件以邮件附件形式发送至指定地址，满足用户对数据库定期备份与远程存储的需求。

核心功能

1. 定时备份：通过CRON表达式灵活设置备份频率（如每周日凌晨5点）
2. 邮件投递：将备份文件作为附件发送至目标***，实现远程保存
3. 参数自定义：支持配置数据库连接串、SMTP服务器信息等关键参数

使用场景

• 个人或小型团队需要定期备份PostgreSQL数据库的场景
• 希望将数据库备份文件通过邮件异地存储的需求
• 无需复杂运维的轻量级数据库备份方案

配置说明

环境变量

MAILBACKUP_DB_CONNECTION_STRING

PostgreSQL数据库连接字符串

• 可选
• 默认值：postgresql://postgres:admin@localhost:5432/postgres

MAILBACKUP_CRON_SCHEDULE

备份计划的CRON表达式

• 可选
• 默认值：0 5 * * 0（每周日5:00执行备份）

MAILBACKUP_SMTP_CONFIG

SMTP服务器配置的JSON字符串（适配NodeMailer）

• 必选
• 示例：{"host":"smtp.gmail.com","auth":{"user":"your-email@gmail.com","pass":"your-password"}}

MAILBACKUP_FROM_MAIL

发件人***地址

• 必选

MAILBACKUP_TO_MAIL

收件人***地址

• 必选

部署示例（Docker Compose）

yaml
version: "3"
services:
  postgres:
    image: docker.xuanyuan.run/postgres:12.2-alpine
    environment:
      POSTGRES_PASSWORD: admin
      PGDATA: /data/postgres
    volumes:
      - postgres_data:/data/postgres

  postgres-backup:
    image: docker.xuanyuan.run/thomaslule/postgres-mail-backup:latest
    depends_on:
      - postgres
    environment:
      MAILBACKUP_DB_CONNECTION_STRING: postgresql://postgres:admin@postgres:5432/postgres
      MAILBACKUP_CRON_SCHEDULE: "0 5 * * 0"
      MAILBACKUP_SMTP_CONFIG: '{"host":"smtp.gmail.com","auth":{"user":"some-garbage-account@gmail.com","pass":"its password"}}'
      MAILBACKUP_FROM_MAIL: some-garbage-account@gmail.com
      MAILBACKUP_TO_MAIL: yourmail@address.com

volumes:
  postgres_data:

注意事项

• 镜像依赖pg_dump工具，需确保其版本与PostgreSQL服务器版本完全一致，否则会因版本不匹配导致备份失败
• 使用Gmail作为发件人时，需开启“允许低安全性应用”（访问链接：https://myaccount.google.com/lesssecureapps?pli=1%EF%BC%89
• 敏感信息（如SMTP密码）建议通过安全方式管理，避免明文配置