SABnzbd

Wiki

User Manual FAQ Contact
Introduction Installation Configuration Scripts Advanced Topics
Extensions for SABnzbd

Incorrect or missing information? Special settings

Switches

Field name Default Meaning
start_paused If checked SABnzbd will always start up in "Paused" mode
no_penalties Some Usenet servers have intermittent login (or other) problems. For these the server blocking method is not very favorable. Setting this option will limit blocks to 1 minute.
fast_fail When starting a download, the first article of each file is downloaded. If Abort jobs that cannot be completed is turned on, there are more than 10 files and more than 80% of the first articles is missing the job will be failed. If turned off, it will only be failed if availability is below req_completion_rate.
ignore_wrong_unrar On Linux, SABnzbd checks whether the installed unrar or rar program is supported and issues a warning if not. Set this option if you think you know better.
overwrite_files When unpacking, this will overwrite existing files instead of creating an alternative name.
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
queue_complete_pers Set this to 1 if you want end-of-queue actions Shutdown/Standby/Hibernate to be persistent (remembered) after restarts
api_warnings When the API is accessed by external tools without proper authentication, SABnzbd will show a warning. This is a security warning that you should take seriously. However, it seems that there are some security tools that try to access anything that looks like a webserver. If you cannot disable the cause of the warnings, you can choose to disable the warning.
ampm Display ETA in AM/PM notation, only applicable to some locations in older skins.
enable_unrar, enable_unzip, enable_7zip, enable_filejoin, enable_tsjoin Enable or disable the UnRar, UnZip, 7zip, filejoin and TSJoin tools. If disabled, the archive/split files will not be unpacked.
ignore_unrar_dates Normally unpacked files will get the date/time stamp they have in the archive. If you set this option, the files will get the date/time of unpacking.
debug_log_decoding Log the decoding of each article in +Debug logging mode. Disabled by default to make debug logs more readable. Requires restart of SABnzbd.
multipar Windows only. Disable Multipar and use par2tbb instead. This is still supported, but special workarounds for Windows have been removed so can fail on special cases.
osx_menu Uncheck this to remove the SABnzbd icon in the macOS menu bar
osx_speed Uncheck this to prevent the display of download speed adjacent to SABnzbd's icon in the macOS menu bar
win_menu Uncheck this to remove the SABnzbd icon from the systray on Windows and Linux
use_pickle Only check this when there is a problem with one of the standard Python libs.
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.
rss_filenames Normally the RSS titles are used to name jobs. If you prefer the (usually) more compact NZB file names that are generated by index sites, check this. The RSS matching still occurs on titles only!
ipv6_hosting Some systems have problems dealing with the IPv6 equivalent of "localhost" for SABnzbd host. Therefore SABnzbd will not try to bind to the IPv6 localhost by default when the SABnzbd host is set to "localhost". Enabling this will binding to all addresses of localhost. Alternatively you can also set the SABnzbd host to ::1 to only bind to the IPv6 localhost.
keep_awake Disable to stop SABnzbd's attempts to keep the system awake while the queue isn't empty.
empty_postproc Do post-processing and run the user script even if nothing has been downloaded. This is useful in combination with tools like SickBeard, for which running the script on an empty or failed download is a trigger to try an alternative NZB. Note that the "Status" parameter for the script will be -1.
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.
wait_for_dfolder Some people use external or network drives for the "temporary download folder". It can happen that such a drive isn't mounted yet when SABnzbd starts up, causing it to create a new folder at the default location. To prevent this, set the option to 1. This will make SABnzbd wait until the drive is available. Note that SABnzbd will hang until the drive is available! Also, the folder must already exist otherwise SABnzbd will hang until terminated.
max_art_opt You can choose to use limited retries only for your "optional" servers. This will prevent "Out of retention" failures when your main server is inadvertently off-line
warn_empty_nzb Will enable warnings about empty NZB files, uncheck to supress warnings.
enable_bonjour Will announce itself on Apple's Bonjour protocol. Read more here.
warn_dupl_jobs If checked, will issue a warning when a duplicate job is detected and subsequently paused or deleted. Uncheck if you find the warnings a nuisance
replace_illegal Replace illegal characters in folder names by equivalents. If you switch this off, illegal characters will be just removed.
backup_for_duplicates Check to backup duplicate NZB's.
disable_api_key If checked API calls don't require the API key.
api_logging Check to log all API calls.
x_frame_options Includes HTTP header with every request that prevents SABnzbd to be included in another site within the browser. Disable when trying to use SABnzbd with tools that let you control your HTPC from a single interface.
require_modern_tls Enforce TLSv1.2+ for SSL-connections to Usenet servers. Older protocol versions (SSLv2, SSLv3, and TLS <= 1.1) will be disallowed.

Values

Field name Default Meaning
size_limit 0 Any download that exceeds this value will be paused and get priority "low". You can use the K/M/G notation, so e.g. 4.7G
fsys_type 0 Only for Unix/Linux systems. 0 = Determine automatically, 1 = Names are stored as 8-bit ASCII characters, 2 = Names are stored as UTF-8. Use this only when the names created by SABnzbd look distorted! It will only work for folders created by SABnzbd itself, not files and folders created by unzip and unrar.
movie_rename_limit 100M The minimum size of a file to trigger file renaming in the Sort functions
nomedia_marker Just before unpacking of files into the final folder, SABnzbd will put a special marker file (e.g. ".nomedia") in the folder. Afterwards it will be deleted. This prevents some media player software from trying to index the folder while still incomplete. You can disable the feature by clearing the field, or you can set an alternative name. Check your media software's manual.
max_url_retries 10 How many times failed NZB fetches will be retried. Each retry increases the waiting interval (60, 120, 180, etc seconds). Only applies to errors that might be resolved when trying again later, like a server being temporarily unresponsive.
req_completion_rate 100.2 Minimum percentage to allow pre-check to continue downloading.
A perfect download (with the usual 10% par2 files) would have 110%.
100% means that the rar files and the par2-files combined are the same amount of bytes as only the rar-set, if it was fully complete.
Anything less than 100% is by definition not repairable.
wait_ext_drive 5 When SABnzbd wants to store files on the final destination, this destination might be an external drive. Especially USB drives can take considerable time to wake up after going into standby. SABnzbd will try 5 times with intervals of one second. You can increase this value if needed.
max_foldername_length 246 On most filesystems, the size of each path segment in a filename is limited to 255 characters. Set this option to limit each element of the total path to the provided number of characters. Each element will be truncated to the specified number. Note that this should not be raised above the default (such as to the 'full' 255) since space needs to be reserved for modifications by SABnzbd processes such as automated unpacking.
show_sysload 2 When working on a Linux/Unix system you can have SABnzbd display no system information (0), Only the CPU load indicators (1) and also the memory usage (2).
Linux memory usage "V" is total memory usage of SABnzbd, "R" is actually used physical memory
url_base /sabnzbd 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. Requires restart of SABnzbd. Trailing slash is not allowed and is automatically removed.
direct_unpack_threads 3 When Direct Unpack is enabled we only allow this number of unpackers to be active at the same time. This is to limit strain on the system's disks.
Note that there can be an additional unpack active if a job is also being post-processed.
ipv6_servers 1 Control the use of IPv6 Usenet server addresses. Only useful when you have an IPv6 capable ISP and connect to servers that (also) have IPv6 addresses. Meaning: 0 = don't use, 1 = use when available and reachable, 2 = force usage (when SABnzbd's detection fails)
selftest_host self-test.sabnzbd.org In order to check proper IPv6 connectivity and your external IPv4 address, SABnzbd needs to connect to a known external IPv6 address and a server that returns the external IP address. By default we use our own server for this (we don't send any data). You can choose to use another known IPv6 host, e.g. http://ipv6.google.com. However, this will cause the external IPv4 address detection to fail in the status window, this does not affect the functioning of SABnzbd.
rating_host You can switch the host to connect to for rating. The indexer needs to support this!
rss_odd_titles nzbindex.nl/, nzbindex.com/, nzbclub.com/ Some RSS feeds produce very awkward titles which are fine for filtering, but not as job titles. For all indexers that are listed here, the actual NZB file name will be used instead of the title.
quick_check_ext_ignore nfo, sfv, srr A list of file name extensions that will be ignored during QuickCheck. If they are missing but all other files are correct, QuickCheck will still pass.
host_whitelist hostname See Hostname verification.

Very special option

Below is one option that cannot be set from the Web UI, because it would defeat its security purpose.
You can only access it by directly editing the sabnzbd.ini file, while SABnzbd is not running.

Field name Default Meaning
config_lock If 1, forbids all access to the Config pages.