A docker image to automate backups, using rclone.
Comes with a script to back up a PostgreSQL database.
A simple backup script looks like this:
-
Dump some data (e.g. a database backup) to a directory on the local machine.
-
Compress this local directory and upload it to cloud storage.
-
Delete old / expired backups from cloud storage when they are no longer needed.
If you run this script periodically, you have a simple backup scheme.
rclone-backup uses this scheme. It is implemented as follows:
-
A backup script (
/usr/local/bin/backup.sh) is run as a dailycronjob. -
This backup script:
-
Runs any scripts found in the
/usr/local/bin/dump-backup.ddirectory (e.g. scripts which dump data to the backup directory). -
Archives and compresses the backup directory (default
/data/backup) and places it in/data/upload. -
Uploads the file in
/data/uploadto cloud storage using rclone. -
Uses a Tower of Hanoi backup rotation scheme to decide which backups to keep / delete on the cloud storage.
-
The rclone-backup container can be configured using environment variables:
-
Configuration for
backup.sh(see the file for details):BACKUP_FOLDER,REMOTE_PATH,BACKUP_COUNT,BACKUP_FILE_PREFIX,RCLONE_CONFIG,RCLONE_LOG_LEVEL. Most have sensible defaults set. -
Configuration for
dump-postgres.sh(see file for details):DUMP_DIRECTORY,DUMP_FILE_PREFIX,POSTGRES_PASSWORD,POSTGRES_HOST,POSTGRES_PORT,POSTGRES_USER,POSTGRES_DB.
Alternatively, you can customize the image by:
-
Adding "dump" scripts to the
/usr/local/bin/backup-dump.d/directory (seescriptsin this repository for an example). -
Modifying the
/usr/local/bin/backup.shscript. -
Modifying the crontabs in
/etc/crontabs/to use a different user and/or execute backups on a different schedule.
If the default crontab is used, the rclone user executes all scripts, so this user must have permission to execute scripts and create data dumps.
The stdout/stderr of all scripts are written to the stdout/stderr of the container by default.
See the License file for details.