kopia lustrzana https://github.com/linuxserver/docker-documentation
Bot Updating Documentation
LinuxServer-CI
rodzic
e8115bfcd8
commit
813439951c
|
|
@ -1,6 +1,14 @@
|
||||||
# linuxserver/rutorrent
|
# [linuxserver/rutorrent](https://github.com/linuxserver/docker-rutorrent)
|
||||||
|
|
||||||
[](https://github.com/linuxserver/docker-rutorrent) [](https://github.com/linuxserver/docker-rutorrent/releases) [](https://github.com/linuxserver/docker-rutorrent/packages) [](https://gitlab.com/Linuxserver.io/docker-rutorrent/container_registry) [](https://microbadger.com/images/linuxserver/rutorrent) [](https://hub.docker.com/r/linuxserver/rutorrent) [](https://hub.docker.com/r/linuxserver/rutorrent) [](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-rutorrent/job/master/) [](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/rutorrent/latest/index.html)
|
[](https://github.com/linuxserver/docker-rutorrent)
|
||||||
|
[](https://github.com/linuxserver/docker-rutorrent/releases)
|
||||||
|
[](https://github.com/linuxserver/docker-rutorrent/packages)
|
||||||
|
[](https://gitlab.com/Linuxserver.io/docker-rutorrent/container_registry)
|
||||||
|
[](https://microbadger.com/images/linuxserver/rutorrent "Get your own version badge on microbadger.com")
|
||||||
|
[](https://hub.docker.com/r/linuxserver/rutorrent)
|
||||||
|
[](https://hub.docker.com/r/linuxserver/rutorrent)
|
||||||
|
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-rutorrent/job/master/)
|
||||||
|
[](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.
|
||||||
|
|
||||||
|
|
@ -13,18 +21,19 @@ Simply pulling `linuxserver/rutorrent` should retrieve the correct image for you
|
||||||
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 | arm32v7-latest |
|
| armhf | arm32v7-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=1000 \
|
-e PUID=1000 \
|
||||||
|
|
@ -39,6 +48,7 @@ docker create \
|
||||||
linuxserver/rutorrent
|
linuxserver/rutorrent
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
### docker-compose
|
### docker-compose
|
||||||
|
|
||||||
Compatible with docker-compose v2 schemas.
|
Compatible with docker-compose v2 schemas.
|
||||||
|
|
@ -66,38 +76,41 @@ 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=1000` | for UserID - see below for explanation |
|
| `PUID=1000` | for UserID - see below for explanation |
|
||||||
| `PGID=1000` | for GroupID - see below for explanation |
|
| `PGID=1000` | 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 |
|
||||||
|
|
||||||
## Environment variables from files \(Docker secrets\)
|
|
||||||
|
|
||||||
|
## Environment variables from files (Docker secrets)
|
||||||
|
|
||||||
You can set any environment variable from a file by using a special prepend `FILE__`.
|
You can set any environment variable from a file by using a special prepend `FILE__`.
|
||||||
|
|
||||||
As an example:
|
As an example:
|
||||||
|
|
||||||
```text
|
```
|
||||||
-e FILE__PASSWORD=/run/secrets/mysecretpassword
|
-e FILE__PASSWORD=/run/secrets/mysecretpassword
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
@ -105,17 +118,19 @@ Will set the environment variable `PASSWORD` based on the contents of the `/run/
|
||||||
|
|
||||||
## Umask for running applications
|
## Umask for running applications
|
||||||
|
|
||||||
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.
|
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.
|
||||||
|
|
||||||
|
|
||||||
## 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=1000` and `PGID=1000`, to find yours use `id user` as below:
|
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
|
||||||
|
|
||||||
```text
|
```
|
||||||
$ id username
|
$ id username
|
||||||
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
|
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
|
||||||
```
|
```
|
||||||
|
|
@ -126,35 +141,38 @@ 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.mode.set = disable
|
dht.mode.set = disable
|
||||||
protocol.pex.set = no
|
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
|
trackers.use_udp.set = yes
|
||||||
protocol.pex.set = no
|
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.
|
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://mods.linuxserver.io/?mod=rutorrent "view available mods for this container.")
|
||||||
|
|
||||||
[](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
|
## Support Info
|
||||||
|
|
||||||
|
|
@ -199,4 +217,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.
|
* **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.
|
||||||
|
|
||||||
|
|
|
||||||
Ładowanie…
Reference in New Issue