Search…
Images
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."

Supported Architectures

Our images support multiple architectures such as x86-64, arm64 and armhf. We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.
Simply pulling lscr.io/linuxserver/rsnapshot 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
Tag
x86-64
amd64-latest
arm64
arm64v8-latest
armhf
arm32v7-latest

Application Setup

IMPORTANT NOTES:

After starting the container you will need to edit /config/rsnapshot.conf.
SNAPSHOT ROOT DIRECTORY
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.
BACKUP LEVELS / INTERVALS
rsnapshot retains backups based on configurations in this section. Please see the rsnapshot readme for more information.
BACKUP POINTS
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.

cron

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.

Usage

To help you get started creating a container from this image you can either use docker-compose or the docker cli.
1
---
2
version: "2.1"
3
services:
4
rsnapshot:
5
image: lscr.io/linuxserver/rsnapshot
6
container_name: rsnapshot
7
environment:
8
- PUID=1000
9
- PGID=1000
10
- TZ=America/New_York
11
volumes:
12
- </path/to/appdata/config>:/config
13
- </path/to/snapshots>:/.snapshots #optional
14
- </path/to/data>:/data #optional
15
restart: unless-stopped
Copied!
1
docker run -d \
2
--name=rsnapshot \
3
-e PUID=1000 \
4
-e PGID=1000 \
5
-e TZ=America/New_York \
6
-v </path/to/appdata/config>:/config \
7
-v </path/to/snapshots>:/.snapshots `#optional` \
8
-v </path/to/data>:/data `#optional` \
9
--restart unless-stopped \
10
lscr.io/linuxserver/rsnapshot
Copied!

Parameters

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.

Ports (-p)

Environment Variables (-e)

Env
Function
PUID=1000
for UserID - see below for explanation
PGID=1000
for GroupID - see below for explanation
TZ=America/New_York
Specify a timezone to use EG America/New_York

Volume Mappings (-v)

Volume
Function
/config
Contains all relevant configuration files.
/.snapshots
Storage location for all snapshots.
/data
Storage location for data to be backed up.
Miscellaneous Options

Environment variables from files (Docker secrets)

You can set any environment variable from a file by using a special prepend FILE__.
As an example:
1
-e FILE__PASSWORD=/run/secrets/mysecretpassword
Copied!
Will set the environment variable PASSWORD based on the contents of the /run/secrets/mysecretpassword file.

Umask for running applications

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.

User / Group Identifiers

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:
1
$ id username
2
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
Copied!

Docker Mods

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.

Support Info

  • 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

Versions

  • 10.10.21: - Rebase to alpine 3.14.
  • 20.08.20: - Initial Release.
Last modified 1mo ago