nestio/s3cmd-sync

s3cmd-sync 镜像文档

镜像概述和主要用途

该镜像基于s3cmd工具，提供使用s3cmd sync命令定期同步文件到Amazon S3存储桶或从S3存储桶同步文件的功能，适用于需要自动化、周期性文件同步的场景。

核心功能和特性

• 基于s3cmd sync命令实现文件同步，支持增量同步（仅同步变化文件）
• 通过环境变量配置同步间隔，支持自定义时间频率
• 集成AWS认证机制，通过环境变量传入访问凭证
• 支持灵活指定同步方向（本地到S3或S3到本地）

使用场景和适用范围

• 定期将本地文件备份到S3存储桶（如服务器日志、数据文件备份）
• 定期从S3存储桶拉取更新文件到本地（如配置文件、共享资源同步）
• 需自动化维持本地目录与S3存储桶文件一致性的业务场景

使用方法和配置说明

环境变量配置

目录挂载

需将本地同步目录挂载到容器内，挂载路径需与同步命令中的本地路径对应，格式：-v <本地路径>:<容器内路径>

Docker部署示例

从S3同步到本地（每10秒）

bash
docker run -it \
  -v $(pwd)/test:/test \  # 挂载本地test目录到容器内/test
  -e INTERVAL=10 \        # 设置同步间隔为10秒
  -e AWS_ACCESS_KEY_ID=$AWS_ACCESS_KEY_ID \  # 传入AWS访问密钥ID
  -e AWS_SECRET_ACCESS_KEY=$AWS_SECRET_ACCESS_KEY \  # 传入AWS密钥
  nestio/s3cmd-sync \
  s3://test-bucket/ /test/  # 同步命令：S3路径 本地路径（从S3到本地）

从本地同步到S3（每30秒）

bash
docker run -it \
  -v $(pwd)/local-data:/data \  # 挂载本地数据目录
  -e INTERVAL=30 \              # 同步间隔30秒
  -e AWS_ACCESS_KEY_ID=$AWS_ACCESS_KEY_ID \
  -e AWS_SECRET_ACCESS_KEY=$AWS_SECRET_ACCESS_KEY \
  nestio/s3cmd-sync \
  /data/ s3://my-backup-bucket/  # 同步命令：本地路径 S3路径（从本地到S3）

同步方向说明

• S3到本地：命令参数格式为s3://<bucket-name>/ <容器内本地路径>（如s3://test-bucket/ /test/）
• 本地到S3：命令参数格式为<容器内本地路径> s3://<bucket-name>/（如/data/ s3://my-backup-bucket/）