phamquyhai / docker-rclone

Docker image to use rclone to run cron sync with monitoring

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 bcardiff/rclone

Perform sync in a daily basis

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

• SYNC_SRC source location for rclone sync command
• SYNC_DEST destination location for rclone sync command
• CRON crontab schedule 0 0 * * * to perform sync every midnight
• CRON_ABORT crontab schedule 0 6 * * * to abort sync at 6am
• FORCE_SYNC set variable to perform a sync upon boot
• CHECK_URL healthchecks.io url or similar cron monitoring to perform a GET after a successful sync
• SYNC_OPTS additional options for rclone sync command. Defaults to -v
• TZ set the timezone to use for the cron and log America/Argentina/Buenos_Aires

$ 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/Argentina/Buenos_Aires" -e CRON="0 0 * * *" -e CRON_ABORT="0 6 * * *" -e FORCE_SYNC=1 -e CHECK_URL=https://hchk.io/hchk_uuid bcardiff/rclone

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