-
Notifications
You must be signed in to change notification settings - Fork 18
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
16 changed files
with
3,839 additions
and
1 deletion.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| --- | ||
| title: Categories | ||
| --- | ||
|
|
||
| <p> | ||
| 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. | ||
| </p> | ||
|
|
||
| <h3>Properties that may be set for a category, as desired:</h3> | ||
| <ul> | ||
| <li>What priority to give them. Note that jobs with "Force" priority will ignore the paused state of the queue.</li> | ||
| <li>How the file should be processed (see <a href="/wiki/extra/job-options">Job Options</a>).</li> | ||
| <li>The user-script to execute after the download (Scripts folders defined in <a href="/wiki/configuration/{{ site.wiki_version }}/folders">Folders</a>).</li> | ||
| <li>The Folder or full path for final storage (relative folders are based of your complete folder, full paths are also allowed). <br>Ending the path with an asterisk <code>*</code> will prevent creation of job folders.</li> | ||
| </ul> | ||
|
|
||
| <p> | ||
| <span class="label label-warning">NOTE</span> Each row has its own save button. Remember to hit <strong>Save</strong> after each category change! | ||
| </p> | ||
|
|
||
|
|
||
| <h3>Categories are applied:</h3> | ||
| <ul> | ||
| <li>When the indexer category tag or newsgroup of the download matches the field for that category. </li> | ||
| <li>When the indexer category tag starts with one of your categories.</li> | ||
| <li>When an RSS feed specifically applies a particular category.</li> | ||
| <li>When added via the <a href="/wiki/configuration/{{ site.wiki_version }}/folders">Watched Folder</a> using special file or folder name.</li> | ||
| <li>When a download gets added via the API that also specifies a category.</li> | ||
| </ul> | ||
|
|
||
| <h3 id="toc0">Indexer tag or Group field</h3> | ||
| <p> | ||
| 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., <code>alt.binaries.teevee</code>). Categories can be re-ordered to set the order in which matching should happen. For example this way you can put <code>Movies > 4K</code> in a special category and the rest of the movies in a categories with just the indexer tag <code>Movies</code>. | ||
| </p> | ||
| <p> | ||
| Basic wildcards are supported. For example, some <a href="/wiki/introduction/nzb-sources">indexers</a> uses sub-categories like <code>TV > HD</code>. Instead of listing all possible categories, you may simply use <code>TV*</code>. The same applies to newsgroups (i.e., <code>alt.bin*</code>). | ||
| </p> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| --- | ||
| 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). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,91 @@ | ||
| --- | ||
| title: Folders | ||
| --- | ||
| <h2>User Folders</h2> | ||
| <p>OS-specific default locations for the settings below can be found <a href="/wiki/advanced/directory-setup">here</a>.</p> | ||
| <table class="table table-bordered table-hover"> | ||
| <tbody> | ||
| <tr> | ||
| <td><strong>Temporary Download Folder</strong></td> | ||
| <td>Enter the path to a folder SABnzbd can use to store files as they are downloaded. Once the file is complete, it will verify then extract to the Complete Folder. You can just enter "Incomplete" to keep it relative to your Base Folder or enter the full path such as <code>C:\Incomplete</code> and SABnzbd will create the folder.</td> | ||
| </tr> | ||
| <tr> | ||
| <td><strong>Minimum Free Space for Temporary Download Folder</strong><br><span class="label label-primary">Advanced</span></td> | ||
| <td>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. <br>You enter the amount in bytes but you can use factors like <code>K, M, G</code> etc.</td> | ||
| </tr> | ||
| <tr> | ||
| <td><strong>Completed Download Folder</strong></td> | ||
| <td>The completed download folder is the default download location for all items, unless indicated otherwise from the <a href="/wiki/configuration/{{ site.wiki_version }}/categories">Categories</a> page.</td> | ||
| </tr> | ||
| <tr> | ||
| <td><strong>Minimum Free Space for Completed Download Folder</strong><br><span class="label label-primary">Advanced</span></td> | ||
| <td>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. <br>You enter the amount in bytes but you can use factors like <code>K, M, G</code> etc. | ||
| <br><span class="label label-warning">NOTE</span> Will not work if a <a href="/wiki/configuration/{{ site.wiki_version }}/categories">category folder</a> is on a different disk than the main Complete Download Folder.</td> | ||
| </tr> | ||
| <tr> | ||
| <td><strong>Auto resume</strong><br><span class="label label-primary">Advanced</span></td> | ||
| <td>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.</td> | ||
| </tr> | ||
| <tr> | ||
| <td><strong>Permissions for completed downloads</strong><br><span class="label label-primary">Advanced</span></td> | ||
| <td>Set permissions pattern for completed files/folders using octal notation, for macOS and Linux only.<br>Example: <code>755</code> or <code>777</code>, see: <a href="/wiki/advanced/unix-permissions">Unix permissions</a>.</td> | ||
| </tr> | ||
| <tr> | ||
| <td><strong>Watched Folder</strong></td> | ||
| <td> | ||
| <p>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: <code>.nzb, .gz, or .bz2</code> and archives <code>.zip, .rar, or .7z,</code>. 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).</p> | ||
| <p>The Watched Folder supports <a href="/wiki/configuration/{{ site.wiki_version }}/categories">Categories</a> in two ways: | ||
| <ul> | ||
| <li><strong>Categories:</strong> 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. <br> | ||
| Example: If you have a category called <code>Random</code>, place a file inside <code>C:\WatchedFolder\Random</code> and it will be picked up and assigned to the <code>Random</code> category (if it exists). </li> | ||
| <li><strong>Filename Prefix:</strong> If an NZB file has a prefix, for example {% raw %}<code>{{movies}}My favorite movie.nzb</code>{% endraw %}, it will be handled as the file <code>My favorite movie.nzb</code>, having category <code>movies</code>.</li> | ||
| </ul> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td><strong>Watched Folder Scan Speed</strong><br><span class="label label-primary">Advanced</span></td> | ||
| <td> | ||
| Number of seconds between filesystem scans of the Watched Folder setting above. | ||
| Setting it to <code>0</code> disables the automatic scans, but scans can still be triggered from the menu on the main page.<br> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td><strong>Scripts Folder</strong></td> | ||
| <td>This specifies the folder where user scripts (post-processing and pre-queue) are stored. On Windows, users may specify a .cmd or .bat file; other extensions can be executed with the <code>PATHEXT</code> variable. On Unix any installed script type can be used, including common choices such as shell or Python, provided the file is executable (<code>chmod +x file</code>) and starts with a valid <a href="https://en.wikipedia.org/wiki/Shebang_(Unix)">shebang line</a>. <br>Read more about creating <a href="/wiki/configuration/{{ site.wiki_version }}/scripts/post-processing-scripts">Post-processing</a> and <a href="/wiki/configuration/{{ site.wiki_version }}/scripts/pre-queue-scripts">Pre-queue</a> scripts.</td> | ||
| </tr> | ||
| <tr> | ||
| <td><strong>Email Templates Folder</strong><br><span class="label label-primary">Advanced</span></td> | ||
| <td>You can define your own <a href="/wiki/extra/email-templates">Email Templates</a>.</td> | ||
| </tr> | ||
| <tr> | ||
| <td><strong>Password File</strong><br><span class="label label-primary">Advanced</span></td> | ||
| <td>A text file of known passwords, one password per line, that should be attempted on passworded RAR files. See also <a href="/wiki/advanced/password-protected-rars">Password-protected RARs</a>.<br><span class="label label-danger">WARNING</span> Checking passwords takes time, do not list more than ~20 passwords in this file!</td> | ||
| </tr> | ||
| </tbody> | ||
| </table> | ||
| <h2>System Folders</h2> | ||
| <p>OS-specific default locations for the settings below can be found <a href="/wiki/advanced/directory-setup">here</a>.</p> | ||
| <table class="table table-bordered table-hover"> | ||
| <tbody> | ||
| <tr> | ||
| <td><strong>Administrative Folder</strong><br><span class="label label-primary">Advanced</span></td> | ||
| <td>Location for queue, admin and history database.</td> | ||
| </tr> | ||
| <tr> | ||
| <td><strong>Backup Folder</strong><br><span class="label label-primary">Advanced</span></td> | ||
| <td> | ||
| Location where the backups of the configuration file and databases are stored.<br> | ||
| If left empty, the backup will be created in the Completed Download Folder.<br> | ||
| See also <a href="/wiki/configuration/{{ site.wiki_version }}/general#toc3">Create Backup</a>. | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td><strong>Log Folder</strong><br><span class="label label-primary">Advanced</span></td> | ||
| <td>This folder holds error/warning/info/debug logging data.</td> | ||
| </tr> | ||
| <tr> | ||
| <td><strong>.nzb Backup Folder</strong><br><span class="label label-primary">Advanced</span></td> | ||
| <td>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.</td> | ||
| </tr> | ||
| </tbody> | ||
| </table> |
Oops, something went wrong.