mrsad/mongodb-backup-s3

mongodb-backup-s3

镜像概述和主要用途

该镜像通过cronjob运行mongodump命令，将MongoDB数据定时备份到S3存储桶。基于https://github.com/halvves/mongodb-backup-s3分支开发，增加了AWS S3 v4授权机制支持，解决了"InvalidRequest: The authorization mechanism you have provided is not supported"错误。适用于需要定期将MongoDB数据备份到S3存储的场景，可与https://github.com/deenoize/nginx-mongo-docker等Docker环境配合使用。

核心功能和特性

• S3 v4授权支持：解决旧版授权机制不兼容问题，支持AWS S3 v4授权标准
• 定时自动备份：通过cronjob实现周期性备份，默认每天03:00执行
• 自动配置获取：链接MongoDB容器（别名mongodb）时，可自动加载主机、端口、用户名和密码
• 灵活初始化操作：支持容器启动时立即执行备份（INIT_BACKUP）或恢复（INIT_RESTORE）
• 非标准区域支持：通过BUCKET_REGION参数解决非标准区域S3桶的PermanentRedirect错误
• 可定制备份策略：支持指定备份路径、数据库名称、备份时间、时区等参数
• 备份管理功能：提供备份列表查看和手动恢复操作

使用场景和适用范围

• 生产环境MongoDB数据库的定期自动备份
• 开发/测试环境从S3备份快速恢复数据（如新建实例初始化）
• 需要将MongoDB数据备份到AWS S3或兼容S3协议的存储服务的场景
• 解决因S3授权机制不兼容导致的备份失败问题

使用方法和配置说明

Docker Run 示例

基本使用

bash
docker run -d \
  --env AWS_ACCESS_KEY_ID=awsaccesskeyid \
  --env AWS_SECRET_ACCESS_KEY=awssecretaccesskey \
  --env BUCKET=mybucketname \
  --env MONGODB_HOST=mongodb.host \
  --env MONGODB_PORT=27017 \
  --env MONGODB_USER=admin \
  --env MONGODB_PASS=password \
  docker.xuanyuan.run/deenoize/mongodb-backup-s3

链接MongoDB容器（自动获取配置）

当链接到别名为mongodb的MongoDB容器时，镜像会尝试自动加载主机、端口、用户名和密码：

bash
docker run -d \
  --env AWS_ACCESS_KEY_ID=myaccesskeyid \
  --env AWS_SECRET_ACCESS_KEY=mysecretaccesskey \
  --env BUCKET=mybucketname \
  --env BACKUP_FOLDER=a/sub/folder/path/ \
  --env INIT_BACKUP=true \
  --link my_mongo_db:mongodb \
  docker.xuanyuan.run/deenoize/mongodb-backup-s3

非标准区域S3桶配置

如果S3桶位于非标准区域并出现PermanentRedirect错误，需指定BUCKET_REGION参数：

bash
docker run -d \
  --env AWS_ACCESS_KEY_ID=myaccesskeyid \
  --env AWS_SECRET_ACCESS_KEY=mysecretaccesskey \
  --env BUCKET=mybucketname \
  --env BUCKET_REGION=mybucketregion \
  --env BACKUP_FOLDER=a/sub/folder/path/ \
  --env INIT_BACKUP=true \
  --link my_mongo_db:mongodb \
  docker.xuanyuan.run/deenoize/mongodb-backup-s3

Docker Compose 配置

自动备份配置

yaml
mongodbbackup:
  image: 'docker.xuanyuan.run/deenoize/mongodb-backup-s3:latest'
  links:
    - mongodb
  environment:
    - AWS_ACCESS_KEY_ID=myaccesskeyid
    - AWS_SECRET_ACCESS_KEY=mysecretaccesskey
    - BUCKET=my-s3-bucket
    - BACKUP_FOLDER=prod/db/
  restart: always

初始化恢复配置（适用于新建实例或开发环境）

yaml
mongodbbackup:
  image: 'docker.xuanyuan.run/deenoize/mongodb-backup-s3:latest'
  links:
    - mongodb
  environment:
    - AWS_ACCESS_KEY_ID=myaccesskeyid
    - AWS_SECRET_ACCESS_KEY=mysecretaccesskey
    - BUCKET=my-s3-bucket
    - BACKUP_FOLDER=prod/db/
    - INIT_RESTORE=true
    - DISABLE_CRON=true

配置参数说明

从备份恢复数据

列出备份文件

bash
docker exec mongodb-backup-s3 /listbackups.sh

恢复指定备份

传递备份文件名的时间戳部分（例如备份文件名为backup-20170406T155812.tar.gz，仅需传递20170406T155812）：

bash
docker exec mongodb-backup-s3 /restore.sh 20170406T155812

恢复最新备份

bash
docker exec mongodb-backup-s3 /restore.sh

致谢

• 基于 https://github.com/halvves/mongodb-backup-s3 分支开发
• 原分支源自 https://github.com/futurist 对 https://github.com/tutumcloud/mongodb-backup 的分支