kopia lustrzana https://github.com/linuxserver/docker-documentation
179 wiersze
9.5 KiB
Markdown
179 wiersze
9.5 KiB
Markdown
---
|
|
title: resilio-sync
|
|
---
|
|
<!-- DO NOT EDIT THIS FILE MANUALLY -->
|
|
<!-- Please read the https://github.com/linuxserver/docker-resilio-sync/blob/master/.github/CONTRIBUTING.md -->
|
|
|
|
# [linuxserver/resilio-sync](https://github.com/linuxserver/docker-resilio-sync)
|
|
|
|
[](https://scarf.sh/gateway/linuxserver-ci/docker/linuxserver%2Fresilio-sync)
|
|
[](https://github.com/linuxserver/docker-resilio-sync)
|
|
[](https://github.com/linuxserver/docker-resilio-sync/releases)
|
|
[](https://github.com/linuxserver/docker-resilio-sync/packages)
|
|
[](https://gitlab.com/linuxserver.io/docker-resilio-sync/container_registry)
|
|
[](https://quay.io/repository/linuxserver.io/resilio-sync)
|
|
[](https://hub.docker.com/r/linuxserver/resilio-sync)
|
|
[](https://hub.docker.com/r/linuxserver/resilio-sync)
|
|
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-resilio-sync/job/master/)
|
|
[](https://ci-tests.linuxserver.io/linuxserver/resilio-sync/latest/index.html)
|
|
|
|
[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.
|
|
|
|
## 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](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/).
|
|
|
|
Simply pulling `lscr.io/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 |
|
|
| :----: | --- |
|
|
| x86-64 | amd64-latest |
|
|
| arm64 | arm64v8-latest |
|
|
| armhf | arm32v7-latest |
|
|
|
|
## 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/)
|
|
|
|
## Usage
|
|
|
|
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
|
|
|
|
### docker-compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose))
|
|
|
|
```yaml
|
|
---
|
|
version: "2.1"
|
|
services:
|
|
resilio-sync:
|
|
image: lscr.io/linuxserver/resilio-sync
|
|
container_name: resilio-sync
|
|
environment:
|
|
- PUID=1000
|
|
- PGID=1000
|
|
- TZ=Europe/London
|
|
volumes:
|
|
- /path/to/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](https://docs.docker.com/engine/reference/commandline/cli/))
|
|
|
|
```bash
|
|
docker run -d \
|
|
--name=resilio-sync \
|
|
-e PUID=1000 \
|
|
-e PGID=1000 \
|
|
-e TZ=Europe/London \
|
|
-p 8888:8888 \
|
|
-p 55555:55555 \
|
|
-v /path/to/config:/config \
|
|
-v /path/to/downloads:/downloads \
|
|
-v /path/to/data:/sync \
|
|
--restart unless-stopped \
|
|
lscr.io/linuxserver/resilio-sync
|
|
```
|
|
|
|
## 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`)
|
|
|
|
| Parameter | Function |
|
|
| :----: | --- |
|
|
| `8888` | WebUI |
|
|
| `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=Europe/London` | Specify a timezone to use EG Europe/London. |
|
|
|
|
### 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:
|
|
|
|
```bash
|
|
-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
|
|
|
|
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.
|
|
|
|
## 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:
|
|
|
|
```bash
|
|
$ id username
|
|
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
|
|
```
|
|
|
|
## Docker Mods
|
|
|
|
[](https://mods.linuxserver.io/?mod=resilio-sync "view available mods for this container.") [](https://mods.linuxserver.io/?mod=universal "view available universal mods.")
|
|
|
|
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.
|
|
|
|
## Support Info
|
|
|
|
* Shell access whilst the container is running:
|
|
* `docker exec -it resilio-sync /bin/bash`
|
|
* To monitor the logs of the container in realtime:
|
|
* `docker logs -f resilio-sync`
|
|
* Container version number
|
|
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' resilio-sync`
|
|
* Image version number
|
|
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/resilio-sync`
|
|
|
|
## Versions
|
|
|
|
* **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.
|