2021-02-14 01:28:59 +00:00
---
title: resilio-sync
---
2023-10-09 23:29:06 +00:00
<!-- DO NOT EDIT THIS FILE MANUALLY -->
<!-- Please read https://github.com/linuxserver/docker - resilio - sync/blob/master/.github/CONTRIBUTING.md -->
2020-07-02 11:52:51 +00:00
# [linuxserver/resilio-sync](https://github.com/linuxserver/docker-resilio-sync)
2019-02-17 20:53:21 +00:00
2021-12-19 01:58:34 +00:00
[![Scarf.io pulls ](https://scarf.sh/installs-badge/linuxserver-ci/linuxserver%2Fresilio-sync?color=94398d&label-color=555555&logo-color=ffffff&style=for-the-badge&package-type=docker )](https://scarf.sh/gateway/linuxserver-ci/docker/linuxserver%2Fresilio-sync)
2020-07-02 11:52:51 +00:00
[![GitHub Stars ](https://img.shields.io/github/stars/linuxserver/docker-resilio-sync.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github )](https://github.com/linuxserver/docker-resilio-sync)
[![GitHub Release ](https://img.shields.io/github/release/linuxserver/docker-resilio-sync.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github )](https://github.com/linuxserver/docker-resilio-sync/releases)
[![GitHub Package Repository ](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitHub%20Package&logo=github )](https://github.com/linuxserver/docker-resilio-sync/packages)
2020-12-16 21:17:58 +00:00
[![GitLab Container Registry ](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab )](https://gitlab.com/linuxserver.io/docker-resilio-sync/container_registry)
2021-10-03 01:53:07 +00:00
[![Quay.io ](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=Quay.io )](https://quay.io/repository/linuxserver.io/resilio-sync)
2020-07-02 11:52:51 +00:00
[![Docker Pulls ](https://img.shields.io/docker/pulls/linuxserver/resilio-sync.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pulls&logo=docker )](https://hub.docker.com/r/linuxserver/resilio-sync)
[![Docker Stars ](https://img.shields.io/docker/stars/linuxserver/resilio-sync.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=stars&logo=docker )](https://hub.docker.com/r/linuxserver/resilio-sync)
[![Jenkins Build ](https://img.shields.io/jenkins/build?labelColor=555555&logoColor=ffffff&style=for-the-badge&jobUrl=https%3A%2F%2Fci.linuxserver.io%2Fjob%2FDocker-Pipeline-Builders%2Fjob%2Fdocker-resilio-sync%2Fjob%2Fmaster%2F&logo=jenkins )](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-resilio-sync/job/master/)
2020-11-02 05:52:32 +00:00
[![LSIO CI ](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=CI&query=CI&url=https%3A%2F%2Fci-tests.linuxserver.io%2Flinuxserver%2Fresilio-sync%2Flatest%2Fci-status.yml )](https://ci-tests.linuxserver.io/linuxserver/resilio-sync/latest/index.html)
2019-02-17 20:53:21 +00:00
2020-07-02 11:52:51 +00:00
[Resilio-sync ](https://www.resilio.com/individuals/ ) (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.
2019-02-17 20:53:21 +00:00
2023-10-09 23:29:06 +00:00
[![resilio-sync ](https://www.resilio.com/img/individual/freeproduct.jpg )](https://www.resilio.com/individuals/)
2019-02-17 20:53:21 +00:00
## Supported Architectures
2023-11-20 23:27:08 +00:00
We utilise the docker manifest for multi-platform awareness. More information is available from docker [here ](https://distribution.github.io/distribution/spec/manifest-v2-2/#manifest-list ) and our announcement [here ](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/ ).
2019-02-17 20:53:21 +00:00
2022-05-01 03:07:22 +00:00
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.
2019-02-17 20:53:21 +00:00
The architectures supported by this image are:
2022-05-01 03:07:22 +00:00
| Architecture | Available | Tag |
| :----: | :----: | ---- |
| x86-64 | ✅ | amd64-\<version tag\> |
| arm64 | ✅ | arm64v8-\<version tag\> |
2023-07-03 23:33:46 +00:00
| armhf | ❌ | |
2019-02-17 20:53:21 +00:00
2021-04-18 02:00:25 +00:00
## Application Setup
* Webui is at `<your-ip>:8888` , for account creation and configuration.
* More info on setup at [Resilio Sync ](https://www.resilio.com/individuals/ )
2020-07-02 11:52:51 +00:00
2019-02-17 20:53:21 +00:00
## Usage
2021-07-04 01:47:19 +00:00
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
2019-02-17 20:53:21 +00:00
2021-07-04 01:47:19 +00:00
### docker-compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose))
2019-02-17 20:53:21 +00:00
```yaml
---
services:
resilio-sync:
2022-05-01 03:07:22 +00:00
image: lscr.io/linuxserver/resilio-sync:latest
2019-02-17 20:53:21 +00:00
container_name: resilio-sync
environment:
2019-03-07 12:52:51 +00:00
- PUID=1000
- PGID=1000
2023-02-12 02:16:10 +00:00
- TZ=Etc/UTC
2019-02-17 20:53:21 +00:00
volumes:
2020-10-12 16:53:28 +00:00
- /path/to/config:/config
- /path/to/downloads:/downloads
- /path/to/data:/sync
2019-02-17 20:53:21 +00:00
ports:
- 8888:8888
- 55555:55555
restart: unless-stopped
```
2021-07-04 01:47:19 +00:00
### docker cli ([click here for more info](https://docs.docker.com/engine/reference/commandline/cli/))
2020-10-08 11:53:17 +00:00
2021-04-18 02:00:25 +00:00
```bash
2020-10-08 11:53:17 +00:00
docker run -d \
--name=resilio-sync \
-e PUID=1000 \
-e PGID=1000 \
2023-02-12 02:16:10 +00:00
-e TZ=Etc/UTC \
2020-10-08 11:53:17 +00:00
-p 8888:8888 \
-p 55555:55555 \
2020-10-12 16:53:28 +00:00
-v /path/to/config:/config \
-v /path/to/downloads:/downloads \
-v /path/to/data:/sync \
2020-10-08 11:53:17 +00:00
--restart unless-stopped \
2022-05-01 03:07:22 +00:00
lscr.io/linuxserver/resilio-sync:latest
2020-10-08 11:53:17 +00:00
```
2019-02-17 20:53:21 +00:00
## Parameters
2023-10-09 23:29:06 +00:00
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.
2019-02-17 20:53:21 +00:00
2020-07-02 11:52:51 +00:00
### Ports (`-p`)
2019-02-17 20:53:21 +00:00
| Parameter | Function |
2020-07-02 11:52:51 +00:00
| :----: | --- |
2019-02-17 20:53:21 +00:00
| `8888` | WebUI |
| `55555` | Sync Port. |
2020-07-02 11:52:51 +00:00
### Environment Variables (`-e`)
2019-02-17 20:53:21 +00:00
| Env | Function |
2020-07-02 11:52:51 +00:00
| :----: | --- |
2019-03-07 12:52:51 +00:00
| `PUID=1000` | for UserID - see below for explanation |
| `PGID=1000` | for GroupID - see below for explanation |
2023-02-12 02:16:10 +00:00
| `TZ=Etc/UTC` | specify a timezone to use, see this [list ](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List ). |
2019-02-17 20:53:21 +00:00
2020-07-02 11:52:51 +00:00
### Volume Mappings (`-v`)
2019-02-17 20:53:21 +00:00
| Volume | Function |
2020-07-02 11:52:51 +00:00
| :----: | --- |
2019-05-16 19:51:40 +00:00
| `/config` | Where resilio-sync should store its config file. |
2019-02-17 20:53:21 +00:00
| `/downloads` | Folder for downloads/cache. |
| `/sync` | Sync folders root. |
2021-10-03 01:53:07 +00:00
#### Miscellaneous Options
| Parameter | Function |
| :-----: | --- |
2020-07-02 11:52:51 +00:00
## Environment variables from files (Docker secrets)
2020-05-28 19:44:38 +00:00
You can set any environment variable from a file by using a special prepend `FILE__` .
As an example:
2021-04-18 02:00:25 +00:00
```bash
2023-10-09 23:29:06 +00:00
-e FILE__MYVAR=/run/secrets/mysecretvariable
2020-05-28 19:44:38 +00:00
```
2023-10-09 23:29:06 +00:00
Will set the environment variable `MYVAR` based on the contents of the `/run/secrets/mysecretvariable` file.
2020-05-28 19:44:38 +00:00
## Umask for running applications
2020-07-02 11:52:51 +00:00
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 ](https://en.wikipedia.org/wiki/Umask ) before asking for support.
2019-02-17 20:53:21 +00:00
## User / Group Identifiers
2020-07-02 11:52:51 +00:00
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` .
2019-02-17 20:53:21 +00:00
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
2023-10-09 23:29:06 +00:00
In this instance `PUID=1000` and `PGID=1000` , to find yours use `id your_user` as below:
2019-02-17 20:53:21 +00:00
2021-04-18 02:00:25 +00:00
```bash
2023-10-09 23:29:06 +00:00
id your_user
```
Example output:
```text
uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)
2019-02-17 20:53:21 +00:00
```
2020-04-09 11:53:05 +00:00
## Docker Mods
2021-04-18 02:00:25 +00:00
2020-10-08 11:53:17 +00:00
[![Docker Mods ](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=resilio-sync&query=%24.mods%5B%27resilio-sync%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml )](https://mods.linuxserver.io/?mod=resilio-sync "view available mods for this container.") [![Docker Universal Mods ](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=universal&query=%24.mods%5B%27universal%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml )](https://mods.linuxserver.io/?mod=universal "view available universal mods.")
2020-04-09 11:53:05 +00:00
2020-10-08 11:53:17 +00:00
We publish various [Docker Mods ](https://github.com/linuxserver/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.
2020-04-09 11:53:05 +00:00
2019-02-17 20:53:21 +00:00
## Support Info
2019-09-05 11:53:39 +00:00
* Shell access whilst the container is running:
2023-10-09 23:29:06 +00:00
```bash
docker exec -it resilio-sync /bin/bash
```
2019-09-05 11:53:39 +00:00
* To monitor the logs of the container in realtime:
2023-10-09 23:29:06 +00:00
```bash
docker logs -f resilio-sync
```
* Container version number:
```bash
docker inspect -f '{{ index .Config.Labels "build_version" }}' resilio-sync
```
* Image version number:
```bash
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/resilio-sync:latest
```
## Updating Info
2024-01-15 23:30:47 +00:00
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 ](#application-setup ) section above to see if it is recommended for the image.
2023-10-09 23:29:06 +00:00
Below are the instructions for updating containers:
### Via Docker Compose
* Update images:
* All images:
```bash
docker-compose pull
```
* Single image:
```bash
docker-compose pull resilio-sync
```
* Update containers:
* All containers:
```bash
docker-compose up -d
```
* Single container:
```bash
docker-compose up -d resilio-sync
```
* You can also remove the old dangling images:
```bash
docker image prune
```
### Via Docker Run
* Update the image:
```bash
docker pull lscr.io/linuxserver/resilio-sync:latest
```
* Stop the running container:
```bash
docker stop resilio-sync
```
* Delete the container:
```bash
docker rm resilio-sync
```
* 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:
```bash
docker image prune
```
### Image Update Notifications - Diun (Docker Image Update Notifier)
!!! tip
We recommend [Diun ](https://crazymax.dev/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:
```bash
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 using `multiarch/qemu-user-static`
```bash
docker run --rm --privileged multiarch/qemu-user-static:register --reset
```
Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64` .
2019-02-17 20:53:21 +00:00
## Versions
2023-07-03 23:33:46 +00:00
* **03.07.23:** - Deprecate armhf. As announced [here ](https://www.linuxserver.io/blog/a-farewell-to-arm-hf )
2022-12-16 15:01:25 +00:00
* **14.12.22:** - Rebase to Jammy, migrate to s6v3.
2021-10-04 02:41:10 +00:00
* **03.10.21:** - Use upstream apt repo to install. Rebase to focal.
2021-01-20 13:07:04 +00:00
* **20.01.21:** - Deprecate `UMASK_SET` in favor of UMASK in baseimage, see above for more information.
2019-03-25 00:11:06 +00:00
* **23.03.19:** - Switching to new Base images, shift to arm32v7 tag.
2019-02-17 20:53:21 +00:00
* **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.
2020-07-02 11:52:51 +00:00
* **14.05.17:** - Use fixed version instead of latest, while 2.5.0 is broken on non glibc (alpine).
2019-02-17 20:53:21 +00:00
* **08.02.17:** - Rebase to alpine 3.5.
* **02.11.16:** - Initial Release.