Skip to content

Usenet Clients - SABnzbd - Settings - Misc

Configuration options for usenetClients sabnzbd settings misc.

Available Options

This page documents 77 configuration options.

nixflix.usenetClients.sabnzbd.settings.misc

SABnzbd [misc] section settings

Typeopen submodule of anything
Default
{ }
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.action_on_unwanted_extensions

Action on unwanted extensions (0=None, 1=Abort, 2=Delete)

Typesigned integer
Default
1
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.admin_dir

Admin directory

Typestring
Default
config.nixflix.usenetClients.sabnzbd.downloadsDir + "/admin"
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.allow_incomplete_nzb

Sometimes you get an incomplete NZB file (partial content, incorrect syntax etc.) You can enable this option to allow SABnzbd to salvage as much as possible from the NZB. The job will enter the queue in paused mode.

Typeboolean
Default
false
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.anon_redirect

Anonymous redirect

Typeboolean
Default
false
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.api_key

API key for SABnzbd.

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/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.article_tries

Number of attempts per article

Typesigned integer
Default
3
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.auto_sort

Automatically sort queue

Typestring
Default
""
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.bandwidth_max

Maximum bandwidth in bytes/sec (supports prefixes). Use in conjunction with bandwidth_perc.

Typestring
Default
""
Example
"50MB/s"
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.bandwidth_perc

Percentage of bandwidth_max that SABnzbd is allowed to use. 0 means no limit.

Typesigned integer
Default
0
Example
50
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.cache_limit

Size of the RAM cache, in bytes (prefixes supported). SABnzbd recommends 25% of available RAM.

Typestring
Default
"512M"
Example
"500M"
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.check_new_rel

Check for new releases

Typeboolean
Default
true
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.complete_dir

Complete downloads directory

Typestring
Default
config.nixflix.usenetClients.sabnzbd.downloadsDir + "/complete"
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.connection_limit

Maximum number of connections

Typesigned integer
Default
100
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.deobfuscate_final_filenames

Deobfuscate final filenames

Typeboolean
Default
true
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.direct_unpack

Unpack during download

Typeboolean
Default
true
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.dirscan_dir

Directory to watch for NZB files

Typestring
Default
config.nixflix.usenetClients.sabnzbd.downloadsDir + "/watch"
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.dirscan_speed

Directory scan speed in seconds

Typesigned integer
Default
5
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.disable_api_key

Disable API key requirement

Typeboolean
Default
false
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.download_dir

Incomplete downloads directory

Typestring
Default
config.nixflix.usenetClients.sabnzbd.downloadsDir + "/incomplete"
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.email_account

Username for SMTP authentication.

Typestring
Default
""
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.email_endjob

Whether to send emails on job completion.

Type(one of 1, 0, 2) or (one of "always", "never", "on error") convertible to it
Default
0
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.email_from

'From:' field for emails (needs to be an address).

Typestring
Default
""
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.email_full

Whether to send alerts for full disks.

Typeboolean
Default
false
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.email_pwd

Password for SMTP authentication.

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/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.email_rss

Whether to send alerts for jobs added by RSS feeds.

Typeboolean
Default
false
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.email_server

SMTP server for email alerts (server:port format).

Typestring
Default
""
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.email_to

Receiving address for email alerts.

Typestring
Default
""
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.enable_all_par

Download all par2 files

Typeboolean
Default
false
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.enable_debug

Enable debug logging

Typeboolean
Default
false
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.enable_https

Whether to enable HTTPS for the web UI.

Typeboolean
Default
false
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.enable_https_verification

Enable HTTPS certificate verification

Typeboolean
Default
true
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.enable_log_rotate

Enable log rotation

Typeboolean
Default
true
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.enable_par_cleanup

Normally SABnzbd will clean up par2 files after verify/repair. You can disable this by using 0. Disabling this will also force all par2 files to be downloaded.

Typeboolean
Default
true
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.enable_recursive

Enable recursive unpacking

Typeboolean
Default
true
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.fail_hopeless_jobs

Abort jobs that cannot be completed

Typeboolean
Default
true
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.fail_on_crc

Fail on CRC errors

Typeboolean
Default
true
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.flat_unpack

Ignore any folders inside archives

Typeboolean
Default
true
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.host

Address for the Web UI to listen on for incoming connections.

Typestring
Default
if config.nixflix.nginx.enable then "127.0.0.1" else "0.0.0.0"
Example
"0.0.0.0"
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.host_whitelist

Hostname verification whitelist. SABnzbd refuses connections from hostnames not in this list. Automatically includes the service hostname when nginx is enabled.

Typestring
Default
if config.nixflix.nginx.enable then "${cfg.subdomain}.${config.nixflix.nginx.domain}" else ""
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.html_login

HTML based login form, uncheck for basic authentication. Both offer similar security but password managers might not be able to fill basic authentication automatically.

Typeboolean
Default
true
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.https_cert

Path to the TLS certificate for the web UI. If not set and HTTPS is enabled, a self-signed certificate is generated.

Typestring
Default
""
Example
config.security.acme.certs."example.com".directory + "/fullchain.pem"
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.https_key

Path to the TLS key for the web UI. If not set and HTTPS is enabled, a self-signed key is generated.

Typestring
Default
""
Example
config.security.acme.certs."example.com".directory + "/key.pem"
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.https_port

HTTPS port for the Web UI (0 to disable HTTPS).

Type16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default
0
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.ignore_samples

Ignore sample files

Typeboolean
Default
false
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.ignore_unrar_errors

Ignore unrar errors

Typeboolean
Default
false
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.inet_exposure

Controls access restrictions from non-local IP addresses.

Type(one of 1, 3, 2, 4, 5, 0) or (one of "api (add nzbs)", "api (full)", "api (no config)", "api+web (auth needed)", "api+web (locally no auth)", "none") convertible to it
Default
0
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.keep_awake

Disable to stop SABnzbd's attempts to keep the system awake while the queue isn't empty.

Typeboolean
Default
false
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.language

Interface language.

Typestring
Default
"en"
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.log_dir

Log directory

Typestring
Default
config.nixflix.usenetClients.sabnzbd.downloadsDir + "/logs"
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.log_level

Log level (0=None, 1=Info, 2=Debug)

Typesigned integer
Default
1
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.max_log_size

Maximum log file size

Typestring
Default
"10M"
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.max_queue_size

Maximum queue size

Typesigned integer
Default
3000
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.no_smart_dupes

Smart duplicate detection

Typesigned integer
Default
4
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.nomedia

Create .nomedia files

Typeboolean
Default
true
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.nzb_backup_dir

NZB backup directory

Typestring
Default
config.nixflix.usenetClients.sabnzbd.downloadsDir + "/nzb-backup"
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.nzb_key

NZB key for adding downloads via URL.

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/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.pause_on_failure

Pause queue on download failure

Typeboolean
Default
false
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.pause_on_post_processing

Pause download during post-processing

Typeboolean
Default
false
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.pause_on_pwrar

Action when encrypted RAR is downloaded

Typesigned integer
Default
1
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.permissions

File permissions for downloaded files

Typestring
Default
"775"
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.port

Port for the Web UI to listen on for incoming connections.

Type16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default
8080
Example
12345
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.pre_check

Check before download

Typeboolean
Default
true
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.propagation_delay

Posts will be pause until they are at least this age. Setting job priority to Force will skip the delay.

Typesigned integer
Default
0
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.reorder_files

Reorder files for optimal unpacking

Typeboolean
Default
true
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.require_modern_tls

Require modern TLS

Typeboolean
Default
true
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.retry_on_failure

Retry failed downloads

Typeboolean
Default
true
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.safe_postproc

Post process only verified jobs

Typeboolean
Default
true
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.sfv_check

Enable SFV-based checks

Typeboolean
Default
true
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.top_only

Only get articles from top of queue

Typeboolean
Default
true
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.unwanted_extensions

Unwanted extensions

Typestring
Default
""
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.unwanted_extensions_mode

Unwanted extension mode (0=Blacklist, 1=Whitelist

Typesigned integer
Default
0
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.url_base

When using a reverse proxy (or just if you feel like it), you can change the base-URL of SABnzbd that is used during redirects. Trailing slash is not allowed. Leading slash is required unless the base URL is an empty string. SABnzbd will forcefully restart after changing this setting, you will need to reload the page after the restart completes.

Typestring
Default
""
Example
"/sabnzbd"
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.warn_dupl_jobs

Warn about duplicate jobs

Typeboolean
Default
true
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.warn_empty_nzb

Warn about empty NZB files

Typeboolean
Default
true
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.web_color

Web interface color scheme.

Typestring
Default
"Gold"
Declared inmodules/usenetClients/sabnzbd

nixflix.usenetClients.sabnzbd.settings.misc.web_dir

Web interface theme.

Typestring
Default
"Glitter"
Declared inmodules/usenetClients/sabnzbd