From 73f214e49a5b228b47b1292b66a942c828cf22e6 Mon Sep 17 00:00:00 2001 From: Josh Stark Date: Tue, 5 Feb 2019 19:09:56 +0000 Subject: [PATCH] GitBook: [master] 20 pages modified --- README.md | 13 ++- SUMMARY.md | 14 +-- {general-1 => general}/container-execution.md | 0 {general-1 => general}/containers-101.md | 0 {general-1 => general}/docker-compose.md | 0 .../running-our-containers.md | 0 .../understanding-puid-and-pgid.md | 0 .../updating-our-containers.md | 0 {general-1 => general}/volumes.md | 0 images/docker-minisatip.md | 87 ++++++++---------- images/docker-mylar.md | 92 +++++++++---------- images/docker-rutorrent.md | 53 ++++------- images/docker-syncthing.md | 89 +++++++++--------- 13 files changed, 163 insertions(+), 185 deletions(-) rename {general-1 => general}/container-execution.md (100%) rename {general-1 => general}/containers-101.md (100%) rename {general-1 => general}/docker-compose.md (100%) rename {general-1 => general}/running-our-containers.md (100%) rename {general-1 => general}/understanding-puid-and-pgid.md (100%) rename {general-1 => general}/updating-our-containers.md (100%) rename {general-1 => general}/volumes.md (100%) mode change 100755 => 100644 images/docker-minisatip.md mode change 100755 => 100644 images/docker-mylar.md mode change 100755 => 100644 images/docker-rutorrent.md mode change 100755 => 100644 images/docker-syncthing.md diff --git a/README.md b/README.md index fbd36cb85..340125871 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,15 @@ # Introduction -This is the home of all LinuxServer image documentation, including guides and knowledge sharing articles. +Welcome to the home of the LinuxServer.io documentation! It is our goal to ensure that all of our images are properly documented with all of the relevant information in order to help our users get started. As well as individual set up guides for each of our images, there is also general information pertaining to the running of Docker containers, and best practices. + +### Want to get hold of the team? + +The team resides primarily in our Discord server, where we have tried to foster a community of like-minded individuals who help those who need it. We also have a forum if chat isn't your thing. + +| Where | Link | +| :--- | :--- | +| Discord | [https://discord.gg/YWrKVTn](https://discord.gg/YWrKVTn) | +| Forum | [https://discourse.linuxserver.io](https://discourse.linuxserver.io) | + +We also have a public CI environment via Jenkins: [https://ci.linuxserver.io/](https://ci.linuxserver.io/) diff --git a/SUMMARY.md b/SUMMARY.md index 562e5e43a..dad2f7a24 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -4,13 +4,13 @@ ## General -* [Container Execution](general-1/container-execution.md) -* [Docker Containers: 101](general-1/containers-101.md) -* [Running LinuxServer Containers](general-1/running-our-containers.md) -* [Docker Compose](general-1/docker-compose.md) -* [Understanding PUID and PGID](general-1/understanding-puid-and-pgid.md) -* [Updating our containers](general-1/updating-our-containers.md) -* [Volumes](general-1/volumes.md) +* [Container Execution](general/container-execution.md) +* [Docker Containers: 101](general/containers-101.md) +* [Running LinuxServer Containers](general/running-our-containers.md) +* [Docker Compose](general/docker-compose.md) +* [Understanding PUID and PGID](general/understanding-puid-and-pgid.md) +* [Updating our containers](general/updating-our-containers.md) +* [Volumes](general/volumes.md) ## Images diff --git a/general-1/container-execution.md b/general/container-execution.md similarity index 100% rename from general-1/container-execution.md rename to general/container-execution.md diff --git a/general-1/containers-101.md b/general/containers-101.md similarity index 100% rename from general-1/containers-101.md rename to general/containers-101.md diff --git a/general-1/docker-compose.md b/general/docker-compose.md similarity index 100% rename from general-1/docker-compose.md rename to general/docker-compose.md diff --git a/general-1/running-our-containers.md b/general/running-our-containers.md similarity index 100% rename from general-1/running-our-containers.md rename to general/running-our-containers.md diff --git a/general-1/understanding-puid-and-pgid.md b/general/understanding-puid-and-pgid.md similarity index 100% rename from general-1/understanding-puid-and-pgid.md rename to general/understanding-puid-and-pgid.md diff --git a/general-1/updating-our-containers.md b/general/updating-our-containers.md similarity index 100% rename from general-1/updating-our-containers.md rename to general/updating-our-containers.md diff --git a/general-1/volumes.md b/general/volumes.md similarity index 100% rename from general-1/volumes.md rename to general/volumes.md diff --git a/images/docker-minisatip.md b/images/docker-minisatip.md old mode 100755 new mode 100644 index 000c060f6..051948e80 --- a/images/docker-minisatip.md +++ b/images/docker-minisatip.md @@ -1,27 +1,24 @@ -[linuxserverurl]: https://linuxserver.io -[forumurl]: https://forum.linuxserver.io -[ircurl]: https://www.linuxserver.io/irc/ -[podcasturl]: https://www.linuxserver.io/podcast/ -[appurl]: https://github.com/catalinii/minisatip -[hub]: https://hub.docker.com/r/linuxserver/minisatip/ - -[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)][linuxserverurl] - -The [LinuxServer.io][linuxserverurl] team brings you another container release featuring easy user mapping and community support. Find us for support at: -* [forum.linuxserver.io][forumurl] -* [IRC][ircurl] on freenode at `#linuxserver.io` -* [Podcast][podcasturl] covers everything to do with getting the most from your Linux Server plus a focus on all things Docker and containerisation! - # linuxserver/minisatip -[![](https://images.microbadger.com/badges/version/linuxserver/minisatip.svg)](https://microbadger.com/images/linuxserver/minisatip "Get your own version badge on microbadger.com")[![](https://images.microbadger.com/badges/image/linuxserver/minisatip.svg)](https://microbadger.com/images/linuxserver/minisatip "Get your own image badge on microbadger.com")[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/minisatip.svg)][hub][![Docker Stars](https://img.shields.io/docker/stars/linuxserver/minisatip.svg)][hub][![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Builders/x86-64/x86-64-minisatip)](https://ci.linuxserver.io/job/Docker-Builders/job/x86-64/job/x86-64-minisatip/) -[Minisatip][appurl] is a multi-threaded satip server version 1.2 that runs under Linux and it was tested with DVB-S, DVB-S2, DVB-T, DVB-T2, DVB-C, DVB-C2, ATSC and ISDB-T cards. +[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)](https://linuxserver.io) -[![minisatip](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/minisatip-icon.png)][appurl] +The [LinuxServer.io](https://linuxserver.io) team brings you another container release featuring easy user mapping and community support. Find us for support at: -## Usage +* [forum.linuxserver.io](https://forum.linuxserver.io) +* [IRC](https://www.linuxserver.io/irc/) on freenode at `#linuxserver.io` +* [Podcast](https://www.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/minisatip + +[![](https://images.microbadger.com/badges/version/linuxserver/minisatip.svg)](https://microbadger.com/images/linuxserver/minisatip)[![](https://images.microbadger.com/badges/image/linuxserver/minisatip.svg)](https://microbadger.com/images/linuxserver/minisatip)[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/minisatip.svg)](https://hub.docker.com/r/linuxserver/minisatip/)[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/minisatip.svg)](https://hub.docker.com/r/linuxserver/minisatip/)[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Builders/x86-64/x86-64-minisatip)](https://ci.linuxserver.io/job/Docker-Builders/job/x86-64/job/x86-64-minisatip/) + +[Minisatip](https://github.com/catalinii/minisatip) is a multi-threaded satip server version 1.2 that runs under Linux and it was tested with DVB-S, DVB-S2, DVB-T, DVB-T2, DVB-C, DVB-C2, ATSC and ISDB-T cards. + +[![minisatip](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/minisatip-icon.png)](https://github.com/catalinii/minisatip) + +### Usage + +```text docker create \ --name=minisatip \ -e PGID= -e PUID= \ @@ -33,17 +30,13 @@ docker create \ linuxserver/minisatip ``` -## Parameters +### 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.` +`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 8875` - the port(s) -* `-p 554` - the port(s) -* `-p 1900/udp` - the port(s) +* `-p 8875` - the port\(s\) +* `-p 554` - the port\(s\) +* `-p 1900/udp` - the port\(s\) * `-v /config` - * `-e PGID` for GroupID - see below for explanation * `-e PUID` for UserID - see below for explanation @@ -53,33 +46,32 @@ http://192.168.x.x:8080 would show you what's running INSIDE the container on po It is based on alpine with s6 overlay, for shell access whilst the container is running do `docker exec -it minisatip /bin/bash`. -### User / Group Identifiers +#### 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" ™. +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: -``` +```text $ id uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup) ``` -### Additional runtime parameters +#### Additional runtime parameters -In some cases it might be necessary to start minisatip with additional parameters, for example to configure a unicable LNB. Add the parameters you need and restart the container. Be sure to have the right parameters set as adding the wrong once might lead to the container not starting correctly. -For a list of minisatip parameters visit [minisatip][appurl] page. +In some cases it might be necessary to start minisatip with additional parameters, for example to configure a unicable LNB. Add the parameters you need and restart the container. Be sure to have the right parameters set as adding the wrong once might lead to the container not starting correctly. For a list of minisatip parameters visit [minisatip](https://github.com/catalinii/minisatip) page. + +### Setting up the application -## Setting up the application Best used in conjunction with [tvheadend](https://github.com/linuxserver/docker-tvheadend) There is no setup per se, other than adding your cards for passthrough. You can then use your cards as DVB inputs in apps such as tvheadend. -## Info +### Info * To monitor the logs of the container in realtime `docker logs -f minisatip`. - * container version number `docker inspect -f '{{ index .Config.Labels "build_version" }}' minisatip` @@ -88,14 +80,15 @@ You can then use your cards as DVB inputs in apps such as tvheadend. `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/minisatip` -## Versions +### Versions + +* **28.08.18:** Rebase to Alpine 3.8. +* **13.12.17:** Rebase to Alpine 3.7. +* **28.05.17:** Rebase to Alpine 3.6. +* **08.02.17:** Rebase to Alpine 3.5 and only compile libs in dvb-apps. +* **14.10.16:** Add version layer information. +* **18.09.16:** Add support for Common Interface. +* **11.09.16:** Add layer badges to README. +* **28.08.16:** Add badges to README. +* **15.08.16:** Initial Release. -+ **28.08.18:** Rebase to Alpine 3.8. -+ **13.12.17:** Rebase to Alpine 3.7. -+ **28.05.17:** Rebase to Alpine 3.6. -+ **08.02.17:** Rebase to Alpine 3.5 and only compile libs in dvb-apps. -+ **14.10.16:** Add version layer information. -+ **18.09.16:** Add support for Common Interface. -+ **11.09.16:** Add layer badges to README. -+ **28.08.16:** Add badges to README. -+ **15.08.16:** Initial Release. diff --git a/images/docker-mylar.md b/images/docker-mylar.md old mode 100755 new mode 100644 index ce88a3087..82321c78b --- a/images/docker-mylar.md +++ b/images/docker-mylar.md @@ -1,27 +1,24 @@ -[linuxserverurl]: https://linuxserver.io -[forumurl]: https://forum.linuxserver.io -[ircurl]: https://www.linuxserver.io/irc/ -[podcasturl]: https://www.linuxserver.io/podcast/ -[appurl]: https://github.com/evilhero/mylar -[hub]: https://hub.docker.com/r/linuxserver/mylar/ - -[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)][linuxserverurl] - -The [LinuxServer.io][linuxserverurl] team brings you another container release featuring easy user mapping and community support. Find us for support at: -* [forum.linuxserver.io][forumurl] -* [IRC][ircurl] on freenode at `#linuxserver.io` -* [Podcast][podcasturl] covers everything to do with getting the most from your Linux Server plus a focus on all things Docker and containerisation! - # linuxserver/mylar -[![](https://images.microbadger.com/badges/version/linuxserver/mylar.svg)](https://microbadger.com/images/linuxserver/mylar "Get your own version badge on microbadger.com")[![](https://images.microbadger.com/badges/image/linuxserver/mylar.svg)](https://microbadger.com/images/linuxserver/mylar "Get your own image badge on microbadger.com")[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/mylar.svg)][hub][![Docker Stars](https://img.shields.io/docker/stars/linuxserver/mylar.svg)][hub][![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Builders/x86-64/x86-64-mylar)](https://ci.linuxserver.io/job/Docker-Builders/job/x86-64/job/x86-64-mylar/) -An automated Comic Book downloader (cbr/cbz) for use with SABnzbd, NZBGet and torrents. [mylar](https://github.com/evilhero/mylar) +[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)](https://linuxserver.io) -[![mylar](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/mylar-icon.png)][appurl] +The [LinuxServer.io](https://linuxserver.io) team brings you another container release featuring easy user mapping and community support. Find us for support at: -## Usage +* [forum.linuxserver.io](https://forum.linuxserver.io) +* [IRC](https://www.linuxserver.io/irc/) on freenode at `#linuxserver.io` +* [Podcast](https://www.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/mylar + +[![](https://images.microbadger.com/badges/version/linuxserver/mylar.svg)](https://microbadger.com/images/linuxserver/mylar)[![](https://images.microbadger.com/badges/image/linuxserver/mylar.svg)](https://microbadger.com/images/linuxserver/mylar)[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/mylar.svg)](https://hub.docker.com/r/linuxserver/mylar/)[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/mylar.svg)](https://hub.docker.com/r/linuxserver/mylar/)[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Builders/x86-64/x86-64-mylar)](https://ci.linuxserver.io/job/Docker-Builders/job/x86-64/job/x86-64-mylar/) + +An automated Comic Book downloader \(cbr/cbz\) for use with SABnzbd, NZBGet and torrents. [mylar](https://github.com/evilhero/mylar) + +[![mylar](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/mylar-icon.png)](https://github.com/evilhero/mylar) + +### Usage + +```text docker create \ --name=mylar \ -v :/config \ @@ -33,15 +30,11 @@ docker create \ linuxserver/mylar ``` -## Parameters +### 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.` +`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 8090` - the port(s) +* `-p 8090` - the port\(s\) * `-v /config` - where mylar should store config files * `-v /downloads` - map to your downloads folder * `-v /comics` - map to your comics folder @@ -51,26 +44,24 @@ http://192.168.x.x:8080 would show you what's running INSIDE the container on po It is based on alpine linux with s6 overlay, for shell access whilst the container is running do `docker exec -it mylar /bin/bash`. -### User / Group Identifiers +#### 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" ™. +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: -``` +```text $ id uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup) ``` -## Setting up the application +### Setting up the application -The web ui for settings etc, is on `:8090` -For more detailed setup refer [mylar](https://github.com/evilhero/mylar). +The web ui for settings etc, is on `:8090` For more detailed setup refer [mylar](https://github.com/evilhero/mylar). -## Info +### Info * To monitor the logs of the container in realtime `docker logs -f mylar`. - * container version number `docker inspect -f '{{ index .Config.Labels "build_version" }}' mylar` @@ -79,19 +70,22 @@ For more detailed setup refer [mylar](https://github.com/evilhero/mylar). `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/mylar` -## Versions +### Versions + +* **17.08.18:** Rebase to alpine 3.8. +* **06.07.18:** Add `html5lib` python package +* **14.06.18:** Add `requests` python package +* **12.12.17:** Rebase to alpine 3.7. +* **21.07.17:** Internal git pull instead of at runtime. +* **25.05.17:** Rebase to alpine 3.6. +* **19.02.17:** Use quiet option for cleaner console log, + + app logs to file anyways. + +* **07.02.17:** Rebase to alpine 3.5. +* **14.10.16:** Add version layer information. +* **10.09.16:** Add layer badges to README. +* **28.08.16:** Add badges to README. +* **08.08.16:** Rebase to alpine linux. +* **26.01.16:** Initial Release. -+ **17.08.18:** Rebase to alpine 3.8. -+ **06.07.18:** Add `html5lib` python package -+ **14.06.18:** Add `requests` python package -+ **12.12.17:** Rebase to alpine 3.7. -+ **21.07.17:** Internal git pull instead of at runtime. -+ **25.05.17:** Rebase to alpine 3.6. -+ **19.02.17:** Use quiet option for cleaner console log, -app logs to file anyways. -+ **07.02.17:** Rebase to alpine 3.5. -+ **14.10.16:** Add version layer information. -+ **10.09.16:** Add layer badges to README. -+ **28.08.16:** Add badges to README. -+ **08.08.16:** Rebase to alpine linux. -+ **26.01.16:** Initial Release. diff --git a/images/docker-rutorrent.md b/images/docker-rutorrent.md old mode 100755 new mode 100644 index 32f42aadd..ab9c2e9b7 --- a/images/docker-rutorrent.md +++ b/images/docker-rutorrent.md @@ -1,35 +1,28 @@ -# [linuxserver/rutorrent](https://github.com/linuxserver/docker-rutorrent) +# linuxserver/rutorrent -[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) -[![](https://images.microbadger.com/badges/version/linuxserver/rutorrent.svg)](https://microbadger.com/images/linuxserver/rutorrent "Get your own version badge on microbadger.com") -[![](https://images.microbadger.com/badges/image/linuxserver/rutorrent.svg)](https://microbadger.com/images/linuxserver/rutorrent "Get your own version badge on microbadger.com") -![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/rutorrent.svg) -![Docker Stars](https://img.shields.io/docker/stars/linuxserver/rutorrent.svg) -[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-rutorrent/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-rutorrent/job/master/) -[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/rutorrent/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/rutorrent/latest/index.html) +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) [![](https://images.microbadger.com/badges/version/linuxserver/rutorrent.svg)](https://microbadger.com/images/linuxserver/rutorrent) [![](https://images.microbadger.com/badges/image/linuxserver/rutorrent.svg)](https://microbadger.com/images/linuxserver/rutorrent) ![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/rutorrent.svg) ![Docker Stars](https://img.shields.io/docker/stars/linuxserver/rutorrent.svg) [![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-rutorrent/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-rutorrent/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/rutorrent/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/rutorrent/latest/index.html) [Rutorrent](https://github.com/Novik/ruTorrent) is a popular rtorrent client with a webui for ease of use. ## 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). +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). The architectures supported by this image are: | Architecture | Tag | -| :----: | --- | +| :---: | :--- | | x86-64 | amd64-latest | | arm64 | arm64v8-latest | | armhf | arm32v6-latest | - ## Usage Here are some example snippets to help you get started creating a container from this image. ### docker -``` +```text docker create \ --name=rutorrent \ -e PUID=1001 \ @@ -44,7 +37,6 @@ docker create \ linuxserver/rutorrent ``` - ### docker-compose Compatible with docker-compose v2 schemas. @@ -73,42 +65,40 @@ 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 | -| :----: | --- | +| :---: | :--- | | `80` | ruTorrent Web UI | | `5000` | scgi port | | `51413` | Bit-torrent port | | `6881/udp` | Bit-torrent port | - -### Environment Variables (`-e`) +### Environment Variables \(`-e`\) | Env | Function | -| :----: | --- | +| :---: | :--- | | `PUID=1001` | for UserID - see below for explanation | | `PGID=1001` | for GroupID - see below for explanation | -### Volume Mappings (`-v`) +### Volume Mappings \(`-v`\) | Volume | Function | -| :----: | --- | +| :---: | :--- | | `/config` | where ruTorrent should store it's config files | | `/downloads` | path to your downloads folder | - ## 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=1001` and `PGID=1001`, to find yours use `id user` as below: -``` +```text $ id username uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup) ``` @@ -119,32 +109,28 @@ Webui can be found at `:80` , configuration files for rtorrent are in / `Settings, changed by the user through the "Settings" panel in ruTorrent, are valid until rtorrent restart. After which all settings will be set according to the rtorrent config file (/config/rtorrent/rtorrent.rc),this is a limitation of the actual apps themselves.` -** Important note for unraid users or those running services such as a webserver on port 80, change port 80 assignment ** + **Important note for unraid users or those running services such as a webserver on port 80, change port 80 assignment** `** It should also be noted that this container when run will create subfolders ,completed, incoming and watched in the /downloads volume.**` -** The Port Assignments and configuration folder structure has been changed from the previous ubuntu based versions of this container and we recommend a clean install ** + **The Port Assignments and configuration folder structure has been changed from the previous ubuntu based versions of this container and we recommend a clean install** Umask can be set in the /config/rtorrent/rtorrent.rc file by changing value in `system.umask.set` If you are seeing this error `Caught internal_error: 'DhtRouter::get_tracker did not actually insert tracker.'.` , a possible fix is to disable dht in `/config/rtorrent/rtorrent.rc` by changing the following values. -```shell +```text dht = disable peer_exchange = no ``` -If after updating you see an error about connecting to rtorrent in the webui, -remove or comment out these lines in /config/rtorrent/rtorrent.rc ,whatever value is set, yes or no. -Just setting them to no will still cause the error.. +If after updating you see an error about connecting to rtorrent in the webui, remove or comment out these lines in /config/rtorrent/rtorrent.rc ,whatever value is set, yes or no. Just setting them to no will still cause the error.. -``` +```text use_udp_trackers = yes peer_exchange = yes ``` - - ## Support Info * Shell access whilst the container is running: @@ -180,3 +166,4 @@ peer_exchange = yes * **07.08.16:** - Perms fix on nginx tmp folder, also exposed php.ini for editing by use in /config/php. * **26.07.16:** - Rebase to alpine. * **08.03.16:** - Initial Release. + diff --git a/images/docker-syncthing.md b/images/docker-syncthing.md old mode 100755 new mode 100644 index cb14755ed..502f280b5 --- a/images/docker-syncthing.md +++ b/images/docker-syncthing.md @@ -1,29 +1,26 @@ -[linuxserverurl]: https://linuxserver.io -[forumurl]: https://forum.linuxserver.io -[ircurl]: https://www.linuxserver.io/irc/ -[podcasturl]: https://www.linuxserver.io/podcast/ -[appurl]: https://syncthing.net -[hub]: https://hub.docker.com/r/linuxserver/syncthing/ - -[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)][linuxserverurl] - -The [LinuxServer.io][linuxserverurl] team brings you another container release featuring easy user mapping and community support. Find us for support at: -* [forum.linuxserver.io][forumurl] -* [IRC][ircurl] on freenode at `#linuxserver.io` -* [Podcast][podcasturl] covers everything to do with getting the most from your Linux Server plus a focus on all things Docker and containerisation! - # linuxserver/syncthing -[![](https://images.microbadger.com/badges/version/linuxserver/syncthing.svg)](https://microbadger.com/images/linuxserver/syncthing "Get your own version badge on microbadger.com")[![](https://images.microbadger.com/badges/image/linuxserver/syncthing.svg)](https://microbadger.com/images/linuxserver/syncthing "Get your own image badge on microbadger.com")[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/syncthing.svg)][hub][![Docker Stars](https://img.shields.io/docker/stars/linuxserver/syncthing.svg)][hub][![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Builders/x86-64/x86-64-syncthing)](https://ci.linuxserver.io/job/Docker-Builders/job/x86-64/job/x86-64-syncthing/) + +[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)](https://linuxserver.io) + +The [LinuxServer.io](https://linuxserver.io) team brings you another container release featuring easy user mapping and community support. Find us for support at: + +* [forum.linuxserver.io](https://forum.linuxserver.io) +* [IRC](https://www.linuxserver.io/irc/) on freenode at `#linuxserver.io` +* [Podcast](https://www.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/syncthing + +[![](https://images.microbadger.com/badges/version/linuxserver/syncthing.svg)](https://microbadger.com/images/linuxserver/syncthing)[![](https://images.microbadger.com/badges/image/linuxserver/syncthing.svg)](https://microbadger.com/images/linuxserver/syncthing)[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/syncthing.svg)](https://hub.docker.com/r/linuxserver/syncthing/)[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/syncthing.svg)](https://hub.docker.com/r/linuxserver/syncthing/)[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Builders/x86-64/x86-64-syncthing)](https://ci.linuxserver.io/job/Docker-Builders/job/x86-64/job/x86-64-syncthing/) Syncthing replaces proprietary sync and cloud services with something open, trustworthy and decentralized. Your data is your data alone and you deserve to choose where it is stored, if it is shared with some third party and how it's transmitted over the Internet. You can find some of the best documentation available on the web at [docs.syncthing.net](http://docs.syncthing.net/). -[![syncthing](https://syncthing.net/images/logo-horizontal.svg)][appurl] +[![syncthing](https://syncthing.net/images/logo-horizontal.svg)](https://syncthing.net) -## Usage +### Usage -``` +```text docker create \ --name=syncthing \ -v *host path to config*:/config \ @@ -34,47 +31,42 @@ docker create \ linuxserver/syncthing ``` -## 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.` +### 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.` * `-v /config` - This contain configuration to keep it static, as well as a default shared directory * `-v /mnt/dir` - Add multiple folders to allow Syncthing access to data you wish to sync * `-e PGID` for GroupID - see below for explanation * `-e PUID` for UserID - see below for explanation -* `-e UMASK_SET` for umask setting , *optional* , default if left unset is 022. +* `-e UMASK_SET` for umask setting , _optional_ , default if left unset is 022. * `-p 8384` Webui Port * `-p 22000` Listening Port * `-p 21027/udp` Discovery Port It is based on alpine linux with s6 overlay, for shell access whilst the container is running do `docker exec -it syncthing /bin/bash`. -### User / Group Identifiers +#### 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" ™. +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: -``` +```text $ id uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup) ``` -## Setting up the application +### Setting up the application You can find some of the best documentation available on the web at [docs.syncthing.net](http://docs.syncthing.net/). -**Note: ** The Syncthing devs highly suggest setting a password for this container as it listens on 0.0.0.0. To do this go to `Actions -> Settings -> set user\password` for the webUI. +**Note:** The Syncthing devs highly suggest setting a password for this container as it listens on 0.0.0.0. To do this go to `Actions -> Settings -> set user\password` for the webUI. -## Info +### Info * Shell access whilst the container is running: `docker exec -it syncthing /bin/bash` * To monitor the logs of the container in realtime: `docker logs -f syncthing` - * container version number `docker inspect -f '{{ index .Config.Labels "build_version" }}' syncthing` @@ -83,20 +75,21 @@ You can find some of the best documentation available on the web at [docs.syncth `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/syncthing` -## Versions +### Versions + +* **16.01.19:** Add pipeline logic and multi arch. +* **30.07.18:** Rebase to alpine 3.8 and use buildstage. +* **13.12.17:** Rebase to alpine 3.7. +* **25.10.17:** Add env for manual setting of umask. +* **29.07.17:** Simplify build structure as symlinks failing on > 0.14.32 +* **28.05.17:** Rebase to alpine 3.6. +* **08.02.17:** Rebase to alpine 3.5. +* **01.11.16:** Switch to compiling latest version from git source. +* **14.10.16:** Add version layer information. +* **30.09.16:** Fix umask. +* **09.09.16:** Add layer badges to README. +* **28.08.16:** Add badges to README. +* **11.08.16:** Rebase to alpine linux. +* **18.12.15:** Initial testing / release \(IronicBadger\) +* **24.09.15:** Inital dev complete \(Lonix\) -+ **16.01.19:** Add pipeline logic and multi arch. -+ **30.07.18:** Rebase to alpine 3.8 and use buildstage. -+ **13.12.17:** Rebase to alpine 3.7. -+ **25.10.17:** Add env for manual setting of umask. -+ **29.07.17:** Simplify build structure as symlinks failing on > 0.14.32 -+ **28.05.17:** Rebase to alpine 3.6. -+ **08.02.17:** Rebase to alpine 3.5. -+ **01.11.16:** Switch to compiling latest version from git source. -+ **14.10.16:** Add version layer information. -+ **30.09.16:** Fix umask. -+ **09.09.16:** Add layer badges to README. -+ **28.08.16:** Add badges to README. -+ **11.08.16:** Rebase to alpine linux. -+ **18.12.15:** Initial testing / release (IronicBadger) -+ **24.09.15:** Inital dev complete (Lonix)