Run automatic restic backups via a Docker container.
- run scheduled backups
- backup to any (local or remote) target supported by restic
- add custom tags to backups
- automatic forgetting of old backups
- can be used as a (global) Docker swarm service in order to backup every cluster node
- multi-arch: the image
mazzolino/restic
runs onamd64
as well asarmv7
(for now)
Use the supplied example configs to set up a backup schedule.
Adjust the supplied docker-compose.yml as needed. Then run:
docker-compose up -d
Adjust the supplied docker-swarm.yml as needed. Then deploy it as a stack:
docker stack deploy -f docker-swarm.yml backup
You can use the same config to run any restic command with the given configuration.
When using the Docker Compose setup:
docker-compose run --rm app <RESTIC ARGS>
E.g.
docker-compose run --rm app snapshots
BACKUP_CRON
- A cron expression for when to run the backup. E.g.0 30 3 * * *
in order to run every night at 3:30 am. See the go-cron documentation for details on the expression formatRESTIC_REPOSITORY
- location of the restic repository. You can use any target supported by restic. Default/mnt/restic
RESTIC_BACKUP_SOURCES
- source directory to backup. Make sure to mount this into the container as a volume (see the example configs). Default/data
RESTIC_PASSWORD
- password for the restic repository. Will also be used to initialize the repository if it is not yet initializedRESTIC_BACKUP_TAGS
- Optional. Tags to set on each snapshot, separated by commas. E.g.swarm,docker-volumes
RESTIC_FORGET_ARGS
- Optional. If specifiedrestic forget
is run with the given arguments after each backup. E.g.--prune --keep-last 14 --keep-daily 1
- (Additional variables as needed for the chosen backup target. E.g.
B2_ACCOUNT_ID
andB2_ACCOUNT_KEY
for Backblaze B2.) TZ
- Optional. Set your timezone for the correct cron execution time.
In order to use rclone
repository type, you need to prepare a rclone.conf
file and mount it inside the container to /root/.config/rclone/rclone.conf
.
It's possible to optionally execute commands (like database dumps, or stopping a running container to avoid inconsistent backup data) before the actual backup starts. If you want to execute docker
commands on the host, mount the Docker socket to the container. To do that add the following volume to the compose or swarm configuration:
- /var/run/docker.sock:/var/run/docker.sock
You can add one or multiple commands by specifying the following environment variable:
PRE_COMMANDS: |-
docker exec nextcloud-postgres pg_dumpall -U nextcloud -f /data/nextcloud.sql
docker exec other-postgres pg_dumpall -U other -f /data/other.sql
docker stop my_container
The commands specified in PRE_COMMANDS
are executed one by one.
It's possible to optionally execute commands (like restarting a temporarily stopped container, send a mail...) once the actual backup has finished. Like for pre-backup commands, if you want to execute docker
commands on the host, mount the Docker socket to the container.
You can add one or multiple commands by specifying the following environment variables:
POST_COMMANDS_SUCCESS: |-
/my/scripts/mail-success.sh
POST_COMMANDS_FAILURE: |-
/my/scripts/mail-failure.sh
POST_COMMANDS_EXIT: |-
docker start my_container
The commands specified are executed one by one.
POST_COMMANDS_SUCCESS
commands will be executed after a successful backup run.POST_COMMANDS_FAILURE
commande will be executed after a failed backup run.POST_COMMANDS_EXIT
will always be executed, after both successful or failed backup runs.
Use the supplied Makefile in order to build your own image:
make image IMAGE=myuser/restic
You can also push images and build on a different architecture:
make image IMAGE=myuser/restic ARCH=arm
For more targets, see the Makefile.
restic-backup-docker was used as a starting point. Thanks!