Skip to content

Torrent Clients - qBittorrent

Configuration options for torrentClients qbittorrent.

Available Options

This page documents 11 configuration options.

nixflix.torrentClients.qbittorrent.enable

Whether to enable qBittorrent usenet downloader.

Uses all of the same options as nixpkgs qBittorent.

Typeboolean
Default
false
Declared inmodules/torrentClients/qbittorrent.nix

nixflix.torrentClients.qbittorrent

This option has no description.

Typeopen submodule of attribute set of anything
Default
{ }
Declared inmodules/torrentClients/qbittorrent.nix

nixflix.torrentClients.qbittorrent.categories

Map of category names to their save paths (relative or absolute).

Typeattribute set of string
Default
{
  radarr = lib.optionalString (config.nixflix.radarr.enable or false) "/data/downloads/torrent/radarr";
  sonarr = lib.optionalString (config.nixflix.radarr.enable or false) "/data/downloads/torrent/sonarr";
  sonarr-anime = lib.optionalString (config.nixflix.radarr.enable or false) "/data/downloads/torrent/sonarr-anime";
  lidarr = lib.optionalString (config.nixflix.radarr.enable or false) "/data/downloads/torrent/lidarr";
  prowlarr = lib.optionalString (config.nixflix.radarr.enable or false) "/data/downloads/torrent/prowlarr";
}
Example
{
  prowlarr = "games";
  sonarr = "/mnt/share/movies";
}
Declared inmodules/torrentClients/qbittorrent.nix

nixflix.torrentClients.qbittorrent.downloadsDir

Base directory for qBittorrent downloads

Typestring
Default
"$${config.nixflix.downloadsDir}/torrent"
Declared inmodules/torrentClients/qbittorrent.nix

nixflix.torrentClients.qbittorrent.group

Group under which qbittorrent runs.

Typestring
Default
"media"
Declared inmodules/torrentClients/qbittorrent.nix

nixflix.torrentClients.qbittorrent.password

The password for qbittorrent. This is for the other services to integrate with qBittorrent. Not for setting the password in qBittorrent

In order to set the password for qBittorrent itself, you will need to configure nixflix.torrentClients.qbittorrent.serverConfig.Preferences.WebUI.Password_PBKDF2. Look at the serverConfig documentation to see how to configure it.

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/torrentClients/qbittorrent.nix

nixflix.torrentClients.qbittorrent.serverConfig.BitTorrent.Session.DefaultSavePath

Default save path for downloads without a category.

Typestring
Default
"${config.nixflix.torrentClients.qbittorrent.downloadsDir}/default"
Declared inmodules/torrentClients/qbittorrent.nix

nixflix.torrentClients.qbittorrent.serverConfig.Preferences.WebUI.Address

Bind address for the WebUI

Typestring
Default
"127.0.0.1"
Declared inmodules/torrentClients/qbittorrent.nix

nixflix.torrentClients.qbittorrent.subdomain

Subdomain prefix for nginx reverse proxy.

Typestring
Default
"qbittorrent"
Declared inmodules/torrentClients/qbittorrent.nix

nixflix.torrentClients.qbittorrent.user

User account under which qbittorrent runs.

Typestring
Default
"qbittorrent"
Declared inmodules/torrentClients/qbittorrent.nix

nixflix.torrentClients.qbittorrent.webuiPort

the port passed to qbittorrent via --webui-port

Typenull or 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default
8282
Declared inmodules/torrentClients/qbittorrent.nix