/docker-resilio-sync

Primary LanguageDockerfile

linuxserver.io

The LinuxServer.io team brings you another container release featuring easy user mapping and community support. Find us for support at:

  • forum.linuxserver.io
  • IRC on freenode at #linuxserver.io
  • Podcast covers everything to do with getting the most from your Linux Server plus a focus on all things Docker and containerisation!

linuxserver/resilio-sync

Docker PullsDocker StarsBuild Status

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.

resilio-sync

Usage

docker run -d \
  --name=resilio-sync \
  -v <path to config>:/config \
  -v <path to data>:/sync \
  -v <path to downloads>:/downloads \
  -e PGID=<gid> -e PUID=<uid> \
  -e TZ=<timezone> \
  -e UMASK_SET=<022> \
  -p 8888:8888 \
  -p 55555:55555 \
  linuxserver/resilio-sync

Parameters

The parameters are split into two halves, separated by a colon, the left hand side representing the host and the right the container side. For example with a port -p external:internal - what this shows is the port mapping from internal to external of the container. So -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 http://192.168.x.x:8080 would show you what's running INSIDE the container on port 80.

  • -p 8888 -p 55555 - the port(s) required to access the app
  • -v /config - contains the settings
  • -v /sync - sync folders root
  • -v /downloads - folder for downloads/cache
  • -e TZ for timezone information eg Europe/London, etc
  • -e PGID for GroupID - see below for explanation
  • -e PUID for UserID - see below for explanation
  • -e UMASK_SET for umask setting of resilio-sync, default if left unset is 022.

This container is based on ubuntu xenial with s6 overlay, for shell access whilst the container is running do docker exec -it resilio-sync /bin/bash.

User / Group Identifiers

Sometimes when using data 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 the data volume directory on the host is owned by the same user you specify and it will "just work" ™.

In this instance PUID=1001 and PGID=1001. To find yours use id user as below:

  $ id <dockeruser>
    uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)

Setting up the application

  • Webui is at <your-ip>:8888, for account creation and configuration.
  • More info on setup at Resilio Sync

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" }}' linuxserver/resilio-sync

Versions

  • 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.