sroebert/rclone

docker-rclone

镜像概述和主要用途

docker-rclone是一个基于rclone的Docker镜像，用于按cron计划执行文件同步操作，并集成healthchecks.io监控功能。rclone是一款命令行工具，支持在多种存储服务间同步文件和目录，包括本地文件系统及各类云存储服务。

核心功能和特性

• 多存储服务支持：兼容Google Drive、Amazon S3、Dropbox、Microsoft OneDrive、SFTP、FTP等多种存储服务
• 定时同步：通过cron表达式或快捷方式（如@daily、@hourly）设置同步计划
• 灵活同步模式：支持sync（双向同步）、copy（单向复制）、move（移动文件）三种模式
• 监控集成：与healthchecks.io集成，同步成功/失败后自动发送通知
• 配置持久化：通过挂载卷持久化rclone配置文件，保存存储服务凭证
• 日志管理：支持日志输出至文件及日志轮转（删除指定天数前的日志）
• 用户权限控制：可指定运行rclone的UID/GID，确保文件权限正确
• 时区设置：支持通过环境变量配置时区，确保cron计划与本地时间一致

使用场景和适用范围

• 个人或企业数据定时备份（如本地文件同步至云存储）
• 多存储服务间的数据迁移与同步
• 无人值守的定时文件传输任务
• 需要监控同步状态的关键数据同步场景
• 跨平台、跨存储服务的统一数据管理

使用方法和配置说明

配置rclone

rclone需要配置文件存储各存储服务的访问凭证，默认路径为/config/rclone.conf。可通过挂载卷持久化该配置文件。

创建配置文件：

bash
$ mkdir config
$ docker run --rm -it -v $(pwd)/config:/config pfidr34/rclone

执行以上命令后，按提示完成存储服务的配置，配置文件将保存在./config/rclone.conf中。

执行定时同步

通过环境变量自定义同步行为，以下是主要配置参数说明：

注意：使用UID/GID时，需确保配置目录和日志目录对该UID可写。

Docker部署示例

基本每日同步示例：

bash
$ docker run --rm -it \
  -v $(pwd)/config:/config \          # 挂载配置目录
  -v /path/to/local/source:/source \  # 挂载本地源目录
  -e SYNC_SRC="/source" \             # 源位置
  -e SYNC_DEST="gdrive:backup" \      # 目标位置（Google Drive的backup目录）
  -e TZ="Asia/Shanghai" \             # 设置时区为上海
  -e CRON="@daily" \                  # 每日同步
  -e FORCE_SYNC=1 \                   # 启动时立即同步
  -e CHECK_URL="https://hchk.io/your_uuid" \  # healthchecks监控URL
  pfidr34/rclone

单次同步示例：

bash
$ docker run --rm -it \
  -v $(pwd)/config:/config \
  -v /path/to/source:/source \
  -e SYNC_SRC="/source" \
  -e SYNC_DEST="s3:mybucket" \
  -e SYNC_ONCE=1 \                    # 仅执行一次同步
  pfidr34/rclone

参考文档

rclone同步命令的源/目标语法及更多选项，请参考rclone sync文档。

变更日志

• 2019/11/19：
  • 新增arm 32/64架构支持
• 2019/11/18：
  • 新增UID/GID支持
• 2019/11/06：
  • 升级至最新Rclone（v1.50.1）
• 2019/10/27：
  • 升级至最新Rclone（v1.50.0）
• 2019/10/07：
  • 升级至最新Rclone（v1.49.5）
• 2019/10/01：
  • 升级至最新Rclone（v1.49.4）
• 2019/09/23：
  • 新增环境变量SYNC_ONCE
• 2019/09/19：
  • 新增环境变量SYNC_OPTS_EVAL
• 2019/09/17：
  • 升级至最新Rclone（v1.49.3）
• 2019/09/10：
  • 修复日志轮转回归问题
• 2019/09/09：
  • 升级至最新Rclone（v1.49.2）
• 2019/08/29：
  • 升级至最新Rclone（v1.49.1）
• 2019/08/20：
  • 新增healthchecks.io调用的启动命令
  • 新增healthchecks.io调用的调试信息
• 2019/08/19：
  • 修复无日志时的日志轮转问题
• 2019/07/18：
  • Dockerfile优化
• 2019/06/22：
  • 升级至最新Rclone（v1.48.0）
• 2019/05/01：
  • 初始版本

原项目 credit：Brian J. Cardiff（https://github.com/bcardiff/docker-rclone）