From 145ecd44eb9026ab5967d338219a0211d80a6da6 Mon Sep 17 00:00:00 2001 From: Safihre Date: Mon, 22 Jan 2024 14:57:36 +0100 Subject: [PATCH] Remove 4.0 documentation --- wiki/configuration/4.0/api.html | 1267 --------------------- wiki/configuration/4.0/categories.html | 37 - wiki/configuration/4.0/configure.md | 8 - wiki/configuration/4.0/folders.html | 91 -- wiki/configuration/4.0/general.html | 187 --- wiki/configuration/4.0/notifications.html | 177 --- wiki/configuration/4.0/rss.html | 168 --- wiki/configuration/4.0/scheduling.html | 115 -- wiki/configuration/4.0/servers.html | 118 -- wiki/configuration/4.0/sorting.html | 305 ----- wiki/configuration/4.0/special.html | 311 ----- wiki/configuration/4.0/switches.html | 317 ------ wiki/configuration/deprecated.html | 13 +- 13 files changed, 12 insertions(+), 3102 deletions(-) delete mode 100644 wiki/configuration/4.0/api.html delete mode 100644 wiki/configuration/4.0/categories.html delete mode 100644 wiki/configuration/4.0/configure.md delete mode 100644 wiki/configuration/4.0/folders.html delete mode 100644 wiki/configuration/4.0/general.html delete mode 100644 wiki/configuration/4.0/notifications.html delete mode 100644 wiki/configuration/4.0/rss.html delete mode 100644 wiki/configuration/4.0/scheduling.html delete mode 100644 wiki/configuration/4.0/servers.html delete mode 100644 wiki/configuration/4.0/sorting.html delete mode 100644 wiki/configuration/4.0/special.html delete mode 100644 wiki/configuration/4.0/switches.html diff --git a/wiki/configuration/4.0/api.html b/wiki/configuration/4.0/api.html deleted file mode 100644 index 6659b14a..00000000 --- a/wiki/configuration/4.0/api.html +++ /dev/null @@ -1,1267 +0,0 @@ ---- -title: API reference -redirect_from: "/wiki/advanced/automation-support" ---- -

Jump quickly to: Queue functions, History functions, Status functions and Other functions.

-
- -

Introduction

-

The SABnzbd API can be reached via:

-
http://host:port/sabnzbd/api
- -

Request types

-

Supported output types are json, xml and text and can be specified in the request: -

http://host:port/sabnzbd/api?output=json
- -

API Key and NZB key

-

API 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=APIKEY
-

If 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.

- - -

Documentation

-

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 %} -

- -

Queue functions

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FunctionDescription
queueFull Queue output
pause (queue)Pause whole queue
resume (queue)Resume whole queue
speedlimitSet speedlimit
change_complete_actionAction on queue complete
sortSort the queue
addurlAdd NZB by URL
addfileAdd NZB by file upload
addlocalfileAdd NZB by local file path
pause (single job)Pause a single job
resume (single job)Resume a single job
deleteDelete job
purgeDelete all jobs or based on keyword
moveChange position of job in queue
change_catChange job category
change_scriptChange job script
priorityChange job priority
change_optsChange job post-processing
renameChange name and password of job
get_filesGet details of files in a job
move_nzf_bulkMove file(s) inside a job
delete_nzfRemove file(s) from a job
- -

Full Queue output

-

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_3
-

NOTE Some of the less obvious output parameters are described below.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Input parameterDescription
start optionalIndex of job to start at
limit optionalNumber of jobs to display
category / cat optionalOnly return jobs for one or more categories (separated by a comma)
- Use * for Default -
priority optionalOnly return jobs for one or more priorities (separated by a comma) -
    -
  • -2 = Paused
    • -
  • -1 = Low Priority
    • -
  • 0 = Normal Priority
    • -
  • 1 = High Priority
    • -
  • 2 = Force
    • -
-
search optionalFilter job names by search term
nzo_ids optionalFilter jobs by nzo_ids
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
Output parameterDescription
speedlimitIn percentage of maximum set by user
speedlimit_absIn bytes/s
labelsLabels like DUPLICATE, ENCRYPTED and PROPAGATING X min
unpackoptsSee change_opts
- - -{% highlight json %} -{ - "queue": { - "status": "Downloading", - "speedlimit": "9", - "speedlimit_abs": "4718592.0", - "paused": false, - "noofslots_total": 2, - "noofslots": 2, - "limit": 10, - "start": 0, - "timeleft": "0:16:44", - "speed": "1.3 M", - "kbpersec": "1296.02", - "size": "1.2 GB", - "sizeleft": "1.2 GB", - "mb": "1277.65", - "mbleft": "1271.58", - "slots": [ - { - "status": "Downloading", - "index": 0, - "password": "", - "avg_age": "2895d", - "script": "None", - "direct_unpack": "10/30", - "mb": "1277.65", - "mbleft": "1271.59", - "mbmissing": "0.0", - "size": "1.2 GB", - "sizeleft": "1.2 GB", - "filename": "TV.Show.S04E11.720p.HDTV.x264", - "labels": [], - "priority": "Normal", - "cat": "tv", - "timeleft": "0:16:44", - "percentage": "0", - "nzo_id": "SABnzbd_nzo_p86tgx", - "unpackopts": "3" - }, - { - "status": "Paused", - "index": 1, - "password": "", - "avg_age": "2895d", - "script": "None", - "direct_unpack": null, - "mb": "1277.76", - "mbleft": "1277.76", - "mbmissing": "0.0", - "size": "1.2 GB", - "sizeleft": "1.2 GB", - "filename": "TV.Show.S04E12.720p.HDTV.x264", - "labels": [ - "TOO LARGE", - "DUPLICATE" - ], - "priority": "Normal", - "cat": "tv", - "timeleft": "0:00:00", - "percentage": "0", - "nzo_id": "SABnzbd_nzo_ksfai6", - "unpackopts": "3" - } - ], - "diskspace1": "161.16", - "diskspace2": "161.16", - "diskspacetotal1": "465.21", - "diskspacetotal2": "465.21", - "diskspace1_norm": "161.2 G", - "diskspace2_norm": "161.2 G", - "have_warnings": "0", - "pause_int": "0", - "left_quota": "0 ", - "version": "3.x.x", - "finish": 2, - "cache_art": "16", - "cache_size": "6 MB", - "finishaction": null, - "paused_all": false, - "quota": "0 ", - "have_quota": false, - } -} -{% endhighlight %} - -

Pause queue True/False

-

Pauses the whole queue (do not confuse this will pausing an individual download, this is a global pause).

-
api?mode=pause
-

Pauses for value minutes.

-
api?mode=config&name=set_pause&value=50
- -

Resume queue True/False

-

Resumes the whole queue (do not confuse this will resuming an individual download, this is a global pause).

-
api?mode=resume
- -

Set speedlimit True/False

-

Sets 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=400K
-

NOTE In SABnzbd 0.7.20 and below the value is always interpreted as KB/s, no percentages.

- -

Action on queue complete True/False

-

Set an end-of-queue action

-
api?mode=queue&name=change_complete_action&value=ACTION
-

Options: -

-

On 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 True/False

-

Sort the queue by avg_age, name or size in asc or desc order. -

api?mode=queue&name=sort&sort=avg_age&dir=desc
- -

Add NZB by URL

-

Add 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=-1
- -

Returns the nzo_id of the job:

-{% highlight json %} -{ - "status": true, - "nzo_ids": ["SABnzbd_nzo_kyt1f0"] -} -{% endhighlight %} - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Input parameterDescription
nameURL-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 optionalCategory to be assigned, * means Default. List of available categories can be retrieved from get_cats.
script optionalScript to be assigned, Default will use the script assigned to the category. List of available scripts can be retrieved from get_scripts.
priority optionalPriority to be assigned: -
    -
  • -100 = Default Priority (of category)
    • -
  • -3 = Duplicate
    • -
  • -2 = Paused
    • -
  • -1 = Low Priority
    • -
  • 0 = Normal Priority
    • -
  • 1 = High Priority
    • -
  • 2 = Force
    • -
-
pp optionalPost-processing options: -
    -
  • -1 = Default (of category)
    • -
  • 0 = None
    • -
  • 1 = +Repair
    • -
  • 2 = +Repair/Unpack
    • -
  • 3 = +Repair/Unpack/Delete
    • -
-
- -

Add NZB by file upload

-

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.

- -

Add NZB by local file path

-

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=-1
- -

Pause single job True/False

-

Pause 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_ID
- -

Resume single job True/False

-

Resume 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_ID
- -

Delete jobs True/False

-

Delete 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_ID
-

Deleting multiple items:

-
api?mode=queue&name=delete&value=NZO_ID_1,NZO_ID_2,NZO_ID_3
-

Deleting all items:

-
api?mode=queue&name=delete&value=all&del_files=1
- - -

Purge queue

-

Remove 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=1
-

NOTE By default already download files of a job are not removed, add del_files=1 to have all files removed.

- -

Move job in queue

-

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_2
-

You 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=2
-

Both 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 job category True/False

-

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=Category
- -

Change job script True/False

-

Change 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.py
- -

Change job priority

-

Change priority of job with nzo_id.

- -
api?mode=queue&name=priority&value=NZO_ID&value2=0
-

The command will return the new position, since a job's location also depends on its priority:

-{% highlight json %} -{ - "position": 42 -} -{% endhighlight %} - -

Change job post-processing options True/False

-

Change post-processing of job with nzo_id.

- -
api?mode=change_opts&value=NZO_ID&value2=0
- -

Change job name True/False

-

Change 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=PASSWORD
-

Or 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}}
{% endraw %} - -

Get files in job

-

Get files of job with nzo_id.

-
api?mode=get_files&value=NZO_ID
-

The 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.

- -{% highlight json %} -{ - "files": [ - { - "status": "finished", - "mbleft": "0.00", - "mb": "0.05", - "age": "25d", - "bytes": "52161.00", - "filename": "93a4ec7c37752640deab48dabb46b164.par2", - "nzf_id": "SABnzbd_nzf_1lk0ij" - }, - { - "status": "active", - "mbleft": "20.58", - "mb": "98.50", - "age": "25d", - "bytes": "103287413.00", - "filename": "93a4ec7c37752640deab48dabb46b164.01", - "nzf_id": "SABnzbd_nzf_zgx_gg" - }, - { - "status": "queued", - "set": "93a4ec7c37752640deab48dabb46b164", - "mbleft": "3.13", - "mb": "3.13", - "age": "25d", - "bytes": "3279083.00", - "filename": "93a4ec7c37752640deab48dabb46b164.vol000+02.par2", - "nzf_id": "SABnzbd_nzf_ee63r6" - } - ] -} -{% endhighlight %} - -

Move file(s) inside a job True/False

-

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=X
- -

Remove file(s) from a job

-

Remove 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
- - - -
-

History functions

- - - - - - - - - - - - - - - - - - - - - - - - - - -
FunctionDescription
historyFull history output
retryRetry failed job
retry_allRetry all failed jobs
deleteDelete history item
- -

History output

-

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=0
-

NOTE Some of the less obvious output parameters are described below.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Input parameterDescription
start optionalIndex of job to start at
limit optionalNumber of jobs to display
category / cat optionalOnly return jobs in this category
search optionalFilter job names by search term
nzo_ids optionalFilter jobs by nzo_ids
failed_only optionalOnly show failed jobs
last_history_update optionalOnly return full output if anything has changed since last_history_update, the last update is given by a previous call to history
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Output parameterDescription
seriesHow SABnzbd identified the show and season/episode info
ppDifferent format than the queue: -
    -
  • R = +Repair
    • -
  • U = +Repair/Unpack
    • -
  • D = +Repair/Unpack/Delete
    • -
-
pathTemporary destination
storageFinal destination
loadedIf true, item is post-processing
- -{% highlight json %} -{ - "history": { - "noofslots": 220, - "day_size": "1.9 G", - "week_size": "30.4 G", - "month_size": "167.3 G", - "total_size": "678.1 G", - "last_history_update": 1469210913, - "slots": [ - { - "action_line": "", - "series": "TV.Show/4/2", - "script_log": "", - "meta": null, - "fail_message": "", - "loaded": false, - "id": 235, - "size": "2.3 GB", - "category": "tv", - "pp": "D", - "retry": 0, - "script": "None", - "nzb_name": "TV.Show.S04E02.720p.BluRay.x264-xHD.nzb", - "download_time": 64, - "storage": "C:\\Users\\xxx\\Videos\\Complete\\TV.Show.S04E02.720p.BluRay.x264-xHD", - "has_rating": false, - "status": "Completed", - "script_line": "", - "completed": 1469172988, - "nzo_id": "SABnzbd_nzo_sdkoun", - "downloaded": 2436906376, - "report": "", - "password": "", - "path": "\\\\?\\C:\\SABnzbd\\TV.Show.S04E02.720p.BluRay.x264-xHD", - "postproc_time": 40, - "name": "TV.Show.S04E02.720p.BluRay.x264-xHD", - "url": "TV.Show.S04E02.720p.BluRay.x264-xHD.nzb", - "md5sum": "d2c16aeecbc1b1921d04422850e93013", - "bytes": 2436906376, - "url_info": "", - "stage_log": [ - { - "name": "Source", - "actions": [ - "TV.Show.S04E02.720p.BluRay.x264-xHD.nzb" - ] - }, - { - "name": "Download", - "actions": [ - "Downloaded in 1 min 4 seconds at an average of 36.2 MB/s
Age: 550d
10 articles were malformed" - ] - }, - { - "name": "Servers", - "actions": [ - "Frugal=2.3 GB" - ] - }, - { - "name": "Repair", - "actions": [ - "[pA72r5Ac6lW3bmpd20T7Hj1Zg2bymUsINBB50skrI] Repaired in 19 seconds" - ] - }, - { - "name": "Unpack", - "actions": [ - "[pA72r5Ac6lW3bmpd20T7Hj1Zg2bymUsINBB50skrI] Unpacked 1 files/folders in 6 seconds" - ] - } - ] - }, - { - "action_line": "", - "series": "TV.Show/4/13", - "script_log": "", - "meta": null, - "fail_message": "", - "loaded": false, - "id": 234, - "size": "2.3 GB", - "category": "tv", - "pp": "D", - "retry": 0, - "script": "None", - "nzb_name": "TV.Show.S04E13.720p.BluRay.x264-xHD.nzb", - "download_time": 60, - "storage": "C:\\Users\\xxx\\Videos\\Complete\\TV.Show.S04E13.720p.BluRay.x264-xHD", - "has_rating": false, - "status": "Completed", - "script_line": "", - "completed": 1469172947, - "nzo_id": "SABnzbd_nzo_gqhp63", - "downloaded": 2491255137, - "report": "", - "password": "", - "path": "\\\\?\\C:\\SABnzbd\\TV.Show.S04E13.720p.BluRay.x264-xHD", - "postproc_time": 82, - "name": "TV.Show.S04E13.720p.BluRay.x264-xHD", - "url": "TV.Show.S04E13.720p.BluRay.x264-xHD.nzb", - "md5sum": "85baf55ec0de0dc732c2af6537c5c01b", - "bytes": 2491255137, - "url_info": "", - "stage_log": [ - { - "name": "Source", - "actions": [ - "TV.Show.S04E13.720p.BluRay.x264-xHD.nzb" - ] - }, - { - "name": "Download", - "actions": [ - "Downloaded in 1 min at an average of 39.4 MB/s
Age: 558d
15 articles were malformed" - ] - }, - { - "name": "Servers", - "actions": [ - "Frugal=2.3 GB" - ] - }, - { - "name": "Repair", - "actions": [ - "[m0vklMEMKIT5L5XH9z5YTmuquoitCQ3F5LISTLFjT] Repaired in 47 seconds" - ] - }, - { - "name": "Unpack", - "actions": [ - "[m0vklMEMKIT5L5XH9z5YTmuquoitCQ3F5LISTLFjT] Unpacked 1 files/folders in 6 seconds" - ] - } - ] - } - ] - } -} -{% endhighlight %} - -

Retry history item True/False

-

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=password
- -

Retry all history items True/False

-

Will retry all failed jobs in the history. However, you are not able to supply passwords or extra NZB's. -

api?mode=retry_all
- - -

Delete history items True/False

-

Delete 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_ID
-

Deleting multiple items:

-
api?mode=history&name=delete&value=NZO_ID_1,NZO_ID_2,NZO_ID_3
-

Deleting all items:

-
api?mode=history&name=delete&value=all
-

Deleting all failed items:

-
api?mode=history&name=delete&value=failed
- -
-

Status functions

- -

NOTE Added in 3.4.0, older versions only have fullstatus. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FunctionDescription
status / fullstatusAll status information
unblock_serverTrue/False Unblock server
delete_orphanTrue/False Delete orphaned job
mode=status name=delete_all_orphanTrue/False Delete all orphaned jobs
add_orphanTrue/False Retry orphaned job
mode=status name=add_all_orphanTrue/False Retry all orphaned jobs
- -

Status information

-

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=0
- -

NOTE Some of the less obvious output parameters are described below.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Output parameterDescription
darwintrue when OS running SABnzbd is macOS
nttrue when OS running SABnzbd is Windows
foldersThe orphaned job folder left in the Incomplete folder. Orphaned jobs can only be removed from a skin, not through the API
pystoneIndication of CPU speed, see Highspeed Downloading
loadavgOn Linux this will contain a string with information about system load
-{% highlight json %} -{ - "status": { - "localipv4": "192.168.0.1", - "ipv6": null, - "publicipv4": "46.00.00.103", - "dnslookup": "OK", - "folders": [ - "Lost.Folder.BRRip.x264.1080p" - ], - "cpumodel": "Intel(R) Core(TM) i5-4200U CPU @ 1.60GHz", - "pystone": 88738, - "loadavg": "", - "downloaddir": "C:\\SABnzbd", - "downloaddirspeed": 0, - "completedir": "C:\\Users\\xxx\\Videos\\Complete", - "completedirspeed": 0, - "loglevel": "0", - "logfile": "C:\\Users\\xxx\\AppData\\Local\\sabnzbd\\logs\\sabnzbd.log", - "configfn": "C:\\Users\\xxx\\AppData\\Local\\sabnzbd\\sabnzbd.ini", - "nt": true, - "darwin": false, - "helpuri": "https://sabnzbd.org/wiki/", - "uptime": "3h", - "color_scheme": "Default", - "webdir": "C:\\Program Files\\SABnzbd\\interfaces\\Glitter\\templates", - "active_lang": "en", - "restart_req": false, - "power_options": true, - "pp_pause_event": false, - "pid": 123, - "weblogfile": null, - "new_release": false, - "new_rel_url": null, - "have_warnings": "0", - "warnings": [], - "servers": [ - { - "servername": "Frugal", - "servertotalconn": 25, - "serverssl": 0, - "serveractiveconn": 25, - "serveroptional": 0, - "serveractive": true, - "servererror": "", - "serverpriority": 0, - "serverbps": "11.1 M", - "serverconnections": [ - { - "thrdnum": 1, - "nzo_name": "Movie.BRRip.x264.1080p", - "nzf_name": "93a4ec7c37752640deab48dabb46b164.01", - "art_name": "1467157804579212986$gps@gopoststuff" - }, - { - "thrdnum": 2, - "nzo_name": "Movie.BRRip.x264.1080p", - "nzf_name": "93a4ec7c37752640deab48dabb46b164.02", - "art_name": "1467157807935349477$gps@gopoststuff" - }, - { - "thrdnum": 3, - "nzo_name": "Movie.BRRip.x264.1080p", - "nzf_name": "93a4ec7c37752640deab48dabb46b164.03", - "art_name": "1467157811461680159$gps@gopoststuff" - } - ] - }, - { - "servername": "Nextgennews", - "servertotalconn": 15, - "serverssl": 0, - "serveractiveconn": 0, - "serveroptional": 0, - "serveractive": true, - "servererror": "", - "serverpriority": 1, - "serverbps": "0 ", - "serverconnections": [] - } - ] - } -} -{% endhighlight %} - -

Unblock server True/False

-

Unblock server based on servername from the status.

- -
api?mode=status&name=unblock_server&value=SERVERNAME
- -

Delete orphaned job True/False

-

Delete 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=FOLDERNAME
- -

Retry orphaned job True/False

-

Retry 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=FOLDERNAME
- -
-

Other functions

-

NOTE Other functions are listed below, some straightforward commands are described only in this table and can simply be activated by calling:

-
api?mode=FUNCTION
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FunctionDescription
versionGet version of running SABnzbd
authGet authentication methods available for interaction with the API
warningsGet all active warnings
warnings clearTrue/False Clear all active warnings
get_catsGet all categories
get_scriptsGet all scripts
server_statsGet download statistics
showlogGet the anonymized log file
del_configTrue/False Delete a configuration item within the "servers", "rss", "categories", or "sorters" sections.
get_configGet value of configuration item
set_configSet configuration item to value
set_config_defaultTrue/False Reset config item to default value
shutdownTrue/False Shutdown SABnzbd
restartTrue/False Restart SABnzbd
restart_repairTrue/False Restart SABnzbd and perform a queue repair
pause_ppTrue/False Pause post-processing queue
resume_ppTrue/False Resume post-processing queue
rss_nowTrue/False Fetch and process all RSS feeds
watched_nowTrue/False Scan Watched Folder now
reset_quotaTrue/False Reset the user defined quota to 0
mode=config name=set_apikeyReset the API key, returns the new key
mode=config name=set_nzbkeyReset the NZB key, returns the new key
mode=config name=regenerate_certsTrue/False Regenerate the self-signed certificate for HTTPS connection to interface, requires SABnzbd restart to take effect
translateTranslate a text to user's locale
- -

Get all categories

-
api?mode=get_cats
-{% highlight json %} -{ - "categories": [ - "*", - "movies", - "series", - "tv" - ] -} -{% endhighlight %} - -

Get all scripts

-
api?mode=get_scripts
-{% highlight json %} -{ - "scripts": [ - "None", - "Notify.py", - "sabnzbd-notify.py" - ] -} -{% endhighlight %} - -

Download statistics

-

Return download statistics in bytes, total and per-server. -

api?mode=server_stats
-{% highlight json %} -{ - "day": 2352634799, - "week": 32934490677, - "month": 179983557488, - "total": 728426161290, - "servers": { - "eunews.server.com": { - "week": 19783288936, - "total": 163741252273, - "day": 2352634799, - "month": 90478917031, - "daily": { - "2017-01-28": 1234, - "2017-01-29": 4567 - }, - "articles_tried": 929299, - "articles_success": 8299 - }, - "News.server.net": { - "week": 13151201741, - "total": 165783396295, - "day": 0, - "month": 89499300889, - "daily": { - "2017-01-28": 1234, - "2017-01-29": 4567 - }, - "articles_tried": 520400, - "articles_success": 78881 - } - } -} -{% endhighlight %} - -

Get the anonymized log file

-

The 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=showlog
- -

Delete a configuration item within the "servers", "rss", "categories", or "sorters" sections.

-

Used to delete an entry from the limited sections.

- -Example of deleting a servers by keyword: -
api?mode=del_config&section=servers&keyword=ServerName
- -Example of deleting a rss by keyword: -
api?mode=del_config&section=rss&keyword=Feed1
- -Example of deleting a categories by keyword: -
api?mode=del_config&section=categories&keyword=audio
- -

If you attempt to delete the default category * from the categories section, the system will replace the default categories. -

api?mode=del_config&section=categories&keyword=*
- -

Get config item(s)

-

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_config
- -All elements in misc section: -
api?mode=get_config&section=misc
- -Example of filtering the server settings by keyword: -
api?mode=get_config&section=servers&keyword=ServerName
- -

Set config item

-

In order to change a setting, you need to provide the section and keyword of the setting:

-
api?mode=set_config&section=SECTION&keyword=KEYWORD&value=VALUE
-

Returns 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&section=misc&keyword=cleanup_list&value=.sfv,.nzb,.nfo,.ext
- -

Setting server, RSS feed, category, or sorter settings

-

Changing 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&section=servers&name=SERVER_NAME&username=VALUE_1&connections=VALUE_2
-

Category example:

-
api?mode=set_config&section=categories&name=CATEGORY_NAME&dir=CATEGORY_DIR
-

RSS feed example:

-
api?mode=set_config&section=rss&name=FEED_NAME&enable=VALUE_1&pp=VALUE_2
-

Sorter example:

-
api?mode=set_config&section=sorters&name=SORTER_NAME&sort_string=VALUE_1&sort_cats=VALUE_2&sort_type=VALUE_3
- -

Reset config item to default value True/False

-

NOTE 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_2
- -

Get all active warnings

-
api?mode=warnings
- -{% highlight json %} -{ - "warnings": [ - { - "text": "API key missing, please enter the API key from Config->General into your 3rd party program", - "type": "WARNING", - "time": 1505153489 - }, - { - "text": "Thread 3@news.powerusenet.com:119: login failed", - "type": "ERROR", - "time": 1505139501 - } - ] -} -{% endhighlight %} - -

Clear all active warnings True/False

-
api?mode=warnings&name=clear
- -

Translate a text

-

Translate any text known to SABnzbd from English to the locale setting of the user. -

api?mode=translate&value=Watched%20Folder
-

Will return for Dutch: -{% highlight json %} -{ - "value": "Bewaakte map" -} -{% endhighlight %} diff --git a/wiki/configuration/4.0/categories.html b/wiki/configuration/4.0/categories.html deleted file mode 100644 index a754f2df..00000000 --- a/wiki/configuration/4.0/categories.html +++ /dev/null @@ -1,37 +0,0 @@ ---- -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. -

- -

Properties that may be set for a category, as desired:

- - -

- NOTE Each row has its own save button. Remember to hit Save after each category change! -

- - -

Categories are applied:

- - -

Indexer tag or Group field

-

- 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*). -

diff --git a/wiki/configuration/4.0/configure.md b/wiki/configuration/4.0/configure.md deleted file mode 100644 index 7384b516..00000000 --- a/wiki/configuration/4.0/configure.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: Configure ---- -SABnzbd comes with sensible defaults to work, however, there are plenty of options and tweaks to tailor SABnzbd to your needs. -View the relevant page for more information on what an option does and more. - -All configuration data is stored in the so-called `sabnzbd.ini` file. Which `sabnzbd.ini` file used, you can see on the Configuration main page. -Default locations for each operating system can be found in [Folder Setup](/wiki/advanced/directory-setup). diff --git a/wiki/configuration/4.0/folders.html b/wiki/configuration/4.0/folders.html deleted file mode 100644 index 41b4bd7e..00000000 --- a/wiki/configuration/4.0/folders.html +++ /dev/null @@ -1,91 +0,0 @@ ---- -title: Folders ---- -

User Folders

-

OS-specific default locations for the settings below can be found here.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Temporary Download FolderEnter 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 FolderThe 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: .nzb, .gz, or .bz2 and archives .zip, .rar, or .7z,. The process will add the NZB to the queue and remove the file from the watched folder if successful. ZIP/RAR/7z archives should only contain .nzb files inside (.nfo are silently ignored).

-

The Watched Folder supports Categories in two ways: -

    -
  • Categories: Create a folder inside your watched folder with the same name as one of your categories. Placing a file inside that folder will add the category with the same name as the sub-folder when it is imported.
    - Example: If you have a category called Random, place a file inside C:\WatchedFolder\Random and it will be picked up and assigned to the Random category (if it exists).
    • -
  • Filename Prefix: If an NZB file has a prefix, for example {% raw %}{{movies}}My favorite movie.nzb{% endraw %}, it will be handled as the file My favorite movie.nzb, having category movies.
    • -
-
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 FolderThis 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!
-

System Folders

-

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.
diff --git a/wiki/configuration/4.0/general.html b/wiki/configuration/4.0/general.html deleted file mode 100644 index 68a76b33..00000000 --- a/wiki/configuration/4.0/general.html +++ /dev/null @@ -1,187 +0,0 @@ ---- -title: General ---- - -

Web server

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
SABnzbd Host - The hostname that will be used to access SABnzbd. - -
    -
  • 127.0.0.1 or [::1] or localhost (default) = Access from this computer only
    • -
  • empty = Finds and listens on your local (IPv4) IP address. Used for accessing from other computers. localhost will not work anymore so update your bookmarks.
    • -
  • 0.0.0.0 = Listens on multiple interfaces (both local IP and localhost).
    • -
  • :: = Listen on both IPv4 and IPv6 addresses for local and network access.
    • -
- For more information and option to overwrite this setting at startup see Command Line Parameters -
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
Advanced		SABnzbd comes with a few different skins (web interface styles). Pick one here and click on save. For the skin to become active, you have to shutdown SABnzbd and restart it again. Some skins support multiple color schemas.
LanguageThe 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.
-

Security

- - - - - - - - - - - - - - - - - - - -
- 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.
-
By default, all IP addresses in a private network range, such as 192.168.0.0/16, 172.16.0.0/12, 10.0.0.0/8 and fd00::/8 are considered local. To define custom local network ranges, use the Special local_ranges setting. -

    -
  • - API: -
      -
    • No access = No outside access is allowed at all.
      • -
    • Add NZB files = Only NZB's can be added via the API, nothing else.
      • -
    • API (no config) = API is fully available (queue/history/add+remove NZB's/etc), except for methods that get or edit the configuration.
      • -
    • Full API = All API methods are available, including editing the configuration.
      • -
    -
    • -
  • - Full API & Web Interface: -
      -
    • Full Web Interface = The full API methods and the web interface are available. Users are always shown the login screen if username/password are set.
      • -
    • Full Web interface - Only external access requires login = Only users outside the local network ranges are shown the login screen if username and password are set.
      • -
    -
    • -
-
API KeyThis 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. -
- -

Switches

- - - - - - - - - - - - - - - - - - - -
Launch browser on startupEnable to auto-launch of the browser when SABnzbd is started.
Check for new releaseIf 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: -
    -
  • socks5://username:password@hostname:port or
    • -
  • socks5://hostname:port (no login)
    • -
- NOTE The connection between the client and the server will use SSL if enabled. However, the connection between the proxy and the client will not. - This means that the data transferred between the client and the server is hidden for anyone including the proxy, but the username and password for the proxy and the server address are unencrypted.
- -

Tuning

- - - - - - - - - - - - - - - -
Maximum line speedSet 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 2G if you have more than 8GB of memory.
- You enter the amount in bytes but you can use factors like K, M, G etc. eg: 70M = 70 MB cache.

- -
    -
  • number = Maximum memory (in bytes)
    • -
  • 0 = Disable Cache
    • -
  • -1 = Unlimited, up to maximum for your system (1 or 4GB).
    • -
- -

See High speed downloading for more information.
- Article Cache is limited to 1G on 32bit systems and 4G on 64bit systems.

-
- -

Backup

- - - - - - - - - - - -
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 backupRestore a backup of the configuration file and databases.
\ No newline at end of file diff --git a/wiki/configuration/4.0/notifications.html b/wiki/configuration/4.0/notifications.html deleted file mode 100644 index 19d5a44a..00000000 --- a/wiki/configuration/4.0/notifications.html +++ /dev/null @@ -1,177 +0,0 @@ ---- -title: Notifications ---- -

Email notifications

-

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.

-

Email options

- - - - - - - - - - - - - - - -
ErrorsSend an email when a download fails for any reason
End-of-job notificationsSend an email after each job is completed and fully post-processed
Disk full notificationsSend an email when SABnzbd paused because the disk is almost full
-

Email Account Settings

-

Check your email provider's instructions for the proper values.

- - - - - - - - - - - - - - - - - - - - - - - -
SMTP serverThe 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 recipientThe email address to which the emails must be sent.
Email senderThe 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 nameUser name of the email account used to send the emails.
Account passwordPassword of the email account used to send the emails.
WARNING this password is stored as plain text in the INI file.
-

Gmail example

- - - - - - - - - - - - - - - - - - - - - - - -
SMTP serversmtp.gmail.com:587
Email recipientyou@gmail.com
Email senderyou@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 nameyou@gmail.com
Account passwordpassword
-

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.

- -
-

Notification Services

-

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. -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
GroupEvents
Startup/ShutdownStartup, Shutdown
Pause/ResumePause, Resume
Added NZBNew NZB's are added
Post-processingPost-processing started
Job finishedJob finished
Job failedJob failed
Queue finishedQueue finished
User logged inSuccessful login (HTML form only)
WarningWarning
ErrorError
OtherURL fetching failed, Shutdown finished, New release available
-
-

Windows balloons

-

Windows will show a modest text balloon connected to SABnzbd's System Tray icon.

- -

macOS Notification Center

-

Standard macOS Notification Service.
- Only when you're using our signed app, you will see SABnzbd's icon. -

- -

NotifyOSD

-

Some Linux systems support the NotifyOSD protocol.
- When SABnzbd detects support for this protocol, it will allow you to enable the service. -

- -

Notification script

-

Allows implementation of custom notification services. See Notification Scripts.

-

NZB-Notify's notification script provides a very wide range of notification services, listed here.

-

NZB-Notify setup:

- diff --git a/wiki/configuration/4.0/rss.html b/wiki/configuration/4.0/rss.html deleted file mode 100644 index c6747f6f..00000000 --- a/wiki/configuration/4.0/rss.html +++ /dev/null @@ -1,168 +0,0 @@ ---- -title: RSS ---- -

- 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. -

- - -
-

An example

-

- 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
-
-
- -
-

Categories

-

- 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. -

- - -
-

Filters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Filter nameMeaning
AcceptAccept job when the title matches the expression.
If not matched, go to next filter.
RequiresRequire job title to contain this expression.
If matched, go to next filter. If not matched, reject job.
RejectReject job when the title matches the expression.
If not matched, go to next filter.
RequiresCatRequire 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 LeastThe 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 MostThe 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 SxxEyyOnly 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.

- - -

Feed buttons

- - - - - - - - - - - - - - - - - - - -
Read feedRead the RSS source again and apply the filters.
Force downloadSend all matching items to the queue.
Clear downloadClear the list of items already sent to the queue.
Apply FiltersNew or altered filters are not directly applied to existing results, click this button to re-filter the results.
- -
-

Regular expressions

-

- 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. -

- -
-

Automatic processing

-

- 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. -

- -
-

First batch

-

- 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.0/scheduling.html b/wiki/configuration/4.0/scheduling.html deleted file mode 100644 index c60f97b3..00000000 --- a/wiki/configuration/4.0/scheduling.html +++ /dev/null @@ -1,115 +0,0 @@ ---- -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.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ActionDescription
ResumeContinue downloading, Watched Folder scanning and RSS feed readouts.
Pause - Stop downloading
- NOTE Will pause at startup if not combined with a scheduled Resume. -
Pause-allStop downloading, Watched Folder scanning and RSS feeds, stops all disk activity.
ShutdownExit SABnzbd.
RestartRestart SABnzbd.
SpeedlimitSet 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 processingHalt post-processing (except active job), while downloading continues.
Resume post processingWill resume post-processing, while downloading continues.
Scan watched folderRead watched folder (this will disable the interval in Folders).
Create backupCreate 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-nameAll 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. -

-
-

Example

-

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 -

diff --git a/wiki/configuration/4.0/servers.html b/wiki/configuration/4.0/servers.html deleted file mode 100644 index eca76b6a..00000000 --- a/wiki/configuration/4.0/servers.html +++ /dev/null @@ -1,118 +0,0 @@ ---- -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. -

-
-

Priorities

-

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. -

- -

Article availability

-

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. -

- -
-

Basic settings

-

NOTE Check your Usenet provider's documentation for the proper values!

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
EnableIf 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.
HostThe DNS name of the server. Example: news.my-isp.com
PortThe standard port is 119. Some servers use a different port number.
SSL is usually port 563 or 443.
SSLUse 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.
UsernameOften you need to supply the user account of your news service subscription.
PasswordOften you need to supply the password of your news service subscription.
ConnectionsNews 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.
PrioritySee 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 Minimal allows anyone to redirect and intercept your traffic using any valid certificate! It is comparable to not using SSL at all.

-

Read more on Certificate verification.

-
    -
  • None = Certificates are not verified
    • -
  • Minimal = Verify certificates before connecting
    • -
  • Strict = Verify and enforce matching hostname
    • -
- -
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.
diff --git a/wiki/configuration/4.0/sorting.html b/wiki/configuration/4.0/sorting.html deleted file mode 100644 index ab12c2f6..00000000 --- a/wiki/configuration/4.0/sorting.html +++ /dev/null @@ -1,305 +0,0 @@ ---- -title: Sorting ---- -

External sorting tools

-

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

-

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.

- -
-

Basic settings

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
EnabledEnable or disable a configured sorter.
NameSet the name of the sorter.
Sort StringThe 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 CategoriesOne 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.
- -
-

Pattern Keys

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
MeaningPatternResult
Show or Movie Name%snShow or Movie Name (case-adjusted)
%s.nShow.or.Movie.Name (case-adjusted)
%s_nShow_or_Movie_Name (case-adjusted)
Show or Movie Name%sNShow or Movie Name
%s.NShow.or.Movie.Name
%s_NShow_or_Movie_Name
%titleShow or Movie Name
%.titleShow.or.Movie.Name
%_titleShow.or.Movie_Name
Resolution%r1080p
Year%y2021
Decade%decade20
%0decade2020
Season Number%s1
%0s01
Episode Number%e5
%0e05
Episode Name%enEpisode Name
%e.nEpisode.Name
%e_nEpisode_Name
File Extension%extmkv
Original File Name%fnfile name
Original Job Name%dnfolder 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
- -
-

Job names

- -

Series naming

-

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 -

- -

Season packs

-

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.

- -

Date naming

-

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 -

- - -
-

Sort String examples

- -

General examples

-

Job Name as File Name:
- %dn.%ext
- Example: Job Name.mkv -

- -

Series examples

-

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 -

- -

Movie examples

-

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 -

- -

Date examples

-

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 -

diff --git a/wiki/configuration/4.0/special.html b/wiki/configuration/4.0/special.html deleted file mode 100644 index 18e0407c..00000000 --- a/wiki/configuration/4.0/special.html +++ /dev/null @@ -1,311 +0,0 @@ ---- -title: Special settings ---- - -

Switches

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field nameDefaultMeaning
start_pausedIf checked SABnzbd will always start up in "Paused" mode.
preserve_paused_statePreserve the downloading state (paused or unpaused) after a restart.
no_penaltiesSome Usenet servers have intermittent login (or other) problems. For these the server blocking method is not very favorable. Setting this option will limit blocks to 1 minute.
fast_failWhen 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_filesWhen unpacking, this will overwrite existing files instead of creating an alternative name.
enable_par_cleanupNormally 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_par2During 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_persCheck 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_warningsOption to disable helpful warnings about issues on your system such as the usage of FAT filesystems, too long password-files, required unrar versions, etc.
ampmDisplay ETA in AM/PM notation, only applicable to some locations in older skins.
enable_unrar, enable_unzip, enable_7zip, enable_filejoin, enable_tsjoinEnable or disable the UnRar, UnZip, 7zip, filejoin and TSJoin tools. If disabled, the archive/split files will not be unpacked.
ignore_unrar_datesNormally 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_iconUncheck this to remove the SABnzbd icon from the tray on Windows, macOS and Linux.
allow_incomplete_nzbSometimes 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_filenamesNormally 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_hostingSome 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_awakeDisable to stop SABnzbd's attempts to keep the system awake while the queue isn't empty.
empty_postprocDo post-processing and run the user script even if nothing has been downloaded. This is useful in combination with tools like SickBeard, for which running the script on an empty or failed download is a trigger to try an alternative NZB. Note that the "Status" parameter for the script will be -1.
html_loginHTML 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_dfolderSome 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_broadcastMake 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_jobsIf 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_duplicatesIn the duplicate check, also include exact filename matches from the NZB Backup Folder..
disable_api_keyIf checked API calls don't require the API key.
api_loggingCheck to log all API calls.
x_frame_optionsIncludes 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_tlsBy 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_sortingEnable 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.
-
-

Values

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field nameDefaultMeaning
downloader_sleep_time10 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_limit0Any 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_limit100MThe minimum size of a file to trigger file renaming in the Movie sort functions.
episode_rename_limit20MThe minimum size of a file to trigger file renaming in the Series sort functions.
nomedia_markerJust 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_retries10How 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_rate100.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_drive5When 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_length246On 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/sabnzbdWhen 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_threads2Number 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.
switchinterval0.005The 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_threads3When Direct Unpack is enabled we only allow this number of unpackers to be active at the same time. This is to limit strain on the system's disks.
Note that there can be an additional unpack active if a job is also being post-processed.
ipv6_servers1Control the use of IPv6 Usenet server addresses. Only useful when you have an IPv6 capable ISP and connect to servers that (also) have IPv6 addresses. Meaning: 0 = don't use, 1 = use when available and reachable, 2 = force usage (when SABnzbd's detection fails).
selftest_hostself-test.sabnzbd.orgIn 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_interval15Interval between Simple Service Discovery Protocol (SSDP) broadcasts, announcing the presence of SABnzbd to other systems on the local network.
rss_odd_titlesnzbindex.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_ignorenfo, sfv, srrA 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_whitelisthostnameSee Hostname verification.
local_rangesSpecify 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_ignoreSpecify a (comma separated) list of one or more additional extensions that SABnzbd should handle also well-known extensions and thus not touch.
-
-

Very special option

-

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

- - - - - - - - - - - - - - - -
Field nameDefaultMeaning
config_lockIf 1, forbids all access to the Config pages.
diff --git a/wiki/configuration/4.0/switches.html b/wiki/configuration/4.0/switches.html deleted file mode 100644 index 57bc1313..00000000 --- a/wiki/configuration/4.0/switches.html +++ /dev/null @@ -1,317 +0,0 @@ ---- -title: Switches ---- - -

Server

- - - - - - - - - - - - - - - -
Server IP address selection
Advanced		A number of news servers has multiple IP-addresses, these can be IPv4 or IPv6. -
    -
  • First IP address = The first IP-address returned will be used for all connections.
    • -
  • Randomly selected IP address = Each connection will be randomly selected from the available addresses.
    • -
  • Quickest IP address, preferring IPv6 = For each connection the fastest IP-address is selected, with a small head start for IPv6 addresses.
    • -
-
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.
-

Queue

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Pre-queue user scriptSee: pre-queue script.
Propagation delayIf 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 queueWhen 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 completedIf 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.
Detect duplicate downloadsThis option will compare the NZB name or NZB content to those in the History. It will also compare the NZB name to the items in your .nzb Backup Folder.
Detect duplicate episodes in seriesThis option will analyze NZB titles for Series/Season/Episode information and will check whether the episode has already been downloaded. It will check against the History database.
Allow proper releases
Advanced		Bypass series duplicate detection if PROPER, REAL or REPACK is detected in the download name to allow for better quality releases to still be downloaded.
Action when encrypted RAR is downloadedFor 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 exe,com,cmd,bat to trigger on common Windows executable content.
Basic wildcards and regular expressions are also supported, for example re:mp* or re:r[0-9]{2} (the latter matching r00 through r99).

-

In Blacklist mode, only the listed extensions trigger the configured action; everything else is ignored. Whitelist mode is more paranoid: only listed extensions get a free pass; jobs that contain files with any other extension, no matter how small or harmless, will be considered unwanted.

-

NOTE Whitelist mode is best combined with the Pause action, until you have a carefully curated list of wanted extensions.

Action when unwanted extension detectedPause 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. -
    -
  • Default = No auto sorting.
    • -
  • Sort by % downloaded = Sort jobs by percentage downloaded (re-sorts every 30 seconds).
    • -
  • Sort by Age = Sort jobs by their usenet date.
    • -
  • Sort by Name = Sort jobs by their Name (not case sensitive).
    • -
  • Sort by Size = Sort jobs by their Size/Bytes.
    • -
-
Direct UnpackJobs 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.
-

Post processing

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Pause downloading during post-processingWill 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 High could result in significant slowdown of the system during processing!

Extra PAR2 parameters
Advanced		 -

Extra arguments that will be passed when running par2 or MultiPar for verification and repair.

-

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.
On failure, try alternative NZB
Advanced		Some servers provide an alternative NZB when a download fails and we can try that one.
Ignore samplesIf 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 19399393.ext or timmof.mkv) they will be renamed to the job name. - Additionally, attempts to set the correct file extension based on the file signature if the extension is not present or meaningless.

-

NOTE If Sorting is active for a specific job, this feature will not be applied.

-
Cleanup ListList 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 RetentionAutomatically delete completed jobs from History when new jobs are added or every day at midnight. - -
    -
  • Keep all jobs = Do not auto-delete any history.
    • -
  • Keep maximum number of completed jobs = Specify exact amount of jobs to keep, removing the oldest ones.
    • -
  • Keep completed jobs maximum number of days = Delete jobs automatically when they are older than the set amount of days.
    • -
  • Do not keep any completed jobs = No jobs are saved in the History.
    • -
- NOTE Beware that Duplicate Detection and some external tools rely on History information.
-
-

Naming

- - - - - - - - - - - - - - - - - - - - - - - -
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.
-

Quota

-

If you're unlucky enough to have an ISP that uses strict download caps, you may want to set a monthly quota for SABnzb.

- - - - - - - - - - - - - - - - - - - -
SizeIn bytes. Example: 5G (for 5 GB) or 1T (for 1 TB)
Quota PeriodDaily, Weekly or Monthly quota
Reset dayThe 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 resumeSet 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:

- - -
- -

Extra Par2 Parameters for Linux

-

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.

- - -

If you use the par2-tbb version you can also set the process priority:

- - -
-

Extra Par2 Parameters for Windows

-

The 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.

- - - -
-

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!

diff --git a/wiki/configuration/deprecated.html b/wiki/configuration/deprecated.html index 9f1c27f2..8317bdf5 100644 --- a/wiki/configuration/deprecated.html +++ b/wiki/configuration/deprecated.html @@ -100,9 +100,20 @@ - /wiki/configuration/3.8/sorting.html - /wiki/configuration/3.8/special.html - /wiki/configuration/3.8/switches.html + - /wiki/configuration/4.0/api.html + - /wiki/configuration/4.0/categories.html + - /wiki/configuration/4.0/configure.html + - /wiki/configuration/4.0/folders.html + - /wiki/configuration/4.0/general.html + - /wiki/configuration/4.0/notifications.html + - /wiki/configuration/4.0/rss.html + - /wiki/configuration/4.0/scheduling.html + - /wiki/configuration/4.0/servers.html + - /wiki/configuration/4.0/sorting.html + - /wiki/configuration/4.0/special.html + - /wiki/configuration/4.0/switches.html --- -

Your version of SABnzbd is no longer supported

You can download the most recent stable version (SABnzbd {{ site.latest_stable }}) on our downloads page.