The SABnzbd API can be reached via:
+http://host:port/sabnzbd/apiSupported output types are json, xml and text and can be specified in the request:
+
http://host:port/sabnzbd/api?output=jsonAPI requires the users API key to be supplied all API requests in order for it to work. The API key is randomly generated and is static unless the user decides to change the key. The user can see their API key on the General page of the configuration pages.
+ +http://host:port/sabnzbd/api?output=json&apikey=APIKEYIf the API-key is missing the request will return error: API Key Required, if it is incorrect: error: API Key Incorrect.
+
There is also a separate NZB key, which only allows for adding, modifying and removing jobs in the queue. When this key is used for something else, the request will return error: API Key Incorrect.
+
The version and auth functions do not require the API key.
NOTE In all examples below the apikey=APIKEY&output=json part is not shown but still necessary.
True/False Indicates the API will return the status, for some functions it's always true, even if the operation failed. Sorry about that!
+{% highlight json %}
+{
+ "status": true
+}
+{% endhighlight %}
+
| Function | +Description | +
|---|---|
| queue | +Full Queue output | +
| pause (queue) | +Pause whole queue | +
| resume (queue) | +Resume whole queue | +
| speedlimit | +Set speedlimit | +
| change_complete_action | +Action on queue complete | +
| sort | +Sort the queue | +
| addurl | +Add NZB by URL | +
| addfile | +Add NZB by file upload | +
| addlocalfile | +Add NZB by local file path | +
| pause (single job) | +Pause a single job | +
| resume (single job) | +Resume a single job | +
| delete | +Delete job | +
| purge | +Delete all jobs or based on keyword | +
| move | +Change position of job in queue | +
| change_cat | +Change job category | +
| change_script | +Change job script | +
| priority | +Change job priority | +
| change_opts | +Change job post-processing | +
| rename | +Change name and password of job | +
| get_files | +Get details of files in a job | +
| move_nzf_bulk | +Move file(s) inside a job | +
| delete_nzf | +Remove file(s) from a job | +
Full queue output with details about all jobs.
+api?mode=queue&start=START&limit=LIMIT&cat=CATEGORY&priority=PRIORITY&search=SEARCH&nzo_ids=NZO_ID_1,NZO_ID_2,NZO_ID_3NOTE Some of the less obvious output parameters are described below.
+ +| Input parameter | +Description | +
|---|---|
start optional |
+ Index of job to start at | +
limit optional |
+ Number of jobs to display | +
search optional |
+ Filter job names by search term |
+
category / cat optional |
+ Only return jobs with the specified category or categories (separated by a comma) + Use * for Default
+ |
+
priority optional |
+ Only return jobs with the specified priority or priorities (separated by a comma)
+
|
+
status optional |
+ Only return jobs with the specified status or statuses (separated by a comma)
+
|
+
nzo_ids optional |
+ Only return jobs with these nzo_ids (separated by a comma) |
+
| Output parameter | +Description | +
|---|---|
speedlimit |
+ In percentage of maximum set by user | +
speedlimit_abs |
+ In bytes/s | +
labels |
+ Labels like DUPLICATE, ENCRYPTED and PROPAGATING X min |
+
unpackopts |
+ See change_opts | +
Pauses the whole queue (do not confuse this will pausing an individual download, this is a global pause).
+api?mode=pausePauses for value minutes.
api?mode=config&name=set_pause&value=50Resumes the whole queue (do not confuse this will resuming an individual download, this is a global pause).
+api?mode=resumeSets the speedlimit to value in percentage of the maximum line speed (set by user).
api?mode=config&name=speedlimit&value=30 It can also be followed by K,M to define speedlimit in KB/s,MB/s, respectively.
+
api?mode=config&name=speedlimit&value=400KNOTE In SABnzbd 0.7.20 and below the value is always interpreted as KB/s, no percentages.
Set an end-of-queue action
+api?mode=queue&name=change_complete_action&value=ACTIONOptions: +
hibernate_pcstandby_pcshutdown_programscript_, for example script_test.pyOn some systems additional packages are required to allow SABnzbd to control power states, if there are problems in queue it will show as power_options=false.
+
+
Sort the queue by avg_age, name or size in asc or desc order.
+
api?mode=queue&name=sort&sort=avg_age&dir=descAdd NZB using an URL that needs to be accessible by SABnzbd, so make sure to include authentication information if the Indexer requires it. Example of a full request with everything set to default values is shown below, but only the name parameter is required.
api?mode=addurl&name=https%3A%2F%indexer.info%2Fget.php%3Fguid%3Ded731c0b37f25f84aea563d6ddb210b1%26api%3D6f235b80fab0c76e1ce7da21b2c6c48c&nzbname=&cat=*&script=Default&priority=-100&pp=-1Returns the nzo_id of the job:
| Input parameter | +Description | +
|---|---|
name |
+ URL-encoded version of the link to the NZB to be fetched. | +
nzbname optional |
+
+ Name of the job, if empty the NZB filename is used. + |
+
password optional |
+ + Password to use when unpacking the job. + | +
cat optional |
+ Category to be assigned, * means Default. List of available categories can be retrieved from get_cats. |
+
script optional |
+ Script to be assigned, Default will use the script assigned to the category. List of available scripts can be retrieved from get_scripts. |
+
priority optional |
+ Priority to be assigned:
+
|
+
pp optional |
+ Post-processing options:
+
|
+
Upload NZB using POST multipart/form-data. In your form, set the value of the field mode to addfile; the file data should be in the field name or the field nzbfile.
+
For other parameters and output see addurl.
Upload NZB from a location on the file system that SABnzbd can access. The path should be URL-encoded.
For other parameters and output see addurl.
+
Example of adding a file E:\Downloads\Movie.BRRip.x264.1080p-NPW.nzb:
+
+
api?mode=addlocalfile&name=E%3A%5CDownloads%5CMovie.BRRip.x264.1080p-NPW.nzb&nzbname=The.Job.Name&cat=*&script=Default&priority=-100&pp=-1Pause a single job based on its nzo_id. Returns a boolean status, and a list of affected nzo_ids.
api?mode=queue&name=pause&value=NZO_IDResume a single job based on its nzo_id. Returns a boolean status, and a list of affected nzo_ids.
api?mode=queue&name=resume&value=NZO_IDDelete job(s) based on nzo_id. Returns a boolean status, and a list of affected nzo_ids.
NOTE By default already download files of a job are not removed, add del_files=1 to have all files removed.
api?mode=queue&name=delete&value=NZO_IDDeleting multiple items:
+api?mode=queue&name=delete&value=NZO_ID_1,NZO_ID_2,NZO_ID_3Deleting all items:
+api?mode=queue&name=delete&value=all&del_files=1Remove all jobs from the queue, or only the ones matching search. Returns nzb_id of the jobs removed.
api?mode=queue&name=purge&search=SEARCH&del_files=1NOTE By default already download files of a job are not removed, add del_files=1 to have all files removed.
Job's can be switched by providing 2 nzo_id, value is the item you want to move, value2 is the name of the job where you want to put value one above, shifting job value2 down.
+
api?mode=switch&value=NZO_ID_1&value2=NZO_ID_2You can also move to a specific location in the queue, where 0 is the top of the queue:
api?mode=switch&value=NZO_ID&value2=2Both commands will return the new position and priority, since a job's location is also dependent on its priority:
+{% highlight json %} +{ + "result": { + "priority": 0, + "position": 2 + } +} +{% endhighlight %} + +Change category of job with nzo_id. List of available categories can be retrieved from get_cats.
api?mode=change_cat&value=NZO_ID&value2=CategoryChange script of job with nzo_id. List of available scripts can be retrieved from get_scripts.
api?mode=change_script&value=NZO_ID&value2=script.pyChange priority of job with nzo_id.
-100 = Default Priority (of category)-4 = Stop-3 = Duplicate-2 = Paused-1 = Low Priority0 = Normal Priority1 = High Priority2 = Forceapi?mode=queue&name=priority&value=NZO_ID&value2=0The command will return the new position, since a job's location also depends on its priority:
+{% highlight json %} +{ + "position": 42 +} +{% endhighlight %} + +Change post-processing of job with nzo_id.
0 = None1 = +Repair2 = +Repair/Unpack3 = +Repair/Unpack/Deleteapi?mode=change_opts&value=NZO_ID&value2=0Change name and password of job with nzo_id.
+
NOTE value3 can be empty, but to set a password value and value2 must also be filled, using the current name.
+
api?mode=queue&name=rename&value=NZO_ID&value2=NEW_NAME&value3=PASSWORDOr you can set a password as part of the new name in value2, see: RAR with password.
+{% raw %}
api?mode=queue&name=rename&value=NZO_ID&value2=NEW_NAME{{PASSWORD}}Get files of job with nzo_id.
api?mode=get_files&value=NZO_IDThe status indicates if a file was finished, in the process of being downloaded (active) or will only be downloaded when necessary (queued, like .par2 files). The set shows to which part of the download the .par2 files belong to, in case of multiple sets in 1 job. Files are sorted in order: finished, active, queued.
Move files specified by nzf_ids inside job nzo_id to top or bottom.
+ To move a file a size number of spots, use up or down.
NOTE New in 3.4.0+
+api?mode=move_nzf_bulk&name=LOCATION&value=NZO_ID&nzf_ids=NZF_ID,NZF_ID2&size=XRemove file(s) using nzo_id of the job and nzf_id of the file(s). Returns the nzf_ids of removed file.
NOTE Before 3.4.0 only single nzf_id could be used.
api?mode=queue&name=delete_nzf&value=NZO_ID&value2=NZF_ID,NZF_ID2| Function | +Description | +
|---|---|
| history | +Full history output | +
| retry | +Retry failed job | +
| retry_all | +Retry all failed jobs | +
| delete | +Delete history item | +
Full history output with details about all jobs. The queue and the history output share many common fields, but the history also contains statistics about how much has been downloaded in the past day, week, month and total.
api?mode=history&start=START&limit=LIMIT&cat=CATEGORY&search=SEARCH&nzo_ids=NZO_ID_1,NZO_ID_2,NZO_ID_3&failed_only=0NOTE Some of the less obvious output parameters are described below.
+| Input parameter | +Description | +
|---|---|
start optional |
+ Index of job to start at | +
limit optional |
+ Number of jobs to display | +
search optional |
+ Filter job names by search term |
+
category / cat optional |
+ Only return jobs with the specified category or categories (separated by a comma) + Use * for Default
+ |
+
status optional |
+ Only return jobs with the specified status or statuses (separated by a comma)
+
|
+
nzo_ids optional |
+ Only return jobs with these nzo_ids (separated by a comma) |
+
failed_only optional |
+ Only show failed jobs (shorthand for status=Failed) |
+
last_history_update optional |
+ Only return full output if anything has changed since last_history_update, the last update is given by a previous call to history |
+
| Output parameter | +Description | +
|---|---|
series |
+ How SABnzbd identified the show and season/episode info | +
pp |
+ Different format than the queue:
+
|
+
path |
+ Temporary destination | +
storage |
+ Final destination | +
loaded |
+ If true, item is post-processing |
+
Retry history item(s) based on nzo_id. Optionally provide a password and an additional NZB as POST multipart/form-data in the nzbfile field.
NOTE Pay attention to the different variable names used here: value and nzbfile.
api?mode=retry&value=NZO_ID&password=passwordWill retry all failed jobs in the history. However, you are not able to supply passwords or extra NZB's. +
api?mode=retry_allDelete history item(s) based on nzo_id.
NOTE By default files of failed jobs are not removed, add del_files=1 to also have them removed.
api?mode=history&name=delete&value=NZO_IDDeleting multiple items:
+api?mode=history&name=delete&value=NZO_ID_1,NZO_ID_2,NZO_ID_3Deleting all items:
+api?mode=history&name=delete&value=allDeleting all failed items:
+api?mode=history&name=delete&value=failedNOTE Added in 3.4.0, older versions only have fullstatus. + +
| Function | +Description | +
|---|---|
| status / fullstatus | +All status information | +
| unblock_server | +True/False Unblock server | +
| delete_orphan | +True/False Delete orphaned job | +
mode=status name=delete_all_orphan |
+ True/False Delete all orphaned jobs | +
| add_orphan | +True/False Retry orphaned job | +
mode=status name=add_all_orphan |
+ True/False Retry all orphaned jobs | +
Get all status information available from SABnzbd. Below are only the values that are different from calls to queue.
NOTE Added status in 3.4.0, older versions only have fullstatus.
NOTE Getting the public IPv4 address might take some time, so it can be skipped by setting skip_dashboard=1. To calculate performance measures, add calculate_performance=1.
api?mode=status&skip_dashboard=0NOTE Some of the less obvious output parameters are described below.
+ +| Output parameter | +Description | +
|---|---|
darwin |
+ true when OS running SABnzbd is macOS |
+
nt |
+ true when OS running SABnzbd is Windows |
+
folders |
+ The orphaned job folder left in the Incomplete folder. Orphaned jobs can only be removed from a skin, not through the API | +
pystone |
+ Indication of CPU speed, see Highspeed Downloading | +
loadavg |
+ On Linux this will contain a string with information about system load | +
Unblock server based on servername from the status.
api?mode=status&name=unblock_server&value=SERVERNAMEDelete orphaned job based on the folder name from the status. Make sure that you URL-encode the folder name.
+ +api?mode=status&name=delete_orphan&value=FOLDERNAMERetry orphaned job based on the folder name from the status. Make sure that you URL-encode the folder name.
+ +api?mode=status&name=add_orphan&value=FOLDERNAMENOTE Other functions are listed below, some straightforward commands are described only in this table and can simply be activated by calling:
+api?mode=FUNCTION| Function | +Description | +
|---|---|
version |
+ Get version of running SABnzbd | +
auth |
+ Get authentication methods available for interaction with the API | +
| warnings | +Get all active warnings | +
| warnings clear | +True/False Clear all active warnings | +
| get_cats | +Get all categories | +
| get_scripts | +Get all scripts | +
| server_stats | +Get download statistics | +
| showlog | +Get the anonymized log file | +
| del_config | +True/False Delete a configuration item within the "servers", "rss", "categories", or "sorters" sections. | +
| get_config | +Get value of configuration item | +
| set_config | +Set configuration item to value | +
| set_config_default | +True/False Reset config item to default value | +
shutdown |
+ True/False Shutdown SABnzbd | +
restart |
+ True/False Restart SABnzbd | +
restart_repair |
+ True/False Restart SABnzbd and perform a queue repair | +
pause_pp |
+ True/False Pause post-processing queue | +
resume_pp |
+ True/False Resume post-processing queue | +
rss_now |
+ True/False Fetch and process all RSS feeds | +
watched_now |
+ True/False Scan Watched Folder now | +
reset_quota |
+ True/False Reset the user defined quota to 0 | +
mode=config name=set_apikey |
+ Reset the API key, returns the new key | +
mode=config name=set_nzbkey |
+ Reset the NZB key, returns the new key | +
mode=config name=regenerate_certs |
+ True/False Regenerate the self-signed certificate for HTTPS connection to interface, requires SABnzbd restart to take effect | +
| translate | +Translate a text to user's locale | +
api?mode=get_catsapi?mode=get_scriptsReturn download statistics in bytes, total and per-server. +
api?mode=server_statsThe log file is automatically anonymized and a copy of the sabnzbd.ini is attached.
NOTE This call ignores the output parameter, it will always serve the file as a download.
api?mode=showlogUsed to delete an entry from the limited sections.
+ +Example of deleting aservers by keyword:
+api?mode=del_config§ion=servers&keyword=ServerNamerss by keyword:
+api?mode=del_config§ion=rss&keyword=Feed1categories by keyword:
+api?mode=del_config§ion=categories&keyword=audioIf you attempt to delete the default category * from the categories section, the system will replace the default categories.
+
api?mode=del_config§ion=categories&keyword=*You can read the whole configuration, a sub-set or a single setting.
+NOTE You will never receive passwords, each character will be replaced by *** characters. You can set new passwords through the set_config call.
api?mode=get_configmisc section:
+api?mode=get_config§ion=miscapi?mode=get_config§ion=servers&keyword=ServerNameIn order to change a setting, you need to provide the section and keyword of the setting:
api?mode=set_config§ion=SECTION&keyword=KEYWORD&value=VALUEReturns the new setting when saved successfully.
+For example, changing the Cleanup-list to .sfv,.nzb,.nfo,.ext would look like this:
api?mode=set_config§ion=misc&keyword=cleanup_list&value=.sfv,.nzb,.nfo,.extChanging settings for these sections is a bit different and requires one to specify the correct name of the server, RSS feed, category, or sorter. This name you can find in between double square brackets in the relevant section of your sabnzbd.ini, where it will for example say [[news.newshosting.com]] within the [servers] section, or [[Feed1]] in the [rss] section, and so on. Below the name you can see all variables you could set via the API for an item in that section. If the specified name doesn't match an existing one in the given section, it will be added there as a new item.
Server example:
+api?mode=set_config§ion=servers&name=SERVER_NAME&username=VALUE_1&connections=VALUE_2Category example:
+api?mode=set_config§ion=categories&name=CATEGORY_NAME&dir=CATEGORY_DIRRSS feed example:
+api?mode=set_config§ion=rss&name=FEED_NAME&enable=VALUE_1&pp=VALUE_2Sorter example:
+api?mode=set_config§ion=sorters&name=SORTER_NAME&sort_string=VALUE_1&sort_cats=VALUE_2&sort_type=VALUE_3NOTE Currently only for settings in the misc section of the config. Can accept multiple keywords to reset.
api?mode=set_config_default&keyword=SETTING_1&keyword=SETTING_2api?mode=warningsapi?mode=warnings&name=clearTranslate any text known to SABnzbd from English to the locale setting of the user. +
api?mode=translate&value=Watched%20FolderWill return for Dutch: +{% highlight json %} +{ + "value": "Bewaakte map" +} +{% endhighlight %} diff --git a/wiki/configuration/4.3/categories.html b/wiki/configuration/4.3/categories.html new file mode 100644 index 00000000..a754f2df --- /dev/null +++ b/wiki/configuration/4.3/categories.html @@ -0,0 +1,37 @@ +--- +title: Categories +--- + +
+ User-defined categories allow precise control over groups of downloads. When added to the queue, downloads can be placed in the appropriate category automatically depending on your settings. The download's category may also be manually applied later. +
+ +* will prevent creation of job folders.+ NOTE Each row has its own save button. Remember to hit Save after each category change! +
+ + +
+ By default, downloads are automatically categorized by the indexer providing a category inside the nzb or the newsgroup in which the job is located (i.e., alt.binaries.teevee). Categories can be re-ordered to set the order in which matching should happen. For example this way you can put Movies > 4K in a special category and the rest of the movies in a categories with just the indexer tag Movies.
+
+ Basic wildcards are supported. For example, some indexers uses sub-categories like TV > HD. Instead of listing all possible categories, you may simply use TV*. The same applies to newsgroups (i.e., alt.bin*).
+
OS-specific default locations for the settings below can be found here.
+| Temporary Download Folder | +Enter the path to a folder SABnzbd can use to store files as they are downloaded. Once the file is complete, it will verify then extract to the Complete Folder. You can just enter "Incomplete" to keep it relative to your Base Folder or enter the full path such as C:\Incomplete and SABnzbd will create the folder. |
+
| Minimum Free Space for Temporary Download Folder Advanced |
+ There should be enough space to contain the largest complete job + 10% to repair jobs. When free space on the drive that holds the temporary folder is below this, SABnzbd is automatically pauses. You enter the amount in bytes but you can use factors like K, M, G etc. |
+
| Completed Download Folder | +The completed download folder is the default download location for all items, unless indicated otherwise from the Categories page. | +
| Minimum Free Space for Completed Download Folder Advanced |
+ There should be enough space to contain the largest complete job and some more if the extracted files are larger when unpacked. When free space on the drive that holds the complete folder is below this, SABnzbd is automatically paused. You enter the amount in bytes but you can use factors like K, M, G etc.
+ NOTE Will not work if a category folder is on a different disk than the main Complete Download Folder. |
+
| Auto resume Advanced |
+ Downloading will automatically resume if the minimum free space is available again. Applies to both the Temporary and Complete Download Folder. Checked every few minutes. | +
| Permissions for completed downloads Advanced |
+ Set permissions pattern for completed files/folders using octal notation, for macOS and Linux only. Example: 755 or 777, see: Unix permissions. |
+
| Watched Folder | +
+ This is a folder that is periodically checked for new NZB files. When a file is stored in this folder, SABnzbd will consider this a download job. It will scan the folder and processes the supported files: The Watched Folder supports Categories in two ways: +
|
+
| Watched Folder Scan Speed Advanced |
+
+ Number of seconds between filesystem scans of the Watched Folder setting above.
+ Setting it to 0 disables the automatic scans, but scans can still be triggered from the menu on the main page.+ |
+
| Scripts Folder | +This specifies the folder where user scripts (post-processing and pre-queue) are stored. On Windows, users may specify a .cmd or .bat file; other extensions can be executed with the PATHEXT variable. On Unix any installed script type can be used, including common choices such as shell or Python, provided the file is executable (chmod +x file) and starts with a valid shebang line. Read more about creating Post-processing and Pre-queue scripts. |
+
| Email Templates Folder Advanced |
+ You can define your own Email Templates. | +
| Password File Advanced |
+ A text file of known passwords, one password per line, that should be attempted on passworded RAR files. See also Password-protected RARs. WARNING Checking passwords takes time, do not list more than ~20 passwords in this file! |
+
OS-specific default locations for the settings below can be found here.
+| Administrative Folder Advanced |
+ Location for queue, admin and history database. | +
| Backup Folder Advanced |
+
+ Location where the backups of the configuration file and databases are stored. + If left empty, the backup will be created in the Completed Download Folder. + See also Create Backup. + |
+
| Log Folder Advanced |
+ This folder holds error/warning/info/debug logging data. | +
| .nzb Backup Folder Advanced |
+ When SABnzbd adds an nzb to the queue it creates a local of the NZB file in this folder. If you leave this box empty, no files will be saved. | +
| SABnzbd Host | +
+ The hostname that will be used to access SABnzbd.
+
+
|
+
| SABnzbd Port | +
+ The internal webserver needs a port to listen on. The default port is 8080. Try another one if this address is already occupied by another program on your computer.
+ NOTE macOS and Linux users: ports below 1025 may require SABnzbd launched as root.
+ |
+
| Web Interface Theme |
+ The look and feel of the web interface. SABnzbd must be restarted for the changes to take effect. | +
| Language | +The program supports more languages. NOTE Help us translate SABnzbd in your language: add untranslated texts or improved existing translations. |
+
| Enable HTTPS | +
+ Enable the webserver to use HTTPS. + For more information, see: HTTPS. + NOTE Modern web browsers and other clients will not accept self-signed certificates and will give a warning and/or won't connect at all. + |
+
| HTTPS Port Advanced |
+ Port to be used for listening. Must be different from the normal HTTP port. If empty, the SABnzbd Port set above will only listen to HTTPS (this is the default setting). | +
|
+ HTTPS Certificate + HTTPS Key + HTTPS Chain Certificates + Advanced + |
+ Files containing the HTTPS certificate, key and (optionally) chain Certificates. | +
|
+ SABnzbd Username + SABnzbd Password + |
+ You may want to limit access to the web interface to people knowing a username and password for the interface. | +
| External internet access | +
+ Set the access level for connections from outside the local network.
|
+
| API Key | +This is the secret key that is needed in API calls. NOTE When you click the Change button, you'll need to tell your utilities the new key. |
+
| NZB Key | +
+ This is similar to the API Key, but only allows external applications to add NZB's. + NOTE After adding NZB's, external applications do not have access to the queue to monitor the progress of the download. + NOTE When you click the Change button, you'll need to tell your utilities the new key. + |
+
| Launch browser on startup | +Enable to auto-launch of the browser when SABnzbd is started. | +
| Check for new release | +If enabled, SABnzbd will check once a week whether a new release has been published. | +
| HTTPS certificate verification Advanced |
+ Verify certificates when connecting to indexers and RSS-sources using HTTPS. Some websites do not have proper certificates and some systems might not be configured correctly. | +
| SOCKS5 Proxy Advanced |
+ Connection information is entered as a URL, ie:
+
|
+
| Maximum line speed | +Set how fast your internet connection is, in bytes/sec. NOTE If you have an ISP-speed of 10Mbit/sec, you should enter 1MB/s here. |
+
| Percentage of line speed Advanced |
+ Which percentage of the line speed should SABnzbd use, e.g. 50. This value is used as the default value when SABnzbd starts. Setting a value of 0 disables any limit. |
+
| Article Cache Limit Advanced |
+
+ How much memory (RAM) can be used for caching (reducing disk access). This value is set automatically when SABnzbd is started for the first time to 25% of the system's memory or
See High speed downloading for more information. |
+
| Create backup | +
+ Create a backup of the configuration file and databases in the Backup Folder.
+ If the Backup Folder is not set, the backup will be created in the Completed Download Folder. + You can also schedule a recurring backup in Scheduling. + WARNING The backup contains all sensitive information like your passwords and API keys! + NOTE The backup can only be created in this folder to prevent an attacker easy access to all your passwords and API-keys if they somehow manage to enter the configuration. + |
+
| Restore backup | +Restore a backup of the configuration file and databases. | +
SABnzbd can send you emails about completion of jobs and about disk almost full condition. + You can send email through the SMTP server of your ISP. This is generally the easiest option, that doesn't require you to set a user account and password. + SABnzbd will try to use SSL secured email when supported by the mail server (this normally requires a user account and password). + Even Google mail (gmail.com) is possible. +
+It's possible to create your own email format by using templates.
+| Errors | +Send an email when a download fails for any reason | +
| End-of-job notifications | +Send an email after each job is completed and fully post-processed | +
| Disk full notifications | +Send an email when SABnzbd paused because the disk is almost full | +
Check your email provider's instructions for the proper values.
+| SMTP server | +The mail server you use (eg smtp.my-isp.com). If needed you can append a non-standard mail port (e.g. special.my-isp.com:455) | +
| Email recipient | +The email address to which the emails must be sent. | +
| Email sender | +The email address of the sender. This can be a fake address, but you emails may be flagged as spam. Especially when you also set an account name and password, it is better to use your own real email address. | +
| Account name | +User name of the email account used to send the emails. | +
| Account password | +Password of the email account used to send the emails. WARNING this password is stored as plain text in the INI file. |
+
| SMTP server | +smtp.gmail.com:587 | +
| Email recipient | +you@gmail.com | +
| Email sender | +you@gmail.com This can be a fake address, but you will have to put it in your Gmail contact list, otherwise Google will think you are sending spam. | +
| Account name | +you@gmail.com | +
| Account password | +password | +
Please note that Gmail security has become a lot stricter.
+ If you are using two-factor authentication then you need to create an "application-specific" password for SABnzbd.
+ See: https://support.google.com/mail/answer/1173270?hl=en
+
If not, then SABnzbd is only allowed to access Gmail when you allow "less secure apps".
+ See: https://www.google.com/settings/security/lesssecureapps
+
For security reasons we recommend that you create a separate email account, just to send SABnzbd emails.
+ +SABnzbd can send notifications to several notification services.
+ All events that can produce a notification are assigned to a group.
+ Such groups can be enabled per notification services.
+ Additionally, you can specify for the job related notifications if they only should be send for specific categories.
+
| Group | +Events | +
|---|---|
| Startup/Shutdown | +Startup, Shutdown | +
| Pause/Resume | +Pause, Resume | +
| Added NZB | +New NZB's are added | +
| Post-processing | +Post-processing started | +
| Job finished | +Job finished | +
| Job failed | +Job failed | +
| Queue finished | +Queue finished | +
| User logged in | +Successful login (HTML form only) | +
| Warning | +Warning | +
| Error | +Error | +
| Other | +URL fetching failed, Shutdown finished, New release available | +
Windows will show a modest text balloon connected to SABnzbd's System Tray icon.
+ +Standard macOS Notification Service.
+ Only when you're using our signed app, you will see SABnzbd's icon.
+
Some Linux systems support the NotifyOSD protocol.
+ When SABnzbd detects support for this protocol, it will allow you to enable the service.
+
Allows implementation of custom notification services. See Notification Scripts.
+NZB-Notify's notification script provides a very wide range of notification services, listed here.
+Scripts Folder.nzb-notify-master folder to the Scripts Folder.Scripts Folder.pip install -r requirements.txt (on some systems you might have to replace pip by pip3).sabnzbd-notify.py in Config->Notifications.kodi://192.168.0.2 in the Parameters section.
+ You can specify more than one URL here by simply using a comma (,) as a delimiter.+ SABnzbd can read RSS-feeds provided by indexers or public RSS websites. + These sites offer the latest downloads or return results based on a query. For a list of supported RSS sites, see here. +
+
+ Each feed is analyzed using filters.
+ A filter looks for a text-pattern in the title of entries and will reject or accept a job based on that pattern.
+ A filter "matches" a title if the filter text is found inside that title.
+ You can add * to match arbitrary parts of the title or ? for one arbitrary character at that place.
+ The filters are analyzed in order and the first one matched will be selected.
+
+ Suppose you subscribe to a feed and the output of titles in this feed is: +
+My first baby steps hdtv xvid Part 1
+You and me and the dog Part 1
+You and me and the dog Part 2
+My first teen steps hdtv xvid Part 1
+My first baby steps xvid Part 1
+My first baby steps hdtv xvid Part 2
+The making of My first baby steps xvid hdtv
+Now, suppose you want to get all My ... first steps episodes, but only when marked hdtv and you're not interested in Making of:
Reject || making of
+Accept || first*steps*hdtv
+The Reject filter should be placed first, otherwise the Accept filter will also pick the Making of.
+ It's also possible to setup a Required filter.
+ This means that the following filters are only applied when a title matches the Required filter.
+
+ For example: if you are only interested in hdtv format, you would create filters like this:
+
Reject || making of
+Requires || hdtv
+Accept || first*steps
+Accept || second*steps
+
+ For each feed you can set the category or the job options for all jobs in the feed in the top row, or for each Accept filter specifically.
+ If all category settings are left as Default and the indexer category matches one of your categories (by category name or by custom Indexer tag), it will be automatically assigned to that category.
+
+ The assigned or automatically matched category is shown in the Category column. +
+ + +| Filter name | +Meaning | +
|---|---|
Accept |
+ Accept job when the title matches the expression. If not matched, go to next filter. |
+
Requires |
+ Require job title to contain this expression. If matched, go to next filter. If not matched, reject job. |
+
Reject |
+ Reject job when the title matches the expression. If not matched, go to next filter. |
+
RequiresCat |
+ Require job to have this category (after mapping the indexer category to your own categories). If matched, go to next filter. If not matched, reject job. |
+
At Least |
+ The size of the job should be at least this. You can use K/M/G notation, where 100M means at least 100Mbyte. If size correct, go to next filter. If size not correct, reject job. |
+
At Most |
+ The size of the job should be at most this. You can use K/M/G notation, where 200M means at most 200Mbyte. If size correct, go to next filter. If size not correct, reject job. |
+
From SxxEyy |
+ Only this season/episode and newer will be accepted. If matched, go to next filter. If not matched, reject job. |
+
From Show SxxEyy |
+
+ Accept this and newer episodes of this specific show. Accept if matched. If not matched, go to next filter. + Directly accepts job, this permits multiple shows in a single feed. + |
+
WARNING The , (comma) and # characters are not allowed.
NOTE The From SxxEyy and From Show SxxEyy will only work when SABnzbd recognizes the season/episode notation in the job title. Wildcards (* and ?) are not supported.
NOTE The RequireCat only works for indexers whose categories have been mapped to your own.
NOTE Some websites require the inclusion of authentication details in the URL. Please check with your feed provider.
+ + +| Read feed | +Read the RSS source again and apply the filters. | +
| Force download | +Send all matching items to the queue. | +
| Clear download | +Clear the list of items already sent to the queue. | +
| Apply Filters | +New or altered filters are not directly applied to existing results, click this button to re-filter the results. | +
+ If you prefix a filter with re: it will be interpreted as a Python regular expression (case-insensitive).
+
+ Here's a tutorial on regular expressions. + For all the details see the Python manual. +
+
+ Simple example: re: this|that will match all jobs containing this or that in the title.
+
+ If you check the checkbox next to the name of the feed, it will be automatically processed. The time between scans can be set with RSS checking rate. This can be overridden by using the Scheduler.
+
+ To prevent the download of a (potentially) large backlog, the first batch of NZBs will not automatically download. These lines are marked with an asterisk *. If you want these matched feed items in this first batch to download, click the Force Download button.
+
+ Then, new feed items in subsequent RSS reads will download automatically (if the feed is enabled). +
diff --git a/wiki/configuration/4.3/scheduling.html b/wiki/configuration/4.3/scheduling.html new file mode 100644 index 00000000..c60f97b3 --- /dev/null +++ b/wiki/configuration/4.3/scheduling.html @@ -0,0 +1,115 @@ +--- +title: Scheduling +--- +You can use the scheduler to set up tasks to be performed at specific days and times. Each schedule block is repeated one per week or every day.
+ +| Action | +Description | +
|---|---|
| Resume | +Continue downloading, Watched Folder scanning and RSS feed readouts. | +
| Pause | +
+ Stop downloading + NOTE Will pause at startup if not combined with a scheduled Resume. + |
+
| Pause-all | +Stop downloading, Watched Folder scanning and RSS feeds, stops all disk activity. | +
| Shutdown | +Exit SABnzbd. | +
| Restart | +Restart SABnzbd. | +
| Speedlimit | +Set the speedlimiter to the given % value. This can also be in K/M/G notation, for example 4.5M will set the speedlimit to 4.5MB/s. |
+
| Pause post processing | +Halt post-processing (except active job), while downloading continues. | +
| Resume post processing | +Will resume post-processing, while downloading continues. | +
| Scan watched folder | +Read watched folder (this will disable the interval in Folders). | +
| Create backup | +Create a scheduled backup of the configuration file and databases in the Complete Download Folder. | +
| Read RSS feeds | +Read all RSS feeds (this will disable the interval in RSS). | +
| Remove failed jobs | +Remove all jobs in history that have failed to complete, including their files. | +
| Remove completed jobs | +Remove all jobs in history that have completed successfully. | +
| Pause low/normal/high priority jobs | +All jobs with a low/normal/high priority will set to paused mode. | +
| Resume low/normal/high priority jobs | +All jobs with a low/normal/high priority will be resumed. | +
| Enable/Disable quota management | +See Quota. | +
Enable/Disable server-name |
+ Enable or disable a server on the given time. | +
Pause/Resume category-name | All jobs within the selected category will be paused/unpaused. | +
NOTE On startup, SABnzbd will evaluate all schedules and determine the current pause/resume state and speedlimit. The -pause command-line parameter will override this evaluation.
NOTE On each schedule change, the schedule will be re-evaluated and the speedlimit will be set. If SABnzbd happened to be paused, it will NOT be resumed by the schedule evaluation. This is to prevent spontaneous resumption during schedule changes. +
+Suppose you only want to download on weekdays between 1:00AM and 5:30PM and in the weekend between 1:00 AM and 11:00AM.
+ You set this up using four schedule blocks.
+
Resume downloading every day at 1:00AM:
+ 01:00 Daily Resume
+
Pause downloading every day at 5:30PM (= 17:30 military time):
+ 17:30 Daily Pause
+
Pause downloading on Saturday 11:00AM:
+ 11:00 Saturday Pause
+
Pause downloading on Sunday 11:00AM:
+ 11:00 Sunday Pause
+
Enable server on Monday 6:00AM:
+ 06:00 my.usenet.com:119 1
+
+ SABnzbd can run a user-provided script to be executed when a notification needs to be sent. + In Config->Notifications you can specify for which type of notifications the script should be executed.
+
+ Scripts can be Python scripts, bash scripts and BAT scripts. All scripts must be located in the scripts-directory, that can be specified in Config->Folders. Furthermore, the script must be executable. On Linux this means the x-bit must be on. On Windows, the requirement is that the script's extension is listed in your system's PATHEXT environment variable.
+
NZB-Notify's notification script provides a wide range of notification services, extending on the built-in providers of SABnzbd.
+ + The script will receive the parameters described below.
+ Use %1 in Windows scripts and $1 in Unix scripts. Note that on Windows the input parameters are surrounded by quotes (e.g. "job name").
+
| Position | +Description | +
|---|---|
| 1 | +Type of notification
+
|
+
| 2 | +The title of the notification in the user's language | +
| 3 | +The notification message | +
Environment variable: SAB_NOTIFICATION_PARAMETERS |
+ Parameters (can be specified in Config->Notifications) | +
When all went well, SABnzbd expects exit code 0. If an error occurred or something else than 0 is returned, the output will be shown to the user as an error.
The get the parameters in python, you can do this:
+{% highlight python %} +import os +import sys +try: + (scriptname, notification_type, notification_title, notification_text) = sys.argv +except: + print("No commandline parameters found") + sys.exit(1) + +parameters = os.environ.get("SAB_NOTIFICATION_PARAMETERS") + +# continue script + +# Your code goes here + +# Success code +sys.exit(0) +{% endhighlight %} diff --git a/wiki/configuration/4.3/scripts/post-processing-scripts.html b/wiki/configuration/4.3/scripts/post-processing-scripts.html new file mode 100644 index 00000000..994af9b2 --- /dev/null +++ b/wiki/configuration/4.3/scripts/post-processing-scripts.html @@ -0,0 +1,290 @@ +--- +title: Post-processing scripts +redirect_from: "/wiki/advanced/user-scripts" +--- + ++ SABnzbd can run a user-provided post-processing scripts. The scripts can be associated with a job entry when adding the job manually, via category or during downloading. Scripts can also be run as an end-of-queue event. + A post-processing script will only run when the job has completed without errors. + If you want to always run the script, you need to disable the option Post-Process Only Verified Jobs. +
+ +
+ Scripts may use any scripting language available on your system; common choices are Python, Unix shell, and Windows batch scripts.
+ All scripts must be located in the Scripts-directory, specified in Config->Folders and must be executable.
+ On Unix-like operating systems (Linux, BSD, etc.) this means the x-bit must be on.
+ On Windows, the requirement is that the script's extension is listed in your system's PATHEXT environment variable.
+
+ The console output of the script is captured by SABnzbd and is saved in the so called "Script Log" which can be opened from the history details. + The output will be added to the (optional) notification email and can be examined in the History page. +
+ +
+ The "return" code that your script itself returns should be 0 if all went well or non-zero if errors occurred. If the return code is something else than 0, SABnzbd's History will show that return code (also known as exit code) as Exit(...) in the History. By default the job will not be flagged as failed in case the exit code is non-zero. In Config->Switches there is the option to let a non-zero code mark the job as failed.
+
+ Example scripts are included in the scripts directory of your SABnzbd installation and are shown at the end of this page.
+
The script will receive the parameters described below. Use %1 in Windows scripts and $1 in Unix scripts. Note that on Windows the input parameters are surrounded by quotes (e.g. "job name").
NOTE Much more information is available to scripts via environment variables, see below!
+ +| Position | +Description | +
|---|---|
| 1 | +The final directory of the job (full path) | +
| 2 | +The original name of the NZB file | +
| 3 | +Clean version of the job name (no path info and ".nzb" removed) | +
| 4 | +Indexer's report number (if supported) | +
| 5 | +User-defined category | +
| 6 | +Group that the NZB was posted in e.g. alt.binaries.x | +
| 7 | +Status of post processing.
+
|
+
| 8 | +URL to be called when job failed (if provided by the server, it is always sent, so check parameter 7!). The URL is provided by some indexers as the X-DNZB-Failure header |
+
Your script can get extra information via environment variables:
+| Variable | +Description | +
|---|---|
| SAB_SCRIPT | +The name of the current script | +
| SAB_NZO_ID | +The unique ID assigned to the job | +
| SAB_FINAL_NAME | +The name of the job in the queue and of the final folder | +
| SAB_FILENAME | +The NZB filename (after grabbing from the URL) | +
| SAB_COMPLETE_DIR | +The whole path to the output directory of the job | +
| SAB_PP_STATUS | +Was post-processing successfully completed (repair and/or unpack, if enabled by user) | +
| SAB_CAT | +What category was assigned | +
| SAB_BYTES | +Total number of bytes | +
| SAB_BYTES_TRIED | +How many bytes of the total bytes were tried | +
| SAB_BYTES_DOWNLOADED | +How many bytes were received (can be more than tried, due to overhead) | +
| SAB_DUPLICATE | +Was this a duplicate and what type | +
| SAB_DUPLICATE_KEY | +The key used for Smart Duplicate Detection | +
| SAB_UNWANTED_EXT | +Were there unwanted extensions | +
| SAB_OVERSIZED | +Was the job over the user's size limit | +
| SAB_PASSWORD | +What was the password supplied by the NZB or the user | +
| SAB_CORRECT_PASSWORD | +The password that was detected as being the correct password for this job (added in 3.4.0) | +
| SAB_ENCRYPTED | +Was the job detected as encrypted | +
| SAB_STATUS | +Current status (completed/failed/running) | +
| SAB_FAIL_MSG | +If job failed, why did it fail | +
| SAB_AGE | +Average age of the articles in the post | +
| SAB_URL | +URL from which the NZB was retrieved | +
| SAB_AVG_BPS | +Average bytes/second speed during active downloading | +
| SAB_DOWNLOAD_TIME | +How many seconds did we download | +
| SAB_PP | +What post-processing was activated (download/repair/unpack/delete) | +
| SAB_REPAIR | +Was repair selected by user | +
| SAB_UNPACK | +Was unpack selected by user | +
| SAB_FAILURE_URL | +Provided by some indexers as alternative NZB if download fails | +
| SAB_PRIORITY | +Priority set by user | +
| SAB_GROUP | +Newsgroup where (most of) the job's articles came from | +
| SAB_ORIG_NZB_GZ | +Path to the original NZB-file of the job. The NZB-file is compressed with gzip (.gz) |
+
| SAB_VERSION | +The version of SABnzbd used | +
| SAB_PROGRAM_DIR | +The directory where the current SABnzbd instance is located | +
| SAB_PAR2_COMMAND | +The path to the par2 command on the system that SABnzbd uses |
+
| SAB_MULTIPAR_COMMAND | +Windows-only (empty on other systems). The path to the MultiPar command on the system that SABnzbd uses | +
| SAB_RAR_COMMAND | +The path to the unrar command on the system that SABnzbd uses |
+
| SAB_ZIP_COMMAND | +The path to the unzip command on the system that SABnzbd uses |
+
| SAB_7ZIP_COMMAND | +The path to the 7z command on the system that SABnzbd uses. Not all systems have 7zip installed (it's optional for SABnzbd), so this can also be empty |
+
| PYTHONUNBUFFERED | +This variable is set to 1 when running a Python script (.py), in order to force Python to write output to SABnzbd directly instead of buffering it |
+
The get the parameters in python, you can do this:
+{% highlight python %} +import sys +try: + (scriptname, directory, orgnzbname, jobname, reportnumber, category, group, postprocstatus, url) = sys.argv +except: + print("No commandline parameters found") + sys.exit(1) + +# continue script + +# Your code goes here + +# Success code +sys.exit(0) +{% endhighlight %} + ++ You can choose to let SABnzbd run a script just before an NZB enters the queue. + This script determines whether the NZB should be accepted and can modify a number of job parameters. +
+
+ Scripts may use any scripting language available on your system; common choices are Python, Unix shell, and Windows batch scripts.
+ All scripts must be located in the Scripts-directory, specified in Config->Folders and must be executable.
+ On Unix-like operating systems (Linux, BSD, etc.) this means the x-bit must be on. On Windows, the requirement is that the script's extension is listed in your system's PATHEXT environment variable.
+ Once everything is in place, the Pre-Queue Script can be set in Config->Switches (enable Advanced Settings).
+
+ The script must write results to the console.
+ Exit code 0 will make SABnzbd inspect the returned output.
+ If the script has an exit code other than 0, script failure is assumed and the NZB accepted without changes.
+
All parameters (except 1) can be empty, meaning a default value. Use %1 in Windows scripts and $1 in Unix scripts. Note that on Windows the input parameters are surrounded by quotes (e.g. "job name").
NOTE Much more information is available to scripts via environment variables, see below!
+ +| Position | +Description | +
|---|---|
| 1 | +Clean version of the job name (no path info and .nzb removed) includes the password if present, in the job name / password notation |
+
| 2 | +Post Processing (PP) flags:
+
|
+
| 3 | +Category | +
| 4 | +Script (no path) | +
| 5 | +Priority
+
|
+
| 6 | +Size of the download (in bytes) | +
| 7 | +Group list (separated by spaces) | +
The script can refuse or accept the NZB and it can also return alternative parameters. These parameters should be written to the console, each parameter on a separate line. +SABnzbd uses the first 7 lines of output, so they should be empty (original value will be used) or only contain proper data. + Anything after line 7 is ignored. +
+ +NOTE To manipulate duplicate detection, you should assemble a new name and return a recognized format.
+ +| Position | +Description | +
|---|---|
| 1 | +
+
|
+
| 2 | +
+ Clean version of the job name (no path info and .nzb removed) can be used to set a password when provided in the job name / password notation |
+
| 3 | +Post Processing (PP) flags:
+
|
+
| 4 | +Category | +
| 5 | +Script (no path) | +
| 6 | +Priority
+
|
+
| 7 | +Group to be used (in case your provider doesn't carry all groups and there are multiple groups in the NZB) | +
Your script can get extra information via environment variables (return information should still be sent as plain output):
+| Variable | +Description | +
|---|---|
| SAB_SCRIPT | +The name of the current script | +
| SAB_FINAL_NAME | +The name of the job in the queue and of the final folder | +
| SAB_FILENAME | +The NZB filename (after grabbing from the URL) | +
| SAB_CAT | +What category was assigned | +
| SAB_BYTES | +Total number of bytes | +
| SAB_DUPLICATE | +Is this a duplicate and what type | +
| SAB_DUPLICATE_KEY | +The key used for Smart Duplicate Detection | +
| SAB_PASSWORD | +What was the password supplied by the NZB or the user | +
| SAB_STATUS | +Current status (completed/failed/running) | +
| SAB_PP | +What post-processing was activated (download/repair/unpack/delete) | +
| SAB_REPAIR | +Was repair selected by user | +
| SAB_UNPACK | +Was unpack selected by user | +
| SAB_PRIORITY | +Priority set by user | +
| SAB_GROUPS | +Newsgroups listed in the NZB | +
| SAB_VERSION | +The version of SABnzbd used | +
| SAB_PROGRAM_DIR | +The directory where the current SABnzbd instance is located | +
| SAB_PAR2_COMMAND | +The path to the par2 command on the system that SABnzbd uses |
+
| SAB_MULTIPAR_COMMAND | +Windows-only (empty on other systems). The path to the MultiPar command on the system that SABnzbd uses | +
| SAB_RAR_COMMAND | +The path to the unrar command on the system that SABnzbd uses |
+
| SAB_ZIP_COMMAND | +The path to the unzip command on the system that SABnzbd uses |
+
| SAB_7ZIP_COMMAND | +The path to the 7z command on the system that SABnzbd uses. Not all systems have 7zip installed (it's optional for SABnzbd), so this can also be empty |
+
| SAB_TITLE | +Title of the movie or show | +
| SAB_SEASON | +Season (1..99) | +
| SAB_EPISODE | +Episode (1..99) | +
| SAB_EPISODE_NAME | +Episode name | +
| SAB_IS_PROPER | +Tagged as Proper (True or False) | +
| SAB_RESOLUTION | +Resolution | +
| SAB_DECADE | +Decade | +
| SAB_YEAR | +Year | +
| SAB_MONTH | +Month | +
| SAB_DAY | +Day | +
| SAB_JOB_TYPE | +Job type (tv, date, movie, or unknown) | +
Example of a Windows batch file that forces high priority on anything smaller than 2GB.
+{% highlight dosbatch %} +@echo off +echo 1 +echo. +echo. +echo. +echo. +if %6 LSS 2000000000 echo 1 +{% endhighlight %} + +Save it as file size-checker.cmd and put in the scripts folder.
A python script to set prio to Force on downloads smaller than 50MB:
+{% highlight python %} +import sys + +try: + # Parse the input variables for SABnzbd version >= 4.2.0 + (scriptname, nzbname, postprocflags, category, script, prio, downloadsize, grouplist) = sys.argv +except Exception: + sys.exit(1) # a non-zero exit status causes SABnzbd to ignore the output of this script + +prio = -100 # Default +if int(downloadsize) < 50*1024**2: + prio = 2 + +print("1") # Accept the job +print() +print() +print() +print() +print(prio) +print() + +# 0 means OK +sys.exit(0) +{% endhighlight %} diff --git a/wiki/configuration/4.3/servers.html b/wiki/configuration/4.3/servers.html new file mode 100644 index 00000000..eca76b6a --- /dev/null +++ b/wiki/configuration/4.3/servers.html @@ -0,0 +1,118 @@ +--- +title: Servers +--- +If you want to download anything, you need to have access to one or more Usenet servers. + These servers can be your own ISP's Usenet server, a free public one or one of the many commercial servers. + For each server you need to specify its parameters. +
+You assign each server a priority, a number between 0 (highest) and 99 (lowest).
+ SABnzbd will first try to get articles from the group of servers with the highest priority.
+ Within the priority group, the first server with a free connection will be tried.
+ When the first tried server doesn't have an article, then another server with the same priority is tried.
+ When none of the primary servers has a specific article, a lower priority group is tried. Within the lower priority group, the same method is used: the first server with a free slot is tried.
+
This statistic will show you how many of the requested articles were available on this server. The number of requested articles is included, to offer a comparison between the servers. It could be that some higher priority servers are tried less often. If they are tried less often but still have a low article availability, it might not be worth having this subscription. +
+ +NOTE Check your Usenet provider's documentation for the proper values!
+| Enable | +If you have multiple servers, you can use this field to quickly enable or disable servers. This field can be set/reset by the Scheduler. |
+
| Server description Advanced |
+ The name of the server in the Config and download reports. | +
| Host | +The DNS name of the server. Example: news.my-isp.com |
+
| Port | +The standard port is 119. Some servers use a different port number. SSL is usually port 563 or 443. |
+
| SSL | +Use a secure connection to the server. NOTE Check which address and port you need for SSL with your provider. Most providers use port 563 for SSL, do not use port 119. |
+
| Username | +Often you need to supply the user account of your news service subscription. | +
| Password | +Often you need to supply the password of your news service subscription. | +
| Connections | +News providers offer different amounts of simultaneous connections (sometimes referred to as slots or threads). You may need to specify the maximum amount allowed in order to get full speed. Do not use a large number. Most servers work best with anything between 8 and 30.See High speed downloading for more information. |
+
| Priority | +See Priorities section above. | +
| Retention Advanced |
+ Set here the maximum retention time of your server. Retention means the number of days that articles are kept by the server. 0 means infinite retention. Only use this when you have multiple servers and you want to avoid that SABnzbd wastes time on asking servers for articles it cannot have. Be aware that retention times advertised by Usenet providers are not absolute. If you set it too low, your others servers will be used more intensely. There is no reason to set a retention time when you have only one server. |
+
| Timeout Advanced |
+ Time out in seconds for error recovery. Be careful, do not set this to a very low value, your news provider will not like that. A common value is 60. |
+
| Certificate verification Advanced |
+
+ SABnzbd can verify the certificates your news server uses to verify its identity. OpenSSL 1.0.2 or above and up-to-date local CA certificates are required. +WARNING Disabling or setting this check to Read more on Certificate verification. +
|
+
| SSL Ciphers Advanced |
+ See SSL Ciphers. | +
| Required Advanced |
+ In case of connection failures, the download queue will be paused for a few minutes instead of skipping this server. This way you can prevent secondary (block) servers to be used when there is a temporary problem with your main server. + NOTE If you enable this on multiple servers, they all need to be available before the download queue will be unpaused. |
+
| Optional Advanced |
+ If you use multiple servers and some of these servers are not very reliable, you can declare them "optional". This means that if such a server causes too much problems (like time-outs) it will be ignored for some time. When you declare a server with a long retention time as optional and the server is temporary out-of-service, SABnzbd will fall back to another server. If the alternative server has a shorter retention time, you will miss articles if the articles are beyond the retention time of the alternative server. It is best to set your most reliable and longest retention time server as a lower priority server but not as optional. Secondary servers (cheaper, less reliable, shorter retention time) can be set as high priority and optional. |
+
| Send group Advanced |
+ Some news servers require the Usenet group to be sent before starting download. Only enable if your server has problems with downloading otherwise. | +
| Account expiration date Advanced |
+ If you supply the expiration date of your server subscription, SABnzbd will warn you 5 days in advance. + NOTE The server will not be automatically disabled. |
+
| Quota Advanced |
+
+ If you have a block account, SABnzbd can warn you when you quota has expired. Most useful if you set it at around 75% of the block size that you bought, so you are warned early. + NOTE The server will not be automatically disabled. + |
+
| Personal notes Advanced |
+ In case extra information is necessary to identify this server to you on this Configuration page. | +
NOTE While SABnzbd supports a number of ways to rename files, external tools (like Sonarr, Radarr, etc.) allow for much more extensive automated download management. These tools can automatically search, add and handle renaming in almost every possible way!
+Overview of available Automation Extensions for SABnzbd.
+ +Sorting replaces any pattern keys in the sort string (such as %sn for the show or movie name) with real values, before creating the directory structure and renaming files. The sort string as well as the affected categories and job types can be set for every sorter. Sorters are tried in order of appearance, and can be reordered by dragging and dropping in the web interface. The first active sorter that meets both selection criteria (affected category and job type) is applied.
+ +The job name serves as the primary source of information for the sorting. The more standard the naming, the better your chances of a job getting properly recognized, assigned the right job type, and correctly sorted. Additional information may be sourced from metadata embedded in the NZB.
+ +NOTE If Sorting is active for a specific job, the "Deobfuscate final filenames" feature will not be applied.
+ +| Enabled | +Enable or disable a configured sorter. | +
| Name | +Set the name of the sorter. | +
| Sort String | +The sorting expression with pattern keys, constructing a path of your choice. If the sort string ends in a pattern that indicates a file name (.%ext or %fn), its last part will be used for renaming files; otherwise, the constructed path will be created as a directory and the downloaded files moved there without renaming. See the presets and the sort string examples section below for examples. | +
| Affected Job Types Advanced |
+ The job type(s) this sorter should apply to. Use Ctrl or Shift to select multiple options. | +
| Affected Categories | +One or more categories this sorter should apply to. Use Ctrl or Shift to select multiple options. | +
| Minimum Filesize Advanced |
+ The minimum file size that at least one file in a job must meet for the sorter to kick in. | +
| Multi-part Label Advanced |
+ Label to apply to sequences of files (such as CD1, CD2, ...). Rarely used nowadays; previously defaulted to CD%1 for movie sorting, where pattern key %1 is the sequence number. | +
| Meaning | +Pattern | +Result | +
|---|---|---|
| Show or Movie Name | +%sn | +Show or Movie Name (case-adjusted) | +
| + | %s.n | +Show.or.Movie.Name (case-adjusted) | +
| + | %s_n | +Show_or_Movie_Name (case-adjusted) | +
| Show or Movie Name | +%sN | +Show or Movie Name | +
| + | %s.N | +Show.or.Movie.Name | +
| + | %s_N | +Show_or_Movie_Name | +
| + | %title | +Show or Movie Name | +
| + | %.title | +Show.or.Movie.Name | +
| + | %_title | +Show.or.Movie_Name | +
| Resolution | +%r | +1080p | +
| Year | +%y | +2021 | +
| Decade | +%decade | +20 | +
| + | %0decade | +2020 | +
| Season Number | +%s | +1 | +
| + | %0s | +01 | +
| Episode Number | +%e | +5 | +
| + | %0e | +05 | +
| Episode Name | +%en | +Episode Name | +
| + | %e.n | +Episode.Name | +
| + | %e_n | +Episode_Name | +
| File Extension | +%ext | +mkv | +
| Original File Name | +%fn | +file name | +
| Original Job Name | +%dn | +folder name | +
| Lower Case | +{TEXT} | +text (in case of folders, apply to each part separately: {% raw %}{%sn}/{%dn.%ext}{% endraw %}) | +
Behind the scenes, the GuessIt module does much of the sorting-related guess work. In addition to the commonly-used features above that get their own pattern keys, + the full suite of GuessIt properties is exposed. The available properties depend on the installed GuessIt version and are listed in the web interface under the pattern key.
+ +| GuessIt Property Advanced |
+ %GI<property> | +GuessIt Property | +
| + | %G.I<property> | +GuessIt.Property | +
| + | %G_I<property> | +GuessIt_Property | +
| For example: | +%GI<audio_codec> | +DTS | +
Common, well recognized formats for season and episode numbers include 1x01 (SeriesxEpisode) or S01E01 (SseriesEepisode).
+For example:
+ Show Name - 1x01 - Episode Name.nzb
+ Show.Name.S01E01.Episode.Name.nzb
+ Show Name.1x01.nzb
+
The sorting includes support for season packs. + Episode numbers are detected from the names of the downloaded files; all other information is based on the job name or metadata. + To qualify for season pack handling, a job must be detected as type tv, its name must indicate a single season and either multiple episodes, or no episodes at all. +
Examples of job names that would be recognised as season packs include:
+ Show Name S02E04-05-06 Resolution-Group.nzb
+ Show.Name.S04.Resolution.Source.Codec-Group.nzb
+ Show Name S03E02E05E66.nzb
+ Show Name 4x01-02.nzb
+
Season pack handling is automatically activated for qualifying jobs, unless it has been disabled globally via the Special enable_season_sorting setting.
Most standard date formats are recognized, including MM-DD-YYYY, MM.DD.YYYY and YYYY-MM-DD/YYYY.MM.DD.
For example:
+ Show.Name.25.12.2022.HDTV-RLS.nzb
+
Job Name as File Name:
+ %dn.%ext
+ Example: Job Name.mkv
+
1x01 Season Folder:
+ %sn/Season %s/%sn - %sx%0e - %en.%ext
+ Example: Show Name/Season 1/Show Name - 1x05 - Episode Name.mkv
+
S01E01 Season Folder:
+ %sn/Season %s/%sn - S%0sE%0e - %en.%ext
+ Example: Show Name/Season 1/Show Name - S01E05 - Episode Name.mkv
+
1x01 Individual Episode Folder:
+ %sn/%sx%0e - %en/%sn - %sx%0e - %en.%ext
+ Example: Show Name/1x05 - Episode Name/Show Name - 1x05 - Episode Name.mkv
+
S01E01 Individual Episode Folder:
+ %sn/S%0sE%0e - %en/%sn - S%0sE%0e - %en.%ext
+ Example: Show Name/S01E05 - Episode Name/Show Name - S01E05 - Episode Name.mkv
+
Show name and season directories without file renaming:
+ %sn/Season %s
+ Example: Show Name/Season 1/old file name.avi
+
In folders:
+ %title (%y)/%title (%y).%ext with multipart label CD%1
+ Example: Movie Name (2000)/Movie Name (2000) CD1.mkv
+
No folders:
+ %title (%y).%ext
+ Example: Movie Name (2000).mkv
+
Decades 1:
+ %0decade/%title (%y).%ext
+ Example: 2000/Movie Name (2000).mkv
+
Decades 2:
+ %decade/%title (%y).%ext
+ Example: 00/Movie Name (2000).mkv
+
Show Name folder:
+ %t/%t - %y-%0m-%0d - %desc.%ext
+ Example: Show Name/Show Name - 2009-01-02 - Episode Name.mkv
+
Year-Month folders:
+ %y-%0m/%t - %y-%0m-%0d - %desc.%ext
+ Example: 2009-01/Show Name - 2009-01-02 - Episode Name.mkv
+
Daily folders:
+ %y-%0m-%0d/%t - %y-%0m-%0d - %desc.%ext
+ Example: 2009-01-02/Show Name - 2009-01-02 - Episode Name.mkv
+
| Field name | +Default | +Meaning | +
|---|---|---|
start_paused |
+ + | If checked SABnzbd will always start up in "Paused" mode. | +
preserve_paused_state |
+ + | Preserve the downloading state (paused or unpaused) after a restart. | +
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. | +
ipv6_servers |
+ + | Allow connections to IPv6 addresses if they are available for your news server. | +
ipv6_staging |
+ + | Enable IPv6 features that are non yet mainstream. | +
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. |
+
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. | +
process_unpacked_par2 |
+ + | During post-processing, if there are any .par2 files unpacked, they will be analysed and any renames will be performed. Only performed if the job is set to +Delete. |
+
queue_complete_pers |
+ + | Check this if you want end-of-queue actions to be persistent (remembered) after restarts of SABnzbd. | +
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 remove the cause of the warnings, you can choose to disable the warning. + If disabled, for blocked requests no error message (such as Access denied) is returned to the client.
+ |
+
helpful_warnings |
+ + | Option to disable helpful warnings about issues on your system such as the usage of FAT filesystems, too long password-files, required unrar versions, etc. |
+
ampm |
+ + | Display ETA in AM/PM notation, only applicable to some locations in older skins. | +
enable_multipar |
+ + | Disable to use par2cmdline-turbo instead of Multipar on Windows. | +
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. | +
tray_icon |
+ + | Uncheck this to remove the SABnzbd icon from the tray on Windows, macOS and Linux. | +
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. | +
new_nzb_on_failure |
+ + | Some indexers provide an alternative NZB through a HTTP-header (X-DNZB-Failure) when the download is added as an URL. If the first download fails, try and fetch the alternative NZB. |
+
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. | +
enable_broadcast |
+ + | Make announcements on the local network using Simple Service Discovery Protocol (SSDP) and Apple's Bonjour protocol, allowing other systems to auto-discover SABnzbd. | +
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. | +
backup_for_duplicates |
+ + | In the duplicate check, also include exact filename matches from the NZB Backup Folder.. | +
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. | +
allow_old_ssl_tls |
+ + | By default SABnzbd enforces TLSv1.2+ for SSL-connections to Usenet servers. Older protocol versions (SSLv2, SSLv3, and TLS <= 1.1) will only be allowed if this is checked. | +
enable_season_sorting |
+ + | Enable season pack handling when sorting Series. This makes the sorting try to extract episode numbers from the file names of the downloaded files in case a season pack is detected, so it can properly rename all files. | +
verify_xff_header |
+ + | Take the IP address(es) in the X-Forwarded-For header into consideration when determining access rights for incoming connections, in addition to the client/remote IP. Intended for use with a reverse proxy setup, where the IP address making the connection (as seen from the perspective of SABnzbd) is that of the proxy server rather than the system where the request actually originated, causing access to be granted even if the External internet access setting is configured to deny connections from outside the local network. For details, see the pull request that added this feature. | +
| Field name | +Default | +Meaning | +
|---|---|---|
downloader_sleep_time |
+ 10 |
+ CPU sleep period that is sometimes added between reading data from the connections. Higher values may reduce CPU load but too high values will impact the download speed. A value of 0 should only be used if increasing the number of connections is not sufficient to get maximum speed. A value of 10 means 1 ms. | +
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. | +
movie_rename_limit |
+ 100M |
+ The minimum size of a file to trigger file renaming in the Movie sort functions. | +
episode_rename_limit |
+ 20M |
+ The minimum size of a file to trigger file renaming in the Series 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. | +
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. | +
receive_threads |
+ 2 |
+ Number of threads being used to read and decode data concurrently. Setting it to 1 may reduce CPU consumption and make bandwidth limiting smoother. Increasing it may improve download speed. Requires restart. | +
switchinterval |
+ 0.005 |
+ The number of seconds a thread is allowed to run before switching to another. Setting a lower number may improve disk write speed. Requires restart. | +
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. |
+
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. |
+
ssdp_broadcast_interval |
+ 15 |
+ Interval between Simple Service Discovery Protocol (SSDP) broadcasts, announcing the presence of SABnzbd to other systems on the local network. | +
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. | +
local_ranges |
+ + | Specify a (comma separated) list of one or more network ranges where the External internet access level doesn't apply and the full interface is available. Sending Bonjour and SSDP broadcasts is also limited to these ranges. If defined, the local ranges replace the default handling based on rfc1918 and rfc4193 private network ranges. + Network ranges should be set in their standard notation with a prefix or netmask (e.g. 192.168.1.0/24 or 10.42.0.0/255.255.0.0). Input in the form of SABnzbd's older (pre-3.3.0) local_ranges setting (e.g. 192.168.1., intended for use with Python's str.startswith()) is also accepted and continues to work. |
+
ext_rename_ignore |
+ + | Specify a (comma separated) list of one or more additional extensions that SABnzbd should handle also well-known extensions and thus not touch. | +
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. | +
| Maximum retries Advanced |
+ To prevent deadlock, SABnzbd will only try each server a limited amount of times. | +
| Disconnect on empty queue Advanced |
+ 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. | +
| Pre-queue script Advanced |
+ See: pre-queue script. | +
| On queue finish script Advanced |
+ Executed after the queue finishes downloading. No special parameters are supplied. + For more information on running scripts, read the general information here: 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 until they are at least this age. Setting job priority to Force will skip the delay. |
+
| Only get articles for top of queue | +When a top-job stalls for some reason, start downloading segments for the next job. This prevents a job from blocking the queue when you have an unreliable Usenet server. If you need this behavior, set the option off. If you have a reliable server (most paid servers), you might as well set this on. | +
| Check before download Advanced |
+ 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 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 it can never be repaired, it will be aborted and send to the History as failed. Should you retry the job, the check will not be done again, but the whole job will be tried instead. | +
| Identical download detection | +See: Duplicate Detection | +
| Smart duplicate detection | +See: Duplicate Detection | +
| Allow proper releases Advanced |
+ See: Duplicate Detection | +
| Action when encrypted RAR is downloaded | +For more info see Password-protected RARs. You can choose to either continue, abort or pause the download. | +
| Unwanted extensions | +Downloads that contain files with a listed extension can be paused or aborted. Extensions are input as a comma-separated list, for example In NOTE Whitelist mode is best combined with the Pause action, until you have a carefully curated list of wanted extensions. |
+
| Action when unwanted extension detected | +Pause or abort downloads when an unwanted extension is detected. Setting this option to Off disables detection of unwanted extensions. | +
| Automatically sort queue Advanced |
+ Every time a job is added to the queue, the queue can be sorted according to this setting. + NOTE Beware that custom sorting of the queue is lost every time a new job is added. +
|
+
| Direct Unpack | +Jobs will start unpacking during the downloading to reduce post-processing time. Only works for jobs that do not need repair and do not have strongly obfuscated filenames. This feature is enabled automatically when your disk-speed is greater than 40MB/s. It will not be enabled automatically again if you manual disable it. |
+
| 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 Advanced |
+ Download all par2 files when (after verification) the job was damaged. Prevents multiple rounds of verification. + NOTE SABnzbd will already download extra par2 files if it detects problems during the download, so usually this option is not required. |
+
| External process priority Advanced |
+ Windows-only. Set process priority of programs started by SABnzbd, like the repair and unpack processes. +NOTE Setting |
+
| Extra PAR2 parameters Advanced |
+
+ Extra arguments that will be passed when running Detailed information: Windows and Linux. No extra parameters are available on macOS. + |
+
| Nice parameters Advanced |
+ Linux-only. See Nice to reduce CPU priority. | +
| IONice parameters Advanced |
+ Linux-only. See IONice to reduce disk priority. | +
| Enable SFV-based checks Advanced |
+ If no par2 files are available, .sfv files (if present) will be used to check files |
+
| Post-Process only verified jobs Advanced |
+ Even if jobs fail the verification stage, still run unpack and scripts. This way scripts can be notified of a failed download. If turned off, all jobs will be marked as Completed even if they are incomplete. | +
| Enable recursive unpacking Advanced |
+ Unpack archives (rar, zip, 7z) within archives. | +
| Ignore any folders inside archives Advanced |
+ All files will go into a single folder. | +
| Post-processing script can flag job as failed Advanced |
+ 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. | +
| Ignore samples | +If enabled, delete anything that looks like sample files (containing the words sample or proof) after completion of post-processing. |
+
| Deobfuscate final filenames | +
+ If filenames of (large) files in the final folder look obfuscated or meaningless (like NOTE If Sorting is active for a specific job, this feature will not be applied. + |
+
| 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. |
+
| History Retention | +Automatically delete completed jobs from History when new jobs are added or every day at midnight.
+
+
+ |
+
| Enable folder rename Advanced |
+ 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 operating systems cannot handle this. Therefore it's possible to disable the feature. |
+
| Replace Spaces in folder name Advanced |
+ Enable to replace spaces with underscores in folder names. | +
| Replace underscores in folder name Advanced |
+ Enable to replace underscores with dots in folder names. | +
| Replace dots in folder name Advanced |
+ Enable to replace dots with spaces in folder names. | +
| Make Windows compatible Advanced |
+ Especially useful for servers and sometimes external disks. Make sure names are compatible with Windows. | +
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) |
+
| Quota 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.
+
|
+
| 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:
+Force priority will ignore the paused state.NOTE For Windows, see below.
+You will need to install the multi-core versions of par2 yourself, as described here.
The behavior of multi-core PAR2 can be influenced by an extra parameter. By default it will use all available cores.
+-t1 Use it single-core-t<n> Use n coresThe Windows version of SABnzbd has MultiPar integrated which allows you to specify the multi-core behavior and memory usage. Additionally, you can also enable the use of the GPU. Beware: GPU performance varies between systems and can also be slower on some systems.
+ +-lc Set this if you want to set number of using threads or want to disable extra feature (SSE2 is always used).
-lc<n> where n is from 1 to 11 for specific number of cores-lc12 to use quarter number of physical cores-lc13 to use half of physical cores-lc14 to use 3/4 number of physical cores-lc15 to use the number of physical cores (disable Hyper-Threading)You may set additional combinations by adding the following options to the already specified value:
++16 to disable SSSE3+128 to disable CLMUL+256 to disable JIT+512 to disable AVX2+32 or +64 (slower device) to enable GPU accelerationFor example: -lc1 to use single core, -lc32 to enable GPU usage or -lc45 to use half cores and GPU usage.
-m Set this if you want to set memory usage. Value is specified from 1 to 7 (1/7th to 7/8th):
-m0 = Default (between 6/8 and 7/8 mostly)-m1 = 1/8, 12.5%-m4 = 4/8, 50%-m7 = 7/8, 87.5% 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
+
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!
diff --git a/wiki/configuration/deprecated.html b/wiki/configuration/deprecated.html index 8317bdf5..11205816 100644 --- a/wiki/configuration/deprecated.html +++ b/wiki/configuration/deprecated.html @@ -124,7 +124,7 @@