From 60762e0bf83e92330c449272ccf7fac29b92cd97 Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Mon, 4 May 2020 05:00:18 -0400 Subject: [PATCH] Bot Updating Documentation --- images/docker-rutorrent.md | 59 ++++++++++++++++++++++++-------------- 1 file changed, 38 insertions(+), 21 deletions(-) diff --git a/images/docker-rutorrent.md b/images/docker-rutorrent.md index cf82749a26..6ad1d3a26a 100644 --- a/images/docker-rutorrent.md +++ b/images/docker-rutorrent.md @@ -1,6 +1,15 @@ -# linuxserver/rutorrent +# [linuxserver/rutorrent](https://github.com/linuxserver/docker-rutorrent) -[![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-rutorrent.svg?style=flat-square&color=E68523&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-rutorrent) [![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-rutorrent.svg?style=flat-square&color=E68523&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-rutorrent/releases) [![GitHub Package Repository](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=GitHub%20Package&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-rutorrent/packages) [![GitLab Container Registry](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab&logoColor=FFFFFF)](https://gitlab.com/Linuxserver.io/docker-rutorrent/container_registry) [![Quay.io](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=Quay.io)](https://quay.io/repository/linuxserver.io/rutorrent) [![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/rutorrent.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/rutorrent) [![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/rutorrent.svg?style=flat-square&color=E68523&label=pulls&logo=docker&logoColor=FFFFFF)](https://hub.docker.com/r/linuxserver/rutorrent) [![Docker Stars](https://img.shields.io/docker/stars/linuxserver/rutorrent.svg?style=flat-square&color=E68523&label=stars&logo=docker&logoColor=FFFFFF)](https://hub.docker.com/r/linuxserver/rutorrent) [![Build Status](https://ci.linuxserver.io/view/all/job/Docker-Pipeline-Builders/job/docker-rutorrent/job/master/badge/icon?style=flat-square)](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) +[![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-rutorrent.svg?style=flat-square&color=E68523&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-rutorrent) +[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-rutorrent.svg?style=flat-square&color=E68523&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-rutorrent/releases) +[![GitHub Package Repository](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=GitHub%20Package&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-rutorrent/packages) +[![GitLab Container Registry](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab&logoColor=FFFFFF)](https://gitlab.com/Linuxserver.io/docker-rutorrent/container_registry) +[![Quay.io](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=Quay.io)](https://quay.io/repository/linuxserver.io/rutorrent) +[![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/rutorrent.svg?style=flat-square&color=E68523)](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?style=flat-square&color=E68523&label=pulls&logo=docker&logoColor=FFFFFF)](https://hub.docker.com/r/linuxserver/rutorrent) +[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/rutorrent.svg?style=flat-square&color=E68523&label=stars&logo=docker&logoColor=FFFFFF)](https://hub.docker.com/r/linuxserver/rutorrent) +[![Build Status](https://ci.linuxserver.io/view/all/job/Docker-Pipeline-Builders/job/docker-rutorrent/job/master/badge/icon?style=flat-square)](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. @@ -13,18 +22,19 @@ Simply pulling `linuxserver/rutorrent` should retrieve the correct image for you 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=rutorrent \ -e PUID=1000 \ @@ -39,6 +49,7 @@ docker create \ linuxserver/rutorrent ``` + ### docker-compose Compatible with docker-compose v2 schemas. @@ -66,40 +77,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 | -| :---: | :--- | +| :----: | --- | | `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=1000` | for UserID - see below for explanation | | `PGID=1000` | 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=1000` and `PGID=1000`, to find yours use `id user` as below: -```text +``` $ id username uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup) ``` @@ -110,35 +125,38 @@ 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. -```text +```shell dht.mode.set = disable protocol.pex.set = 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 +``` trackers.use_udp.set = yes protocol.pex.set = no ``` To add themes, create a themes folder in your /config directory and add your theme folders. Ensure proper user and group ownership is set once you add the directories. + ## Docker Mods +[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?style=for-the-badge&color=E68523&label=mods&query=%24.mods%5B%27rutorrent%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=rutorrent "view available mods for this container.") -[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?style=for-the-badge&color=E68523&label=mods&query=%24.mods%5B%27rutorrent%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=rutorrent) +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. -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. ## Support Info @@ -183,4 +201,3 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to * **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. -