linuxserver/rsnapshot
Rsnapshot is a filesystem snapshot utility based on rsync. rsnapshot makes it easy to make periodic snapshots of local machines, and remote machines over ssh. The code makes extensive use of hard links whenever possible, to greatly reduce the disk space required."
Simply pulling
lscr.io/linuxserver/rsnapshot:latest should retrieve the correct image for your arch, but you can also pull specific arch images via tags.The architectures supported by this image are:
Architecture | Available | Tag |
|---|---|---|
x86-64 | ✅ | amd64-<version tag> |
arm64 | ✅ | arm64v8-<version tag> |
armhf | ✅ | arm32v7-<version tag> |
After starting the container you will need to edit
/config/rsnapshot.conf.rsnapshot is configured to backup data to the
/.snapshots volume by default. This can be changed in the config, but be sure you mount a volume to the container to match.rsnapshot retains backups based on configurations in this section. Please see the rsnapshot readme for more information.
rsnapshot is configured to backup data from the
/data volume by default. This can be changed in the config, but be sure you mount a volume to the container to match.You will then need to edit
/config/crontabs/root to set cron jobs to run rsnapshot. By default no cron jobs are enabled. Examples are includes based on information from the rsnapshot readme.To help you get started creating a container from this image you can either use docker-compose or the docker cli.
---
version: "2.1"
services:
rsnapshot:
image: lscr.io/linuxserver/rsnapshot:latest
container_name: rsnapshot
environment:
- PUID=1000
- PGID=1000
- TZ=Etc/UTC
volumes:
- /path/to/appdata:/config
- /path/to/snapshots:/.snapshots #optional
- /path/to/data:/data #optional
restart: unless-stopped
docker run -d \
--name=rsnapshot \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=Etc/UTC \
-v /path/to/appdata:/config \
-v /path/to/snapshots:/.snapshots `#optional` \
-v /path/to/data:/data `#optional` \
--restart unless-stopped \
lscr.io/linuxserver/rsnapshot:latest
Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate
<external>:<internal> respectively. For example, -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 outside the container.Env | Function |
|---|---|
PUID=1000 | for UserID - see below for explanation |
PGID=1000 | for GroupID - see below for explanation |
TZ=Etc/UTC |
Volume | Function |
|---|---|
/config | Contains all relevant configuration files. |
/.snapshots | Storage location for all snapshots. |
/data | Storage location for data to be backed up. |
You can set any environment variable from a file by using a special prepend
FILE__.As an example:
-e FILE__PASSWORD=/run/secrets/mysecretpassword
Will set the environment variable
PASSWORD based on the contents of the /run/secrets/mysecretpassword file.For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional
-e UMASK=022 setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up here before asking for support.When using volumes (
-v flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user PUID and group PGID.Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
In this instance
PUID=1000 and PGID=1000, to find yours use id user as below: $ id username
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.
- Shell access whilst the container is running:
docker exec -it rsnapshot /bin/bash
- To monitor the logs of the container in realtime:
docker logs -f rsnapshot
- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' rsnapshot
- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/rsnapshot:latest
- 02.03.23: - Split cron into separate init step and set crontab permissions.
- 15.12.22: - Rebase to alpine 3.17.
- 11.10.22: - Rebase to alpine 3.16, migrate to s6v3.
- 10.10.21: - Rebase to alpine 3.14.
- 20.08.20: - Initial Release.
Last modified 5d ago