Skip to content

Downloadarr - SABnzbd

Configuration options for downloadarr sabnzbd.

Available Options

This page documents 8 configuration options.

nixflix.downloadarr.sabnzbd.enable

Whether or not this download client is enabled.

Typeboolean
Default
config.nixflix.usenetClients.sabnzbd.enable
Declared inmodules/downloadarr/options.nix

nixflix.downloadarr.sabnzbd

SABnzbd download client definition for Starr services.

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

nixflix.downloadarr.sabnzbd.apiKey

API 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.

Typenull or string or (submodule)
Default
config.nixflix.usenetClients.sabnzbd.settings.misc.api_key
Example
{ _secret = "/run/secrets/secret-file"; }
Declared inmodules/downloadarr/options.nix

nixflix.downloadarr.sabnzbd.dependencies

systemd services that this integration depends on

Typelist of string
Default
[
  "sabnzbd-categories.service"
]
Declared inmodules/downloadarr/options.nix

nixflix.downloadarr.sabnzbd.host

Host of the download client.

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

nixflix.downloadarr.sabnzbd.name

User-defined name for the download client instance.

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

nixflix.downloadarr.sabnzbd.port

Port of the download client.

Type16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default
config.nixflix.usenetClients.sabnzbd.settings.misc.port
Example
8080
Declared inmodules/downloadarr/options.nix

nixflix.downloadarr.sabnzbd.urlBase

Adds a prefix to the SABnzbd url, such as http://[host]:[port]/[urlBase].

Typestring
Default
if config.nixflix.usenetClients.sabnzbd.settings.misc.url_base == "" then
  ""
else
  lib.removePrefix "/" config.nixflix.usenetClients.sabnzbd.settings.misc.url_base;
Example
"/sabnzbd"
Declared inmodules/downloadarr/options.nix