SABnzbd

Wiki

Incorrect or missing information? Switches

This Wiki page is for an older version of SABnzbd.
You can download the most recent stable version (SABnzbd 1.2) on our downloads page.

General

Launch browser on startup Enable to auto-launch of the browser when SABnzbd is opened.
Check for new release If enabled, SABnzbd will check once a week whether a new release has been published.
HTTPS certificate verification Verify certificates when connecting to indexers and RSS-sources using HTTPS. Requires Python 2.7.9+, can be enabled in most cases without problems, but some websites do not have proper certificates and some systems might not be configured correctly. [only 1.1.0+]

Server

Maximum retries To prevent deadlock, SABnzbd will only try each server a limited amount of times. You can increase the value or set it to 0 to enable endless retries.
Only for optional servers 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
Server load-balancing A number of newsservers has multiple IP-addresses, these can be IPv4 or IPv6.
  • Prevent load-balancing: the first IP-address returned will be used for all connections.
  • Allow load-balancing: Each connection will be randomly selected from the available addresses.
  • Allow load-balancing with optimization for IPv6: For each connection the fastest IP-address is selected, where IPv6-addresses are given a slight head-start.
Disconnect on empty queue Disconnect from Usenet server(s) when queue is empty or paused. This will help you switch between different systems. Set this option off when your server keeps complaining that you have too many connections open.

Queue

Pre-queue user script See: User's pre-queue script.
Propagation delay If you experience very young posts failing due to missing blocks your server might still be in the process of receiving the posts. Delaying the these very young posts a few minutes might solve these issues. Posts will be paused untill they are at least this age. Setting job priority to Force will skip the delay. [only 1.1.0+]
Only get articles for top of the queue When a top-job stalls for some reason, start downloading segments for the next job (costs more memory). This prevents a job from blocking the queue when you have an unreliable Usenet server. If you need this behaviour, set the option off. If you have a reliable server (most paid servers), you might as well set this on.
Check before download To prevent wasteful downloading, you can let SABnzbd check the presence of a job on the server, before actually downloading it. If less than 100.2% of the total available data (including par2 files) is available, the job will be send to History as failed. When you click "Retry", SABnzbd will attempt the download anyway. Note that the check slows down the total download considerably, use only when you're not in a hurry but wish not to waste your quota instead. Also it cannot be completely reliable, due to the way some servers remove posts.
Abort jobs that cannot be completed If on, when during download it becomes clear that less than 99% of the total data can be downloaded, the job will be sent to History as a failed one. Should you retry the job, the check will not be done again, but the whole job will be tried instead. [0.7.8+ only]
Detect duplicate downloads This option will compare the name of the NZB file against all NZB titles in History. It will also look whether the content of the NZB is effectively the same.
Detect duplicate episodes in series This option will analyse NZB titles for Series/Season/Episode information and will check whether the episode has already been downloaded. It will check against the History database.
Action when encrypted RAR is downloaded For more info see Password-protected RARs You can choose to either continue, abort or pause the download.
Action when unwanted extension detected The presence of .exe files is often a sign of a troyan horse or virus being part of the post. You can abort or pause downloads that contain files with the listed extensions. Example exe,com,cmd,bat will trigger on the most used Windows executable content.
Sort by age When you use a server with a low retention time, you can choose to download the oldest parts of a job first. This way you have more chance on completing the download.

Post processing

Pause downloading during post-processing Will pause the queue while verifying and repairing, only needed for resource-constrained systems (like NAS-devices).
Download all par2 files See Optimal Repair.
Enable QuickCheck Normally par2-based downloads are verified and (if required) repaired by the external par2 program. This takes a lot time. SABnzbd can check the correctness of downloaded files on the fly. A completely correct download does not have to be processed by par2 anymore. If there are any error in the files, the par2 program is launched anyway. Normally you would always want this option on.
Enable MultiCore par2 See Multi-core PAR2.
Extra PAR2 parameters See Multi-core PAR2 and Par2cmdline.
Enable SFV-based checks If no par2 files are available, SFV files (if present) will be used to check files
Process only verified jobs When the download is incorrect and not repairable it may be safer to skip further post-processing.
Enable recursive unpacking Unpack archives (rar, zip, 7z) within archives.
Ignore any folders inside archives All files will go into a single folder.
When unpacking, overwrite exiting files This will overwrite existing files instead of creating an alternative name.
Check result of unpacking On some systems SABnzbd cannot properly predict how filenames will turn out (most notably Unix/Linux systems with inconsistent internationalization settings for the file system). For those systems you should disable this option.
User script can flag job as failed Some scripts will return a non-zero exit code when they encounter a problem. You can opt to let a non-zero exit code mark the job as failed. This can be useful when you're using an indexer that offers alternative NZB files or use a front-end (like SickBeard) that will look for alternatives when a job fails.
On failure, try alternative NZB Some servers provide an alternative NZB when a download fails and we can try that one!
Nice parameters See Nice to reduce CPU priority.
IONice parameters See IONice to reduce disk priority.
Ignore samples If enabled, delete anything that looks like sample files after completion of post-processing.
Cleanup List List of file (extensions) that should be deleted in the cleanup stage. Examples: .nfo, .nfo, .sfv (You can leave out the dots, so nfo, nzb, sfv will do the same.)

Naming

Enable folder rename When SABnzbd does unpacking it will do that in a folder prefixed with _UNPACK_. This is to prevent users or other software from processing the file. Some Windows operating systems (most notably Windows Home Server) cannot handle this. Therefor it's possible to disable the feature.
Replace Spaces in folder names Enable to replace spaces with underscores in folder names.
Replace dots in folder names Enable to replace dots with spaces in folder names.
Replace illegal characters in folder names Replace illegal characters in folder names by equivalents. If you switch this off, illegal characters will be just removed.
Make Windows compatible Especially useful for servers and sometimes external disks. Make sure names are compatible with Windows.
Use tags from indexer Enable meta-tags coming from indexers or from the content of the NZB. These tags contain cleaned up versions of titles, episode names, etc. If you prefer that everything is derived from the NZB name, disable.

Quota

If you're unlucky enough to have an ISP that uses strict download caps, you may want to set a monthly quota for SABnzb.
Size In bytes. Example: 5G (for 5 GB) or 1T (for 1 TB)
Period Daily, Weekly or Monthly quota
Reset day The day of the week or month when your ISP will reset your cap. Use 31 for the last day of the month. Optionally you can add a time of day, like 23:30.
  • So for monthly you would enter 20 23:30, meaning the 20th of each month at 11:30PM.
  • For weekly 2 4:00, meaning every Tuesday at 4AM.
  • Even daily is possible: 3:00
Auto resume Set this on when you want to resume downloading once the quota has been reset. Otherwise you will have to resume manually

Please note file following:

  • Jobs with "Force" priority will ignore the paused state.
  • Pausing is never immediate. All already requested articles will be received and processed. They probably would be counted by your ISP any way.
  • Don't set the quota too high. Leave room for other Internet use.

Indexing

INFORMATION The protocol that SABnzbd uses can be found here if you want to implement this in your indexer: Indexer feedback.

Enable Indexer Integration Set this to enable enhanced functionality including ratings and extra status information is available when connected to a supported indexer.
Server address Set this to the server address provided by your indexer. Not all indexers support this methods, check with your indexer. NOTE Enter just the plain domain here, do not include https:// at the start of the address.
API Key Insert your Indexer API key in here. Check your profile on the indexer's website.
Enable Automatic Feedback When this setting is enabled SABnzbd will send feedback on failed downloads back to the indexer.
Enable Filtering Based on the rating supplied by the indexer at time the NZB is added, you can automatically pause or abort jobs that do not meet the specified criteria.

Multi-core PAR2

The Win32 distribution of SABnzbd now comes with a multi-core version of the PAR2 program which will see improvements for those with multi-core processors. For Linux you will need to locate the multi-core versions of par2 yourself, such as described here.
The behaviour of multi-core PAR2 can be influenced by an extra parameter. This option is only of use to users running the multi-core par2 version, so do not specify the value if you are running the normal (single-core) version of par2.
These are the choices:

-t- Use it single-core
-t0 Use multi-core for repairs but not for verify (prevents disk trashing)
-t+ Always use multi-core
You may need to experiment a bit to get the best behaviour for your system.

Should you have another variant of PAR2, you specify its required parameters here.

Note: if your system has problems with this program, you can force the use of the classic version by unchecking "Enable MultiCore Par2"

Par2cmdline

On many Linux distributions, par2cmdline is used to repair jobs. However, in version 0.6.13 a 'feature' was introduced that causes less blocks to be found. In order to restore optimal behavior, users of par2cmdline should add to Extra PAR2 parameters:

-N Extend the search for missing blocks (par2cmdline 0.6+, explanation see here)

Nice to reduce CPU priority

When SABnzbd runs external tools like par2 and unrar, these tools may use up all CPU capacity. If you set parameters in the nice option box, the tool will be used (if installed). You will need to experiment with the parameters. Leaving the box empty will disable the use of nice.
Popular parameters are -n10.
For more info, see the nice man-page

IONice to reduce disk priority

When SABnzbd runs external tools like par2 and unrar, these tools may use up all disk capacity This can make simultaneous use of the system problematic, e.g. when you want to watch a movie. If you set parameters in the ionice option box, the tool will be used (if installed). You will need to experiment with the parameters. Leaving the box empty will disable the use of ionice.
Popular parameters are -c2 -n4.
For more info, see the ionice man-page

Be careful, using wrong parameters will make all external tools fail!