docker-rclone

Docker image to perform a rclone sync based on a cron schedule, with healthchecks.io monitoring.

rclone is a command line program to sync files and directories to and from:

• Google Drive
• Amazon S3
• Openstack Swift / Rackspace cloud files / Memset Memstore
• Dropbox
• Google Cloud Storage
• Amazon Drive
• Microsoft OneDrive
• Hubic
• Backblaze B2
• Yandex Disk
• SFTP
• FTP
• HTTP
• The local filesystem

Usage

Configure rclone

rclone needs a configuration file where credentials to access different storage provider are kept.

By default, this image uses a file /config/rclone.conf and a mounted volume may be used to keep that information persisted.

A first run of the container can help in the creation of the file, but feel free to manually create one.

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

Perform sync in a daily basis

A few environment variables allow you to customize the behavior of rclone:

Name	Required	Description
UID	True	set variable to specify user to run rclone as. Must also use GID.
GID	True	set variable to specify group to run rclone as. Must also use UID.
SYNC_SRC	True	source location for rclone sync/copy/move command. Directories with spaces should be wrapped in single quotes.
SYNC_DEST	True	destination location for rclone sync/copy/move command. Directories with spaces should be wrapped in single quotes.
SYNC_OPTS	False	additional options for rclone sync/copy/move command. Defaults to -v
SYNC_OPTS_EVAL	False	further additional options for rclone sync/copy/move command. The variables and commands in the string are first interpolated like in a shell. The interpolated string is appended to SYNC_OPTS. That means '--backup-dir /old`date -I`' first evaluates to '--backup-dir /old2019-09-12', which is then appended to SYNC_OPTS. The evaluation happens immediately before rclone is called.
SYNC_ONCE	False	set variable to only run the sync one time and then exit the container
RCLONE_CMD	False	set variable to sync copy or move when running rclone. Defaults to sync
RCLONE_DIR_CMD	False	set variable to ls or lsf for source directory check style. Defaults to ls
RCLONE_DIR_CMD_DEPTH	False	set the limit of the recursion depth to this. Defaults to -1 (rclone default)
RCLONE_DIR_CHECK_SKIP	False	set variable to skip source directory check before sync. Use with caution
CRON	False	crontab schedule 0 0 * * * to perform sync every midnight. Also supprorts cron shortcuts: @yearly @monthly @weekly @daily @hourly
CRON_ABORT	False	crontab schedule 0 6 * * * to abort sync at 6am
FORCE_SYNC	False	set variable to perform a sync upon boot
CHECK_URL	False	healthchecks.io url or similar cron monitoring to perform a GET after a successful sync
FAIL_URL	False	Fail URL to perform a GET after unsuccessful execution. By default this is CHECK_URL with appended "/fail" at the end
HC_LOG	False	set variable to send log data to healthchecks.io. OUTPUT_LOG must also be set.
HC_PROGRESS	False	set variable to send pings to healthchecks.io every minute.
OUTPUT_LOG	False	set variable to output log file to /logs
PRE_LOG_NAME		text to prepend to the log filename
ROTATE_LOG	False	set variable to delete logs older than specified days from /logs
TZ	False	set the timezone to use for the cron and log America/Chicago
SUCCESS_CODES	False	set variable to a space-separated list of return codes that are considered successful. If the return code matches any of these codes, the response will be marked as a success. Example: SUCCESS_CODES="0 8 10". Default value is 0

http://markdowntable.com/

When using UID/GID the config and/or logs directory must be writeable by this UID

$ 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

See rclone sync docs for source/dest syntax and additional options.

Changelog

• 09/03/2024:
  • Update to latest Rclone (v1.67.0)
• 07/06/2023:
  • Update to latest Rclone (v1.63.0)
• 07/18/2022:
  • Update to latest Rclone (v1.59.0)
• 04/25/2022:
  • Display exit code in console output
  • Fix issue with healthcheck
  • Update to latest Rclone (v1.58.0)
• 11/18/2021:
  • Update to latest Rclone (v1.57.0)
• 10/04/2021:
  • Update to latest Rclone (v1.56.2)
• 09/27/2021:
  • Update to latest Rclone (v1.56.1)
• 08/25/2021:
  • Update to latest Rclone (v1.56.0)
• 06/25/2021:
  • Update to latest Rclone (v1.55.1)
• 06/25/2021:
  • Update to latest Rclone (v1.55.0)
• 03/10/2021:
  • Update to latest Rclone (v1.54.1)
• 02/04/2021:
  • Update to latest Rclone (v1.54.0)
• 01/22/2021:
  • Update to latest Rclone (v1.53.4)
• 11/23/2020:
  • Update to latest Rclone (v1.53.3)
• 10/28/2020:
  • Update to latest Rclone (v1.53.2)
• 09/13/2020:
  • Update to latest Rclone (v1.53.1)
• 09/05/2020:
  • Update to latest Rclone (v1.53.0)
• 08/31/2020:
  • Add ability to send log data to healthchecks.io - See HC_LOG environment variable
• 08/20/2020:
  • Update to latest Rclone (v1.52.3)
• 06/25/2020:
  • Update to latest Rclone (v1.52.2)
• 06/11/2020:
  • Update to latest Rclone (v1.52.1)
• 05/28/2020:
  • Eval the entire rclone command
  • Modify how rclone errors are interpreted when checking if source directory is empty
• 05/27/2020:
  • Update to latest Rclone (v1.52.0)
  • Add RCLONE_DIR_CMD_DEPTH option to declare recursion depth when checking if SYNC_SRC is empty
  • Move call to signal start of healthchecks.io further up in the sync process
  • Change when logs are deleted to make sure an active log is not deleted
• 05/18/2020:
  • Modify how rclone errors are interpreted when passing results to healthchecks.io
• 05/17/2020:
  • Handle spaces in SYNC_SRC and SYNC_DEST
• 02/01/2020:
  • Update to latest Rclone (v1.51.0)
• 11/20/2019:
  • Update to latest Rclone (v1.50.2)
• 11/18/2019:
  • Add support for UID/GID
• 11/06/2019:
  • Update to latest Rclone (v1.50.1)
• 10/27/2019:
  • Update to latest Rclone (v1.50.0)
• 10/07/2019:
  • Update to latest Rclone (v1.49.5)
• 10/01/2019:
  • Update to latest Rclone (v1.49.4)
• 09/23/2019:
  • Add environment variable SYNC_ONCE
• 09/19/2019:
  • Add environment variable SYNC_OPTS_EVAL
• 09/17/2019:
  • Update to latest Rclone (v1.49.3)
• 09/10/2019:
  • Regression on log rotation
• 09/09/2019:
  • Update to latest Rclone (v1.49.2)
• 08/29/2019:
  • Update to latest Rclone (v1.49.1)
• 08/20/2019:
  • Add start command for healthchecks.io calls
  • Add debug messages for healthchecks.io calls
• 08/19/2019:
  • Correct log rotation when there are no logs
• 07/18/2019:
  • Optimizations to dockerfile
• 06/22/2019:
  • Update to latest Rclone (v1.48.0)
• 05/01/2019:
  • Initial release

Credit to Brian J. Cardiff for the orginal project @ https://github.com/bcardiff/docker-rclone