Rclone Backup

This tool supports backing up the following files or directories.

• Any directory you specify
• PostgreSQL databases

And the following ways of notifying backup results are supported.

• Ping (only send on success)
• Mail (SMTP based, send on success and on failure)

Usage

Configure Rclone (⚠️ MUST READ ⚠️)

You need to configure Rclone first, otherwise the backup tool will not work.

We upload the backup files to the storage system by Rclone.

Visit GitHub for more storage system tutorials. Different systems get tokens differently.

Configure and Check

You can get the token by the following command.

docker run --rm -it \
 --mount type=volume,source=rclone-backup-data,target=/config/rclone \
 teldrive/rclone-backup:latest \
 rclone config

We recommend setting the remote name to RcloneBackup, otherwise you need to specify the environment variable RCLONE_REMOTE_NAME as the remote name you set.

After setting, check the configuration content by the following command.

docker run --rm -it \
 --mount type=volume,source=rclone-backup-data,target=/config/rclone \
 teldrive/rclone-backup:latest \
 rclone config show
# AWS S3 Example
# [RcloneBackup]
# type = s3
# provider = AWS
# access_key_id = <key>
# secret_access_key = <key>
# region = us-east-1
# location_constraint = us-east-1
# acl = private
# server_side_encryption = AES256
# storage_class = INTELLIGENT_TIERING
# bucket_acl = private
# no_check_bucket = true

Download docker-compose.yml to you machine, edit environment variables and start it.

You need to go to the directory where the docker-compose.yml file is saved.

Options

Environment Variables

Note: All environment variables have default values, you can use the docker image without setting any environment variables.

RCLONE_REMOTE_NAME

The name of the Rclone remote, which needs to be consistent with the remote name in the rclone config.

You can view the current remote name with the following command.

docker run --rm -it \
 --mount type=volume,source=rclone-backup-data,target=/config/rclone \
 teldrive/rclone-backup:latest \
 rclone config show
# [RcloneBackup] <- this
# ...

Default: RcloneBackup

RCLONE_REMOTE_DIR

The folder where backup files are stored in the storage system.

Default: /RcloneBackup/

RCLONE_GLOBAL_FLAG

Rclone global flags, see flags.

Do not add flags that will change the output, such as -P, which will affect the deletion of outdated backup files.

Default: ''

CRON

Schedule to run the backup script, based on supercronic. You can test the rules here.

Default: 5 * * * * (run the script at 5 minute every hour)

BACKUP_FOLDER_NAME

Name of the folder to back up, eg data.

Default: data

BACKUP_FOLDER_PATH

Path of the folder to back up, eg /data/

Default: /data

Multiple folders can be backed up by doing the following, with the same syntax as multiple remotes:

BACKUP_FOLDER_NAME_1: first-folder
BACKUP_FOLDER_PATH_1: /first
BACKUP_FOLDER_NAME_2: second-folder
BACKUP_FOLDER_PATH_2: /second

ZIP_ENABLE

Pack all backup files into a compressed file. When set to 'FALSE', each backup file will be uploaded independently.

Default: TRUE

ZIP_PASSWORD

The password for the compressed file. Note that the password will always be used when packing the backup files.

Default: 123456

ZIP_TYPE

Because the zip format is less secure, we offer archives in 7z format for those who seek security.

Default: zip (only support zip and 7z formats)

BACKUP_KEEP_DAYS

Only keep last a few days backup files in the storage system. Set to 0 to keep all backup files.

Default: 0

BACKUP_FILE_SUFFIX

Each backup file is suffixed by default with %Y%m%d. If you back up your vault multiple times a day, that suffix is not unique anymore. This environment variable allows you to append a unique suffix to that date to create a unique backup name.

You can use any character except for / since it cannot be used in Linux file names.

This environment variable combines the functionalities of BACKUP_FILE_DATE and BACKUP_FILE_DATE_SUFFIX, and has a higher priority. You can directly use this environment variable to control the suffix of the backup files.

Please use the date man page for the format notation.

Default: %Y%m%d

TIMEZONE

Set your timezone name.

Here is timezone list at wikipedia.

Default: UTC

PING_URL

Use healthcheck.io url or similar cron monitoring to perform GET requests after a successful backup.

MAIL_SMTP_ENABLE

Default: FALSE

MAIL_SMTP_VARIABLES

Because the configuration for sending emails is too complicated, we allow you to configure it yourself.

We will set the subject according to the usage scenario, so you should not use the -s option.

During testing, we will add the -v option to display detailed information.

# My example:
# For Zoho
-S smtp-use-starttls \
-S smtp=smtp://smtp.zoho.com:587 \
-S smtp-auth=login \
-S smtp-auth-user=<my-email-address> \
-S smtp-auth-password=<my-email-password> \
-S from=<my-email-address>

Console showing warnings? Check issue #177 for more details.

MAIL_TO

This specifies the recipient of the notification email.

MAIL_WHEN_SUCCESS

Sends an email when the backup is successful.

Default: TRUE

MAIL_WHEN_FAILURE

Sends an email when the backup fails.

Default: TRUE

Using .env file

If you prefer using an env file instead of environment variables, you can map the env file containing the environment variables to the /.env file in the container.

docker run -d \
 --mount type=bind,source=/path/to/env,target=/.env \
 teldrive/rclone-backup:latest

Docker Secrets

As an alternative to passing sensitive information via environment variables, _FILE may be appended to the previously listed environment variables. This causes the initialization script to load the values for those variables from files present in the container. In particular, this can be used to load passwords from Docker secrets stored in /run/secrets/<secret_name> files.

docker run -d \
 -e ZIP_PASSWORD_FILE=/run/secrets/zip-password \
 teldrive/rclone-backup:latest

About Priority

We will use the environment variables first, followed by the contents of the file ending in _FILE as defined by the environment variables. Next, we will use the contents of the file ending in _FILE as defined in the .env file, and finally the values from the .env file itself.

Mail Test

You can use the following command to test mail sending. Remember to replace your SMTP variables.

docker run --rm -it -e MAIL_SMTP_VARIABLES='<your smtp variables>'teldrive/rclone-backup:latest mail <mail send to>
# Or
docker run --rm -it -e MAIL_SMTP_VARIABLES='<your smtp variables>' -e MAIL_TO='<mail send to>'teldrive/rclone-backup:latest mail

Advanced

• Run as non-root user
• Multiple remote destinations
• Manually trigger a backup
• Using the PostgreSQL backend

Changelog

Check out the CHANGELOG file.

License

MIT