linuxserver/resilio-sync¶
Resilio-sync (formerly BitTorrent Sync) uses the BitTorrent protocol to sync files and folders between all of your devices. There are both free and paid versions, this container supports both. There is an official sync image but we created this one as it supports user mapping to simplify permissions for volumes.
Supported Architectures¶
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/resilio-sync: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 | ❌ |
Application Setup¶
- Webui is at
<your-ip>:8888
, for account creation and configuration. - More info on setup at Resilio Sync
Usage¶
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
Info
Unless a parameter is flaged as 'optional', it is mandatory and a value must be provided.
docker-compose (recommended, click here for more info)¶
---
services:
resilio-sync:
image: lscr.io/linuxserver/resilio-sync:latest
container_name: resilio-sync
environment:
- PUID=1000
- PGID=1000
- TZ=Etc/UTC
volumes:
- /path/to/resilio-sync/config:/config
- /path/to/downloads:/downloads
- /path/to/data:/sync
ports:
- 8888:8888
- 55555:55555
restart: unless-stopped
docker cli (click here for more info)¶
docker run -d \
--name=resilio-sync \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=Etc/UTC \
-p 8888:8888 \
-p 55555:55555 \
-v /path/to/resilio-sync/config:/config \
-v /path/to/downloads:/downloads \
-v /path/to/data:/sync \
--restart unless-stopped \
lscr.io/linuxserver/resilio-sync:latest
Parameters¶
Containers 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
)¶
Parameter | Function |
---|---|
8888:8888 | WebUI |
55555:55555 | Sync Port. |
Environment Variables (-e
)¶
Env | Function |
---|---|
PUID=1000 | for UserID - see below for explanation |
PGID=1000 | for GroupID - see below for explanation |
TZ=Etc/UTC | specify a timezone to use, see this list. |
Volume Mappings (-v
)¶
Volume | Function |
---|---|
/config | Where resilio-sync should store its config file. |
/downloads | Folder for downloads/cache. |
/sync | Sync folders root. |
Miscellaneous Options¶
Parameter | Function |
---|---|
Environment variables from files (Docker secrets)¶
You can set any environment variable from a file by using a special prepend FILE__
.
As an example:
Will set the environment variable MYVAR
based on the contents of the /run/secrets/mysecretvariable
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 your_user
as below:
Example output:
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:
-
To monitor the logs of the container in realtime:
-
Container version number:
-
Image version number:
Updating Info¶
Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (noted in the relevant readme.md), we do not recommend or support updating apps inside the container. Please consult the Application Setup section above to see if it is recommended for the image.
Below are the instructions for updating containers:
Via Docker Compose¶
-
Update images:
-
All images:
-
Single image:
-
-
Update containers:
-
All containers:
-
Single container:
-
-
You can also remove the old dangling images:
Via Docker Run¶
-
Update the image:
-
Stop the running container:
-
Delete the container:
-
Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your
/config
folder and settings will be preserved) -
You can also remove the old dangling images:
Image Update Notifications - Diun (Docker Image Update Notifier)¶
Tip
We recommend Diun for update notifications. Other tools that automatically update containers unattended are not recommended or supported.
Building locally¶
If you want to make local modifications to these images for development purposes or just to customize the logic:
git clone https://github.com/linuxserver/docker-resilio-sync.git
cd docker-resilio-sync
docker build \
--no-cache \
--pull \
-t lscr.io/linuxserver/resilio-sync:latest .
The ARM variants can be built on x86_64 hardware and vice versa using lscr.io/linuxserver/qemu-static
Once registered you can define the dockerfile to use with -f Dockerfile.aarch64
.
Versions¶
- 21.08.24: - Rebase to Noble.
- 03.07.23: - Deprecate armhf. As announced here
- 14.12.22: - Rebase to Jammy, migrate to s6v3.
- 03.10.21: - Use upstream apt repo to install. Rebase to focal.
- 20.01.21: - Deprecate
UMASK_SET
in favor of UMASK in baseimage, see above for more information. - 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 11.02.19: - Rebase to bionic, add pipeline logic and multi arch.
- 05.02.18: - Add downloads volume mount.
- 28.01.18: - Add /sync to dir whitelist.
- 26.01.18: - Use variable for arch to bring in line with armhf arch repo.
- 15.12.17: - Fix continuation lines.
- 02.06.17: - Rebase to ubuntu xenial, alpine linux no longer works with resilio.
- 22.05.17: - Add variable for user defined umask.
- 14.05.17: - Use fixed version instead of latest, while 2.5.0 is broken on non glibc (alpine).
- 08.02.17: - Rebase to alpine 3.5.
- 02.11.16: - Initial Release.