Incorrect or missing information? Configure - Switches
You can download the most recent stable version (SABnzbd 1.2) on our downloads page.
|Check for new release||If enabled, SABnzbd will check once a week whether a new release has been published on SourceForge.net|
|Launch browser on startup||Enable to auto-launch of the browser when SABnzbd is opened.|
|Use 12 hour clock (AM/PM)||Show times in AM/PM notation (does not affect scheduler).|
|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|
|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.|
|Send group||Some news servers require the Usenet group to be sent before starting download. Only enable if (one of) your servers has problems with downloading otherwise.|
|SSL Type||Normally you use V23. For some ISP-s you may need either V2 or V3 to get optimal speed.|
|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]|
|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.|
|Detect duplicate downloads||This option will compair the name of the NZB file against all backed up older NZB files. This option only works when you have enabled NZB backup. However, for duplicate prevention in RSS feeds, you do not need the backup option.|
|Pause downloading during post-processing||Will pause the queue while verifying and repairing, only needed for resource-constrained systems (like NAS-devices)|
|Pause job when encrypted RAR is downloaded||For more info see Password-protected RARs|
|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.|
|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.|
|Pre-queue user script||See: User's pre-queue script|
|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.|
|Ignore samples||Do not download files that look like samples. Be careful, if you pick "do not download" then samples which are included in the main par2-set will lead to a failed download.|
|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 unrar||Allow the use of the UNRAR command for unpacking RAR files. Whether or not RAR files are actually unpacked is controlled by the job options.|
|Enable unzip||Allow the use of the UNZIP command for unpacking ZIP files. Whether or not ZIP files are actually unpacked is controlled by the job options.|
|Enable File Join||Allow the use of file joining of split files. Works only if the files are called file.001.ts, file.002.ts, file.003.ts etc.|
|Enable TS File Join||Allow the use of file joining of split files. Works only if the files are called file.001, file.002, file.003 etc.|
|Enable Par cleanup||Allows removal of PAR2 files after corrections of the download have been applied. Only set this to false when you have error correction problems with SABnzbd.|
|Fail on yenc crc Errors||Only important when using fill servers. When a primary server delivers a message with errors you can ignore the message and rely on PAR2 correction. You can also choose to try to download the message from a fill server, but this takes more time and bandwidth.|
|Process only verified jobs||When the download is incorrect and not repairable it may be safer to skip further post-processing.|
|Enable SFV-based checks||If no par2 files are available, SFV files (if present) will be used to check files|
|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.|
|Enable MultiCore par2||See Multi-core PAR2|
|Extra PAR2 parameters||See Multi-core PAR2|
|Nice parameters||See Nice to reduce CPU priority|
|IONice parameters||See IONice to reduce disk priority|
|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.|
|Size||Example: 5G or 1T|
|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.
|Enable OZnzb Integration||Set this to enable enhanced functionality including ratings and extra status information is available when connected to OZnzb indexer.|
|Site API Key||Insert your OZnzb API key in here, Your API Key can be found in your OZnzb user profile https://www.oznzb.com/profile.|
|Enable Automatic Feedback||When this setting is enabled SABnzbd will send feedback on failed downloads back to the indexer.|
*Note: you do not need to restart SABnzbd when editing the Indexing settings.
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 or macOS you will need to locate the multi-core versions of par2 yourself, such as this one for Linux.
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"
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!