2020-06-29 07:29:55 +00:00
# linuxserver/resilio-sync
2019-02-17 20:53:21 +00:00
2020-06-29 07:29:55 +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) [![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) [![MicroBadger Layers ](https://img.shields.io/microbadger/layers/linuxserver/resilio-sync.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge )](https://microbadger.com/images/linuxserver/resilio-sync) [![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/) [![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%2Flsio-ci.ams3.digitaloceanspaces.com%2Flinuxserver%2Fresilio-sync%2Flatest%2Fci-status.yml )](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/resilio-sync/latest/index.html)
2019-02-17 20:53:21 +00:00
2020-06-29 07:29:55 +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
## Supported Architectures
2019-09-05 11:53:39 +00:00
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 ](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#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
Simply pulling `linuxserver/resilio-sync` 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 |
2020-06-29 07:29:55 +00:00
| :---: | :--- |
2019-02-17 20:53:21 +00:00
| x86-64 | amd64-latest |
| arm64 | arm64v8-latest |
2019-03-25 00:11:06 +00:00
| armhf | arm32v7-latest |
2019-02-17 20:53:21 +00:00
## Usage
Here are some example snippets to help you get started creating a container from this image.
### docker
2020-06-29 07:29:55 +00:00
```text
2019-02-17 20:53:21 +00:00
docker create \
--name=resilio-sync \
2019-03-07 12:52:51 +00:00
-e PUID=1000 \
-e PGID=1000 \
2019-02-17 20:53:21 +00:00
-e TZ=Europe/London \
-e UMASK_SET=< 022 > \
-p 8888:8888 \
-p 55555:55555 \
-v < path to config > :/config \
-v < path to downloads > :/downloads \
-v < path to data > :/sync \
--restart unless-stopped \
linuxserver/resilio-sync
```
### docker-compose
Compatible with docker-compose v2 schemas.
```yaml
---
2020-04-09 11:53:05 +00:00
version: "2.1"
2019-02-17 20:53:21 +00:00
services:
resilio-sync:
image: linuxserver/resilio-sync
container_name: resilio-sync
environment:
2019-03-07 12:52:51 +00:00
- PUID=1000
- PGID=1000
2019-02-17 20:53:21 +00:00
- TZ=Europe/London
- UMASK_SET=< 022 >
volumes:
- < path to config > :/config
- < path to downloads > :/downloads
- < path to data > :/sync
ports:
- 8888:8888
- 55555:55555
restart: unless-stopped
```
## Parameters
2020-06-29 07:29:55 +00:00
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.
2019-02-17 20:53:21 +00:00
2020-06-29 07:29:55 +00:00
### Ports \(`-p`\)
2019-02-17 20:53:21 +00:00
| Parameter | Function |
2020-06-29 07:29:55 +00:00
| :---: | :--- |
2019-02-17 20:53:21 +00:00
| `8888` | WebUI |
| `55555` | Sync Port. |
2020-06-29 07:29:55 +00:00
### Environment Variables \(`-e`\)
2019-02-17 20:53:21 +00:00
| Env | Function |
2020-06-29 07:29:55 +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 |
2019-02-17 20:53:21 +00:00
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London. |
| `UMASK_SET=<022>` | For umask setting of resilio-sync, default if left unset is 022. |
2020-06-29 07:29:55 +00:00
### Volume Mappings \(`-v`\)
2019-02-17 20:53:21 +00:00
| Volume | Function |
2020-06-29 07:29:55 +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. |
2020-06-29 07:29:55 +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:
2020-06-29 07:29:55 +00:00
```text
2020-05-28 19:44:38 +00:00
-e FILE__PASSWORD=/run/secrets/mysecretpassword
```
Will set the environment variable `PASSWORD` based on the contents of the `/run/secrets/mysecretpassword` file.
## Umask for running applications
2020-06-29 07:29:55 +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.
2020-04-30 11:52:57 +00:00
2019-02-17 20:53:21 +00:00
## User / Group Identifiers
2020-06-29 07:29:55 +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.
2019-03-07 12:52:51 +00:00
In this instance `PUID=1000` and `PGID=1000` , to find yours use `id user` as below:
2019-02-17 20:53:21 +00:00
2020-06-29 07:29:55 +00:00
```text
2019-02-17 20:53:21 +00:00
$ id username
2019-03-07 12:52:51 +00:00
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
2019-02-17 20:53:21 +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-04-09 11:53:05 +00:00
## Docker Mods
2020-06-29 07:29:55 +00:00
[![Docker Mods ](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=mods&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)
2020-04-09 11:53:05 +00:00
2020-06-29 07:29:55 +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\) can be accessed via the dynamic badge above.
2019-10-03 11:52:56 +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:
2019-02-17 20:53:21 +00:00
* `docker exec -it resilio-sync /bin/bash`
2019-09-05 11:53:39 +00:00
* To monitor the logs of the container in realtime:
2019-02-17 20:53:21 +00:00
* `docker logs -f resilio-sync`
2019-09-05 11:53:39 +00:00
* Container version number
2019-02-17 20:53:21 +00:00
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' resilio-sync`
* Image version number
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/resilio-sync`
## Versions
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-06-29 07:29:55 +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.
2020-06-29 07:29:55 +00:00