From 69acb697b22ed5f2867e88c122236c747e952dcf Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Thu, 3 Oct 2019 12:52:56 +0100 Subject: [PATCH] Bot Updating Templated Files --- images/docker-resilio-sync.md | 44 ++++++++++++++++++++++------------- 1 file changed, 28 insertions(+), 16 deletions(-) diff --git a/images/docker-resilio-sync.md b/images/docker-resilio-sync.md index 26ce472a8c..ac9086236c 100644 --- a/images/docker-resilio-sync.md +++ b/images/docker-resilio-sync.md @@ -1,8 +1,14 @@ -# linuxserver/resilio-sync +# [linuxserver/resilio-sync](https://github.com/linuxserver/docker-resilio-sync) -[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-resilio-sync.svg?style=flat-square&color=E68523)](https://github.com/linuxserver/docker-resilio-sync/releases) [![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/resilio-sync.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/resilio-sync) [![MicroBadger Size](https://img.shields.io/microbadger/image-size/linuxserver/resilio-sync.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/resilio-sync) [![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/resilio-sync.svg?style=flat-square&color=E68523)](https://hub.docker.com/r/linuxserver/resilio-sync) [![Docker Stars](https://img.shields.io/docker/stars/linuxserver/resilio-sync.svg?style=flat-square&color=E68523)](https://hub.docker.com/r/linuxserver/resilio-sync) [![Build Status](https://ci.linuxserver.io/view/all/job/Docker-Pipeline-Builders/job/docker-resilio-sync/job/master/badge/icon?style=flat-square)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-resilio-sync/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/resilio-sync/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/resilio-sync/latest/index.html) +[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-resilio-sync.svg?style=flat-square&color=E68523)](https://github.com/linuxserver/docker-resilio-sync/releases) +[![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/resilio-sync.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/resilio-sync "Get your own version badge on microbadger.com") +[![MicroBadger Size](https://img.shields.io/microbadger/image-size/linuxserver/resilio-sync.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/resilio-sync "Get your own version badge on microbadger.com") +[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/resilio-sync.svg?style=flat-square&color=E68523)](https://hub.docker.com/r/linuxserver/resilio-sync) +[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/resilio-sync.svg?style=flat-square&color=E68523)](https://hub.docker.com/r/linuxserver/resilio-sync) +[![Build Status](https://ci.linuxserver.io/view/all/job/Docker-Pipeline-Builders/job/docker-resilio-sync/job/master/badge/icon?style=flat-square)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-resilio-sync/job/master/) +[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/resilio-sync/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/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. +[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 @@ -13,18 +19,19 @@ Simply pulling `linuxserver/resilio-sync` should retrieve the correct image for The architectures supported by this image are: | Architecture | Tag | -| :---: | :--- | +| :----: | --- | | x86-64 | amd64-latest | | arm64 | arm64v8-latest | | armhf | arm32v7-latest | + ## Usage Here are some example snippets to help you get started creating a container from this image. ### docker -```text +``` docker create \ --name=resilio-sync \ -e PUID=1000 \ @@ -40,6 +47,7 @@ docker create \ linuxserver/resilio-sync ``` + ### docker-compose Compatible with docker-compose v2 schemas. @@ -68,41 +76,44 @@ services: ## Parameters -Docker images are configured using parameters passed at runtime \(such as those above\). These parameters are separated by a colon and indicate `:` 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. +Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` 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`\) +### Ports (`-p`) | Parameter | Function | -| :---: | :--- | +| :----: | --- | | `8888` | WebUI | | `55555` | Sync Port. | -### Environment Variables \(`-e`\) + +### 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. | | `UMASK_SET=<022>` | For umask setting of resilio-sync, default if left unset is 022. | -### Volume Mappings \(`-v`\) +### Volume Mappings (`-v`) | Volume | Function | -| :---: | :--- | +| :----: | --- | | `/config` | Where resilio-sync should store its config file. | | `/downloads` | Folder for downloads/cache. | | `/sync` | Sync folders root. | + + ## 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`. +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: -```text +``` $ id username uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup) ``` @@ -112,6 +123,8 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel * Webui is at `:8888`, for account creation and configuration. * More info on setup at [Resilio Sync](https://www.resilio.com/individuals/) + + ## Support Info * Shell access whilst the container is running: @@ -133,7 +146,6 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel * **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\). +* **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. -