2020-06-29 07:29:55 +00:00
# linuxserver/rutorrent
[![GitHub Stars ](https://img.shields.io/github/stars/linuxserver/docker-rutorrent.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github )](https://github.com/linuxserver/docker-rutorrent) [![GitHub Release ](https://img.shields.io/github/release/linuxserver/docker-rutorrent.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github )](https://github.com/linuxserver/docker-rutorrent/releases) [![GitHub Package Repository ](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitHub%20Package&logo=github )](https://github.com/linuxserver/docker-rutorrent/packages) [![GitLab Container Registry ](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab )](https://gitlab.com/Linuxserver.io/docker-rutorrent/container_registry) [![MicroBadger Layers ](https://img.shields.io/microbadger/layers/linuxserver/rutorrent.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge )](https://microbadger.com/images/linuxserver/rutorrent) [![Docker Pulls ](https://img.shields.io/docker/pulls/linuxserver/rutorrent.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pulls&logo=docker )](https://hub.docker.com/r/linuxserver/rutorrent) [![Docker Stars ](https://img.shields.io/docker/stars/linuxserver/rutorrent.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=stars&logo=docker )](https://hub.docker.com/r/linuxserver/rutorrent) [![Jenkins Build ](https://img.shields.io/jenkins/build?labelColor=555555&logoColor=ffffff&style=for-the-badge&jobUrl=https%3A%2F%2Fci.linuxserver.io%2Fjob%2FDocker-Pipeline-Builders%2Fjob%2Fdocker-rutorrent%2Fjob%2Fmaster%2F&logo=jenkins )](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-rutorrent/job/master/) [![LSIO CI ](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=CI&query=CI&url=https%3A%2F%2Flsio-ci.ams3.digitaloceanspaces.com%2Flinuxserver%2Frutorrent%2Flatest%2Fci-status.yml )](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/rutorrent/latest/index.html)
2019-02-05 15:35:49 +00:00
[Rutorrent ](https://github.com/Novik/ruTorrent ) is a popular rtorrent client with a webui for ease of use.
## Supported Architectures
2019-09-02 09:00:40 +00:00
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 ) and our announcement [here ](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/ ).
2019-02-09 10:50:49 +00:00
Simply pulling `linuxserver/rutorrent` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
2019-02-05 15:35:49 +00:00
The architectures supported by this image are:
| Architecture | Tag |
2020-06-29 07:29:55 +00:00
| :---: | :--- |
2019-02-05 15:35:49 +00:00
| x86-64 | amd64-latest |
| arm64 | arm64v8-latest |
2019-03-24 19:52:41 +00:00
| armhf | arm32v7-latest |
2019-02-05 15:35:49 +00:00
## Usage
Here are some example snippets to help you get started creating a container from this image.
### docker
2020-06-29 07:29:55 +00:00
```text
2019-02-05 15:35:49 +00:00
docker create \
--name=rutorrent \
2019-03-02 11:20:42 +00:00
-e PUID=1000 \
-e PGID=1000 \
2019-02-05 15:35:49 +00:00
-p 80:80 \
-p 5000:5000 \
-p 51413:51413 \
-p 6881:6881/udp \
-v < /path/to/rutorrent/config>:/config \
-v < /path/to/rutorrent/downloads>:/downloads \
--restart unless-stopped \
linuxserver/rutorrent
```
### docker-compose
Compatible with docker-compose v2 schemas.
```yaml
---
2020-04-13 08:59:57 +00:00
version: "2.1"
2019-02-05 15:35:49 +00:00
services:
rutorrent:
image: linuxserver/rutorrent
container_name: rutorrent
environment:
2019-03-02 11:20:42 +00:00
- PUID=1000
- PGID=1000
2019-02-05 15:35:49 +00:00
volumes:
- < /path/to/rutorrent/config>:/config
- < /path/to/rutorrent/downloads>:/downloads
ports:
- 80:80
- 5000:5000
- 51413:51413
- 6881:6881/udp
restart: unless-stopped
```
## Parameters
2020-06-29 07:29:55 +00:00
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.
2019-02-05 15:35:49 +00:00
2020-06-29 07:29:55 +00:00
### Ports \(`-p`\)
2019-02-05 15:35:49 +00:00
| Parameter | Function |
2020-06-29 07:29:55 +00:00
| :---: | :--- |
2019-02-05 15:35:49 +00:00
| `80` | ruTorrent Web UI |
| `5000` | scgi port |
| `51413` | Bit-torrent port |
| `6881/udp` | Bit-torrent port |
2020-06-29 07:29:55 +00:00
### Environment Variables \(`-e`\)
2019-02-05 15:35:49 +00:00
| Env | Function |
2020-06-29 07:29:55 +00:00
| :---: | :--- |
2019-03-02 11:20:42 +00:00
| `PUID=1000` | for UserID - see below for explanation |
| `PGID=1000` | for GroupID - see below for explanation |
2019-02-05 15:35:49 +00:00
2020-06-29 07:29:55 +00:00
### Volume Mappings \(`-v`\)
2019-02-05 15:35:49 +00:00
| Volume | Function |
2020-06-29 07:29:55 +00:00
| :---: | :--- |
2019-02-05 15:35:49 +00:00
| `/config` | where ruTorrent should store it's config files |
| `/downloads` | path to your downloads folder |
2020-06-29 07:29:55 +00:00
## Environment variables from files \(Docker secrets\)
2020-06-01 08:59:57 +00:00
You can set any environment variable from a file by using a special prepend `FILE__` .
As an example:
2020-06-29 07:29:55 +00:00
```text
2020-06-01 08:59:57 +00:00
-e FILE__PASSWORD=/run/secrets/mysecretpassword
```
Will set the environment variable `PASSWORD` based on the contents of the `/run/secrets/mysecretpassword` file.
## Umask for running applications
2020-06-29 07:29:55 +00:00
For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional `-e UMASK=022` setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up [here ](https://en.wikipedia.org/wiki/Umask ) before asking for support.
2020-05-04 09:00:18 +00:00
2019-02-05 15:35:49 +00:00
## User / Group Identifiers
2020-06-29 07:29:55 +00:00
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` .
2019-02-05 15:35:49 +00:00
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
2019-03-02 11:20:42 +00:00
In this instance `PUID=1000` and `PGID=1000` , to find yours use `id user` as below:
2019-02-05 15:35:49 +00:00
2020-06-29 07:29:55 +00:00
```text
2019-02-05 15:35:49 +00:00
$ id username
2019-03-02 11:20:42 +00:00
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
2019-02-05 15:35:49 +00:00
```
## Application Setup
Webui can be found at `<your-ip>:80` , configuration files for rtorrent are in /config/rtorrent, php in config/php and for the webui in /config/rutorrent/settings.
`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.`
2020-06-29 07:29:55 +00:00
**Important note for unraid users or those running services such as a webserver on port 80, change port 80 assignment**
2019-02-05 15:35:49 +00:00
`** It should also be noted that this container when run will create subfolders ,completed, incoming and watched in the /downloads volume.**`
2020-06-29 07:29:55 +00:00
**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**
2019-02-05 15:35:49 +00:00
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.
2020-06-29 07:29:55 +00:00
```text
2020-02-29 15:57:10 +00:00
dht.mode.set = disable
protocol.pex.set = no
2019-02-05 15:35:49 +00:00
```
2020-06-29 07:29:55 +00:00
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..
2019-02-05 15:35:49 +00:00
2020-06-29 07:29:55 +00:00
```text
2020-02-29 15:57:10 +00:00
trackers.use_udp.set = yes
protocol.pex.set = no
2019-02-05 15:35:49 +00:00
```
2020-01-14 03:19:44 +00:00
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.
2020-04-13 08:59:57 +00:00
## Docker Mods
2020-06-29 07:29:55 +00:00
[![Docker Mods ](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&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)
2020-04-13 08:59:57 +00:00
2020-06-29 07:29:55 +00:00
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.
2019-09-30 09:00:15 +00:00
2019-02-05 15:35:49 +00:00
## Support Info
2019-09-02 09:00:40 +00:00
* Shell access whilst the container is running:
2019-02-05 15:35:49 +00:00
* `docker exec -it rutorrent /bin/bash`
2019-09-02 09:00:40 +00:00
* To monitor the logs of the container in realtime:
2019-02-05 15:35:49 +00:00
* `docker logs -f rutorrent`
2019-09-02 09:00:40 +00:00
* Container version number
2019-02-05 15:35:49 +00:00
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' rutorrent`
* Image version number
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/rutorrent`
## Versions
2020-02-29 15:57:10 +00:00
* **29.02.20:** - Update readme for pex/dht.
2019-07-09 06:10:40 +00:00
* **28.06.19:** - Rebasing to alpine 3.10.
2019-05-21 07:42:18 +00:00
* **20.05.19:** - Shift to building from official releases instead of commits.
2019-05-13 18:38:52 +00:00
* **13.05.19:** - Add libffi and openssl.
2019-05-07 15:56:42 +00:00
* **07.05.19:** - Add cloudscraper pip package.
2019-04-11 15:09:09 +00:00
* **11.04.19:** - Fix warnings in webui by adding python3, procps and pip packages.
2019-03-24 19:52:41 +00:00
* **23.03.19:** - Switching to new Base images, shift to arm32v7 tag.
2019-02-24 16:29:50 +00:00
* **22.02.19:** - Rebasing to alpine 3.9.
2019-02-05 15:35:49 +00:00
* **03.11.18:** - Add pipeline and multi arch logic to repo.
* **27.08.18:** - Add bind tools package.
* **22.08.18:** - Rebase to alpine 3.8.
* **08.12.17:** - Rebase to alpine 3.7, add sox package.
* **28.10.17:** - Mediainfo moved from testing to community repo.
* **09.10.17:** - Use repo version of mediainfo to shorten build time.
* **28.05.17:** - Fix permissions on secondary temp folder of nginx.
* **26.05.17:** - Rebase to alpine 3.6.
* **03.05.17:** - Fix log permissions.
* **18.03.17:** - Note in readme about disabling dht in some circumstances.
* **24.02.17:** - Patch a source file to quash rss https bug.
* **29.01.17:** - Rebase to alpine 3.5.
* **20.11.16:** - Add php7-mbstring package, bump mediainfo to 0.7.90.
* **14.10.16:** - Add version layer information.
* **04.10.16:** - Remove redundant sessions folder.
* **30.09.16:** - Fix umask.
* **21.09.16:** - Bump mediainfo, reorg dockerfile, add full wget package.
* **09.09.16:** - Add layer badges to README.
* **28.08.16:** - Add badges to README, bump mediainfo version to 0.7.87.
* **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.
2020-06-29 07:29:55 +00:00