Bot Updating Templated Files

pull/1/head
LinuxServer-CI 2019-02-09 05:50:49 -05:00
rodzic c7c0248be1
commit 6948a99608
1 zmienionych plików z 36 dodań i 20 usunięć

Wyświetl plik

@ -1,28 +1,37 @@
# linuxserver/rutorrent # [linuxserver/rutorrent](https://github.com/linuxserver/docker-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) [![](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) [![](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)
[Rutorrent](https://github.com/Novik/ruTorrent) is a popular rtorrent client with a webui for ease of use. [Rutorrent](https://github.com/Novik/ruTorrent) is a popular rtorrent client with a webui for ease of use.
## Supported Architectures ## 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).
Simply pulling `linuxserver/rutorrent` 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: The architectures supported by this image are:
| Architecture | Tag | | Architecture | Tag |
| :---: | :--- | | :----: | --- |
| x86-64 | amd64-latest | | x86-64 | amd64-latest |
| arm64 | arm64v8-latest | | arm64 | arm64v8-latest |
| armhf | arm32v6-latest | | armhf | arm32v6-latest |
## Usage ## Usage
Here are some example snippets to help you get started creating a container from this image. Here are some example snippets to help you get started creating a container from this image.
### docker ### docker
```text ```
docker create \ docker create \
--name=rutorrent \ --name=rutorrent \
-e PUID=1001 \ -e PUID=1001 \
@ -37,6 +46,7 @@ docker create \
linuxserver/rutorrent linuxserver/rutorrent
``` ```
### docker-compose ### docker-compose
Compatible with docker-compose v2 schemas. Compatible with docker-compose v2 schemas.
@ -65,40 +75,43 @@ services:
## Parameters ## 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. 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`\) ### Ports (`-p`)
| Parameter | Function | | Parameter | Function |
| :---: | :--- | | :----: | --- |
| `80` | ruTorrent Web UI | | `80` | ruTorrent Web UI |
| `5000` | scgi port | | `5000` | scgi port |
| `51413` | Bit-torrent port | | `51413` | Bit-torrent port |
| `6881/udp` | Bit-torrent port | | `6881/udp` | Bit-torrent port |
### Environment Variables \(`-e`\)
### Environment Variables (`-e`)
| Env | Function | | Env | Function |
| :---: | :--- | | :----: | --- |
| `PUID=1001` | for UserID - see below for explanation | | `PUID=1001` | for UserID - see below for explanation |
| `PGID=1001` | for GroupID - see below for explanation | | `PGID=1001` | for GroupID - see below for explanation |
### Volume Mappings \(`-v`\) ### Volume Mappings (`-v`)
| Volume | Function | | Volume | Function |
| :---: | :--- | | :----: | --- |
| `/config` | where ruTorrent should store it's config files | | `/config` | where ruTorrent should store it's config files |
| `/downloads` | path to your downloads folder | | `/downloads` | path to your downloads folder |
## User / Group Identifiers ## 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. 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: In this instance `PUID=1001` and `PGID=1001`, to find yours use `id user` as below:
```text ```
$ id username $ id username
uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup) uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)
``` ```
@ -109,28 +122,32 @@ Webui can be found at `<your-ip>: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.` `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.**` `** 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` 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. 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 = disable dht = disable
peer_exchange = no 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 use_udp_trackers = yes
peer_exchange = yes peer_exchange = yes
``` ```
## Support Info ## Support Info
* Shell access whilst the container is running: * Shell access whilst the container is running:
@ -166,4 +183,3 @@ peer_exchange = yes
* **07.08.16:** - Perms fix on nginx tmp folder, also exposed php.ini for editing by use in /config/php. * **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. * **26.07.16:** - Rebase to alpine.
* **08.03.16:** - Initial Release. * **08.03.16:** - Initial Release.