Skip to content

Downloadarr - rTorrent

Configuration options for downloadarr rtorrent.

Available Options

This page documents 9 configuration options.

nixflix.downloadarr.rtorrent.enable

Whether or not this download client is enabled.

Typeboolean
Default
false
Declared inmodules/downloadarr/options.nix

nixflix.downloadarr.rtorrent

rTorrent download client definition for Starr services.

Typeopen submodule of attribute set of anything
Default
{ }
Declared inmodules/downloadarr/options.nix

nixflix.downloadarr.rtorrent.dependencies

systemd services that this integration depends on

Typelist of string
Default
[ ]
Declared inmodules/downloadarr/options.nix

nixflix.downloadarr.rtorrent.host

Host of the download client.

Typestring
Default
"127.0.0.1"
Example
"example.com"
Declared inmodules/downloadarr/options.nix

nixflix.downloadarr.rtorrent.name

User-defined name for the download client instance.

Typestring
Default
"rTorrent"
Declared inmodules/downloadarr/options.nix

nixflix.downloadarr.rtorrent.password

Password for the download client.

Warning

Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use { _secret = path; } for sensitive data.

Typestring or (submodule)
Default
null
Example
{ _secret = "/run/secrets/secret-file"; }
Declared inmodules/downloadarr/options.nix

nixflix.downloadarr.rtorrent.port

Port of the download client. This competes with SABnzbd.

Type16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default
8080
Declared inmodules/downloadarr/options.nix

nixflix.downloadarr.rtorrent.urlBase

Path to the XMLRPC endpoint, see http(s)://[host]:[port]/[urlPath]. This is usually RPC2 or [path to ruTorrent]/plugins/rpc/rpc.php when using ruTorrent.

Typestring
Default
"RPC2"
Example
"rtorrent/RPC2"
Declared inmodules/downloadarr/options.nix

nixflix.downloadarr.rtorrent.username

Username key for the download client.

Warning

Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use { _secret = path; } for sensitive data.

Typestring or (submodule)
Default
null
Example
{ _secret = "/run/secrets/secret-file"; }
Declared inmodules/downloadarr/options.nix