peterrus/s3-cron-backup

Docker S3 Cron Backup 镜像文档

镜像概述

Docker S3 Cron Backup是一个用于定期将指定目录数据备份到Amazon S3的Docker镜像。它能够自动将目标目录打包为带时间戳的gzip压缩tar包，并按照自定义的时间调度策略上传至S3存储桶。更多信息可参考https://github.com/peterrus/docker-s3-cron-backup%E3%80%82

核心功能与特性

• 定期自动备份：通过cron调度机制实现定时备份
• 时间戳命名：备份文件自动添加时间戳，便于版本管理和追溯
• 压缩存储：采用gzip压缩tar包格式，减少存储空间占用
• 灵活配置：支持自定义备份目录、S3存储桶及备份调度周期
• Amazon S3集成：原生支持AWS S3服务，确保数据安全存储

使用场景

• 服务器数据定期备份
• 数据库文件定时归档
• 应用配置文件备份
• 日志文件周期性存储
• 需要异地容灾备份的场景

使用方法与配置说明

环境变量配置

Docker Run 示例

bash
docker run -d \
  -e AWS_ACCESS_KEY_ID="your_aws_access_key" \
  -e AWS_SECRET_ACCESS_KEY="your_aws_secret_key" \
  -e S3_BUCKET="your-bucket-name" \
  -e S3_REGION="us-west-2" \
  -e BACKUP_DIR="/data" \
  -e CRON_SCHEDULE="0 */6 * * *" \  # 每6小时备份一次
  -v /path/to/local/data:/data \     # 挂载本地目录到容器内的BACKUP_DIR
  peterrus/docker-s3-cron-backup

Docker Compose 配置示例

yaml
version: '3'
services:
  s3-backup:
    image: peterrus/docker-s3-cron-backup
    environment:
      - AWS_ACCESS_KEY_ID=your_aws_access_key
      - AWS_SECRET_ACCESS_KEY=your_aws_secret_key
      - S3_BUCKET=your-bucket-name
      - S3_REGION=us-west-2
      - BACKUP_DIR=/data
      - CRON_SCHEDULE=0 3 * * *  # 每天凌晨3点备份
      - BACKUP_PREFIX=server-backups
    volumes:
      - /var/lib/mysql:/data  # 备份MySQL数据目录
    restart: always

注意事项

1. 确保AWS访问密钥具有S3存储桶的写入权限
2. 挂载的本地目录需确保容器有读取权限
3. cron调度表达式遵循标准cron格式（分 时 日 月 周）
4. 备份文件命名格式为：<BACKUP_PREFIX>_<timestamp>.tar.gz
5. 如需调试，可通过docker logs查看备份执行日志