k44sh/rutorrent repository overview

⁠ ⁠ ⁠ ⁠ ⁠

⁠ ⁠ ⁠

⁠About

rTorrent⁠ and ruTorrent⁠ Docker image based on Alpine Linux⁠.

⁠Features

• Run as non-root user
• Multi-platform image
• NGINX⁠ with PHP 8.4⁠
• GeoIP2⁠ database by MaxMind⁠ (Update with your own key)
• geoipupdate⁠ to update MaxMind's GeoIP2 databases
• Cloudflare⁠ trusted addresses for NGINX Real IP (not enable by default)
• libTorrent⁠ (0.15.3) / rTorrent⁠ (0.15.3) compiled from source
• ruTorrent⁠ release (v5.2.4)
• c-ares⁠ and UDNS⁠ for asynchronous DNS requests
• mktorrent⁠ installed for ruTorrent create plugin
• Radarr⁠ / Sonarr⁠ hardlinks compliance
• ruTorrent GeoIP2⁠ plugin
• ruTorrent Filemanager⁠ plugin
• ruTorrent Ratiocolors⁠ plugin
• ruTorrent QuickBox⁠ theme
• WAN IP address automatically resolved for reporting to the tracker
• XMLRPC through nginx over SCGI socket (basic auth optional)
• WebDAV on completed downloads (basic auth optional)
• Ability to add a custom ruTorrent plugin / theme
• Allow specific configuration for data folder
• Allow specific configuration for config folder

⁠Volume Overview

⁠Radarr / Sonarr Users

It is recommended to use the same data volume for ruTorrent and Radarr/Sonarr, in order to have a structure similar to this :

data
├── downloads
└── media
   ├── movies
   ├── music
   └── tv

:information_source: More informations here : TRaSH Guide⁠

⁠Multi Platform Images

• linux/amd64
• linux/arm64
• linux/arm/v7

⁠Usage

⁠Docker Compose

Docker compose is the recommended way to run this image. Edit the compose file with your preferences and run the following command:

mkdir $(pwd)/{config,data,passwd}
chown ${PUID}:${PGID} $(pwd)/{config,data,passwd}
docker compose up -d
docker compose logs -f

⁠Upgrade

To upgrade, pull the newer image and launch the container:

docker compose pull
docker compose up -d

⁠Cleanup

docker compose down -v
rm -rf $(pwd)/{config,data,passwd}

⁠Command line

You can also use the following minimal command:

mkdir $(pwd)/{config,data,passwd}
chown ${PUID}:${PGID} $(pwd)/{config,data,passwd}
docker run -d --name rutorrent \
  --ulimit nproc=65535 \
  --ulimit nofile=32000:40000 \
  -p 6881:6881/udp \
  -p 8000:8000 \
  -p 8080:8080 \
  -p 9000:9000 \
  -p 50000:50000 \
  -v $(pwd)/config:/config \
  -v $(pwd)/data:/data \
  -v $(pwd)/passwd:/passwd \
  k44sh/rutorrent:latest && \
  docker logs -f rutorrent

⁠Environment variables

⁠General

⁠rTorrent

⁠ruTorrent

⁠Ports

⁠Notes

⁠WebDAV

WebDAV allows you to retrieve your completed torrent files in /data on port 9000. Like XMLRPC, these requests can be secured with basic authentication through the /passwd/webdav.htpasswd file in which you will need to add a username with his password. See below to populate this file with a user / password.

⁠Populate .htpasswd files

For ruTorrent basic auth, XMLRPC through nginx and WebDAV on completed downloads, you can populate .htpasswd files with the following command:

docker run --rm -it httpd:2.4-alpine htpasswd -Bbn <username> <password> >> $(pwd)/passwd/webdav.htpasswd

Htpasswd files used:

• rpc.htpasswd: XMLRPC through nginx
• rutorrent.htpasswd: ruTorrent basic auth
• webdav.htpasswd: WebDAV on completed downloads

⁠Override or add a ruTorrent plugin/theme

You can add a plugin for ruTorrent in /config/rutorrent/plugins/.

If you add a plugin that already exists in ruTorrent, it will be removed from ruTorrent core plugins and yours will be used. And you can also add a theme in /config/rutorrent/themes/. The same principle as for plugins will be used if you want to override one.

⁠Edit a ruTorrent plugin configuration

As you probably know, plugin configuration is not outsourced in ruTorrent. Loading the configuration of a plugin is done via a conf.php file placed at the root of the plugin folder. To solve this issue with Docker, a special folder has been created in /config/rutorrent/plugins-conf to allow you to configure plugins. For example to configure the diskspace plugin, you will need to create the /config/rutorrent/plugins-conf/diskspace.php file with your configuration:

<?php
$diskUpdateInterval = 10;	// in seconds
$notifySpaceLimit = 512;	// in Mb
$partitionDirectory = null;	// if null, then we will check rtorrent download directory 

Fork based on the version of CrazyMax⁠