digirati/backup-database-s3

backup-database-s3

镜像概述和主要用途

该容器旨在作为计划任务运行，用于对特定数据库执行自动备份，并将生成的.sql.gz压缩文件存储到S3桶中。支持PostgreSQL和MySQL数据库，通过环境变量配置实现灵活的备份策略。

核心功能和特性

• 支持PostgreSQL和MySQL数据库备份
• 自动生成压缩备份文件（.sql.gz格式）
• 通过环境变量配置备份参数，无需修改代码
• 支持自定义备份文件名的日期格式
• 可选集成Slack通知，实时反馈备份结果

使用场景和适用范围

适用于需要定期自动备份数据库并远程存储的场景，如：

• 生产环境数据库定时备份
• 多环境（开发、测试、生产）数据库归档
• 需要异地存储备份数据的业务需求
• 希望通过Slack接收备份状态通知的团队

环境变量

要求和权限

1. S3权限：需要对目标S3桶及键前缀拥有s3:PutObject权限，以允许上传备份文件。
2. 网络访问：运行容器的主机需能访问数据库主机的指定端口。
3. Docker socket挂载：需将本地Docker socket（/var/run/docker.sock）挂载到容器内。

使用方法

Docker Run示例

bash
docker run --rm --name backup-database-s3 \
  -v /var/run/docker.sock:/var/run/docker.sock \
  --env ENGINE_FAMILY='postgres' \
  --env ENGINE_VERSION='9.6' \
  --env S3_PREFIX='s3://my-backup-bucket/databases/this-database/' \
  --env DB_HOST='<数据库地址>' \
  --env DB_PORT='<数据库端口>' \
  --env DB_NAME='<数据库名称>' \
  --env DB_USERNAME='<数据库用户名>' \
  --env DB_PASSWORD='<数据库密码>' \
  --env DATE_FORMAT='+%Y%m%d%H%M' \
  --env SLACK_WEBHOOK_URL='https://slack.com/webhooks/id/token' \
  digirati/backup-database-s3

S3_PREFIX说明

备份文件名会直接附加到S3_PREFIX之后，示例如下：

SLACK_WEBHOOK_URL说明

若不需要Slack通知，留空该环境变量即可跳过通知功能。