pfidr/rclone

!https://img.shields.io/docker/pulls/pfidr/rclone !https://img.shields.io/docker/stars/pfidr/rclone

docker-rclone

用于基于cron调度执行[***]

rclone是一个命令行程序，用于在以下存储服务之间同步文件和目录：

• Google Drive
• Amazon S3
• Openstack Swift / Rackspace云文件 / Memset Memstore
• Dropbox
• Google Cloud Storage
• Amazon Drive
• Microsoft OneDrive
• Hubic
• Backblaze B2
• Yandex Disk
• SFTP
• FTP
• HTTP
• 本地文件系统

使用方法

配置rclone

rclone需要一个配置文件来存储访问不同存储提供商的凭证。

默认情况下，此镜像使用文件/config/rclone.conf，可以通过挂载卷来持久化此配置信息。

首次运行容器可帮助创建配置文件，也可手动创建。

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

执行每日同步

以下环境变量可用于自定义rclone的行为：

• SYNC_SRC：rclone sync/copy/move命令的源位置。包含空格的目录应使用单引号括起来。
• SYNC_DEST：rclone sync/copy/move命令的目标位置。包含空格的目录应使用单引号括起来。
• SYNC_OPTS：rclone sync/copy/move命令的附加选项。默认为-v
• SYNC_OPTS_EVAL：rclone sync/copy/move命令的进一步附加选项。字符串中的变量和命令会先像在shell中一样进行插值，插值后的字符串将追加到SYNC_OPTS。例如'--backup-dir /old\date -I`'会先计算为'--backup-dir /old2019-09-12'`，然后追加到SYNC_OPTS。插值在调用rclone之前立即进行。
• SYNC_ONCE：设置此变量可仅运行一次同步后退出容器
• RCLONE_CMD：设置运行rclone时使用的命令，可选sync、copy或move。默认为sync
• RCLONE_DIR_CMD：设置源目录检查样式，可选ls或lsf。默认为ls
• RCLONE_DIR_CMD_DEPTH：设置递归深度限制。默认为-1（rclone默认值）
• RCLONE_DIR_CHECK_SKIP：设置此变量可跳过同步前的源目录检查。谨慎使用
• CRON：crontab调度表达式，如0 0 * * *表示每天午夜执行同步。也支持cron快捷方式：@yearly、@monthly、@weekly、@daily、@hourly
• CRON_ABORT：crontab调度表达式，如0 6 * * *表示在早上6点中止同步
• FORCE_SYNC：设置此变量可在启动时强制执行同步
• CHECK_URL：https://healthchecks.io URL或类似的cron监控服务URL，用于同步成功后执行GET请求
• FAIL_URL：同步失败后执行GET请求的URL。默认是在CHECK_URL末尾追加/fail
• HC_LOG：设置此变量可将日志数据发送到healthchecks.io。必须同时设置OUTPUT_LOG
• OUTPUT_LOG：设置此变量可将日志文件输出到/logs目录
• ROTATE_LOG：设置此变量可删除/logs目录中超过指定天数的日志
• TZ：设置cron和日志使用的时区，如America/Chicago（时区列表）
• UID：指定运行rclone的用户ID。必须同时使用GID
• GID：指定运行rclone的组ID。必须同时使用UID

使用UID/GID时，配置和/或日志目录必须可被该UID写入

bash
$ docker run --rm -it -v $(pwd)/config:/config -v /path/to/source:/source -e SYNC_SRC="/source" -e SYNC_DEST="dest:path" -e TZ="America/Chicago" -e CRON="0 0 * * *" -e CRON_ABORT="0 6 * * *" -e FORCE_SYNC=1 -e CHECK_URL=https://hchk.io/hchk_uuid pfidr/rclone

参见https://rclone.org/commands/rclone_sync/%E4%BA%86%E8%A7%A3%E6%BA%90/%E7%9B%AE%E6%A0%87%E8%AF%AD%E6%B3%95%E5%92%8C%E5%85%B6%E4%BB%96%E9%80%89%E9%A1%B9%E3%80%82

变更日志

• 02/25/2025:
  • 更新至最新Rclone（v1.69.1）
• 09/03/2024:
  • 更新至最新Rclone（v1.67.0）
• 07/06/2023:
  • 更新至最新Rclone（v1.63.0）
• 07/18/2022:
  • 更新至最新Rclone（v1.59.0）
• 04/25/2022:
  • 在控制台输出中显示退出代码
  • 修复健康检查问题
  • 更新至最新Rclone（v1.58.0）
• 11/18/2021:
  • 更新至最新Rclone（v1.57.0）
• 10/04/2021:
  • 更新至最新Rclone（v1.56.2）
• 09/27/2021:
  • 更新至最新Rclone（v1.56.1）
• 08/25/2021:
  • 更新至最新Rclone（v1.56.0）
• 06/25/2021:
  • 更新至最新Rclone（v1.55.1）
• 06/25/2021:
  • 更新至最新Rclone（v1.55.0）
• 03/10/2021:
  • 更新至最新Rclone（v1.54.1）
• 02/04/2021:
  • 更新至最新Rclone（v1.54.0）
• 11/23/2020:
  • 更新至最新Rclone（v1.53.3）
• 10/28/2020:
  • 更新至最新Rclone（v1.53.2）
• 09/13/2020:
  • 更新至最新Rclone（v1.53.1）
• 09/05/2020:
  • 更新至最新Rclone（v1.53.0）
• 08/31/2020:
  • 添加将日志数据发送到healthchecks.io的功能 - 参见HC_LOG环境变量
• 08/20/2020:
  • 更新至最新Rclone（v1.52.3）
• 06/25/2020:
  • 更新至最新Rclone（v1.52.2）
• 06/11/2020:
  • 更新至最新Rclone（v1.52.1）
• 05/28/2020:
  • 对整个rclone命令进行求值
  • 修改检查源目录是否为空时对rclone错误的解释方式
• 05/27/2020:
  • 更新至最新Rclone（v1.52.0）
  • 添加RCLONE_DIR_CMD_DEPTH选项，用于声明检查SYNC_SRC是否为空时的递归深度
  • 将healthchecks.io开始信号调用移至同步过程的更早阶段
  • 更改日志删除时间，确保不删除活动日志
• 05/18/2020:
  • 修改将结果传递给healthchecks.io时对rclone错误的解释方式
• 05/17/2020:
  • 处理SYNC_SRC和SYNC_DEST中的空格
• 02/01/2020:
  • 更新至最新Rclone（v1.51.0）
• 11/20/2019:
  • 更新至最新Rclone（v1.50.2）
• 11/18/2019:
  • 添加对UID/GID的支持
• 11/06/2019:
  • 更新至最新Rclone（v1.50.1）
• 10/27/2019:
  • 更新至最新Rclone（v1.50.0）
• 10/07/2019:
  • 更新至最新Rclone（v1.49.5）
• 10/01/2019:
  • 更新至最新Rclone（v1.49.4）
• 09/23/2019:
  • 添加环境变量SYNC_ONCE
• 09/19/2019:
  • 添加环境变量SYNC_OPTS_EVAL
• 09/17/2019:
  • 更新至最新Rclone（v1.49.3）
• 09/10/2019:
  • 修复日志轮转的回归问题
• 09/09/2019:
  • 更新至最新Rclone（v1.49.2）
• 08/29/2019:
  • 更新至最新Rclone（v1.49.1）
• 08/20/2019:
  • 添加healthchecks.io调用的开始命令
  • 添加healthchecks.io调用的调试消息
• 08/19/2019:
  • 修复无日志时的日志轮转问题
• 07/18/2019:
  • 优化Dockerfile
• 06/22/2019:
  • 更新至最新Rclone（v1.48.0）
• 05/01/2019:
  • 初始发布