TRaSH-Guides/docs/NZBGet/How-to-setup-NZBGet.md

# Setup NZBGet to use with Sonarr/Radarr

This basic example is based on the use of docker images

!!! note ""
    Keep in mind I've setup my paths so it works with hardlinks and you get instant moves.

!!! warning ""
    The default path setup used by [Linux|Server.io](https://hub.docker.com/r/linuxserver/) don't support hardlinks and instant moves, but you're able to change this, by not using the pre-defined paths like `/downloads` `/movies` and `/tv` and use paths like `/data/downloads`, `/data/media/movies` and `/data/media/tv`.

------

## Some Basics

| Name         | Description                                |
|:---          |:---                                        |
| `${MainDir}` | Root directory for all tasks.              |
| `${AppDir}`  | Where NZBGet is installed.                 |
| `${DestDir}` | Destination directory for downloaded files.|

## PATHS

![!paths](images/paths.png)

I will only explain the so called most important paths.

| Name        | Description                                                                            |
|:---         |:---                                                                                     |
| `MainDir`   | `/data/.usenet`                                                                        |
| `DestDir`   | `${MainDir}/completed` (so it will go in to `/data/.usenet/completed`)                 |
| `InterDir`  | Files are downloaded into this directory (before unpack+par2)                          |
| `NzbDir`    | Directory for incoming nzb-files.                                                      |
| `QueueDir`  | This directory is used to save download queue, history, information statistics, etc.   |
| `ScriptDir` | Directory with post-processing and other scripts.                                      |
| `LogFile`   | Where your log files will be stored (Please create a log directory in your config) |

## NEWS-SERVERS

![!newsservers](images/newsservers.png)

| Name           | Description                                                                            |
|:---            |:---                                                                                    |
| `Active`       | Use this news server.                                                                  |
| `Name`         | The name is used in UI and for logging. It can be any string.                          |
| `Level`        | Put your major download servers at level 0 and your fill servers at levels 1, 2, etc.. |
| `Host`         | Host name of news server.                                                              |
| `Port`         | Port to connect to.                                                                    |
| `Password`     | Password to use for authentication.                                                    |
| `Encryption`   | Encrypted server connection (TLS/SSL). (preferred to use this)                   |
| `Connections`  | Use the lowest possible amount of connections +1 to gain your max download speed.      |
| `Retention`    | How long the articles are stored on the news server.                                   |

## CATEGORIES

![!categories](images/categories.png)

| Name          | Description                                                                            |
|:---           |:---                                                                                    |
| `Name`        | This should match what you put in Sonarr/Radarr (tv/movies/sonarr/radarr/series/films) |
| `DestDir`     | `${DestDir}` Destination directory (/data/.usenet/completed/movie)                     |
| `Unpack`      | Unpack downloaded nzb-files.                                                           |
| `Extensions`  | List of extension scripts for this category.                                           |

## INCOMING NZBS

![!incoming](images/incoming.png)

!!! warning
    `AppendCategoryDir`: Create subdirectory with category-name in destination-directory.

## DOWNLOAD QUEUE

![!queue](images/queue.png)

!!! warning
    `WriteBuffer`: If you're low on memory don't set this to high.

## LOGGING

![!logging](images/logging.png)

## CHECK AND REPAIR

![!checkAndRepair](images/checkAndRepair.png)

## UNPACK

![!unpack](images/unpack.png)

!!! warning
    `DirectUnpack`: This might lower your download speed but the overall time could be faster. (disable on low powered devices)

## EXTENSION SCRIPTS

![!extScripts](images/extScripts.png)

Depending if you're using some NZBGet script here you can change the order or when it should be used
Fixed: MarkDown Errors, typo's Fixed: MarkDown Errors, typo's 4 years ago			`# Setup NZBGet to use with Sonarr/Radarr`
How To Setup NZBGet Initial Release 5 years ago
Large mkdocs adoption 4 years ago			`This basic example is based on the use of docker images`
How To Setup NZBGet Initial Release 5 years ago
Large mkdocs adoption 4 years ago			`!!! note ""`
			`Keep in mind I've setup my paths so it works with hardlinks and you get instant moves.`

			`!!! warning ""`
Fixed: MarkDown Errors, typo's Fixed: MarkDown Errors, typo's 4 years ago			The default path setup used by [Linux\|Server.io](https://hub.docker.com/r/linuxserver/) don't support hardlinks and instant moves, but you're able to change this, by not using the pre-defined paths like `/downloads` `/movies` and `/tv` and use paths like `/data/downloads`, `/data/media/movies` and `/data/media/tv`.
How To Setup NZBGet Initial Release 5 years ago
Large mkdocs adoption 4 years ago			`------`
How To Setup NZBGet Initial Release 5 years ago
Large mkdocs adoption 4 years ago			`## Some Basics`
How To Setup NZBGet Initial Release 5 years ago
Large mkdocs adoption 4 years ago			`\| Name \| Description \|`
			`\|:--- \|:--- \|`
			\| `${MainDir}` \| Root directory for all tasks. \|
			\| `${AppDir}` \| Where NZBGet is installed. \|
			\| `${DestDir}` \| Destination directory for downloaded files.\|
How To Setup NZBGet Initial Release 5 years ago
Large mkdocs adoption 4 years ago			`## PATHS`
How To Setup NZBGet Initial Release 5 years ago
Security Fixes: prevent a type of phishing known as tabnabbing. - Added: noopener noreferrer to external URL redirects (others pages will follow soon) - Info: Tabnabbing, sometimes called reverse tabnabbing, is an exploit that uses the browser's default behavior with target="_blank" to gain partial access to your page through the window.object API. With tabnabbing, a page that you link to could cause your page to redirect to a fake login page. This would be hard for most users to notice because the focus would be on the tab that just opened – not the original tab with your page. 4 years ago			`![!paths](images/paths.png)`
How To Setup NZBGet Initial Release 5 years ago
Updated screenshots and description including instant move and hardlinks support Updated screenshots and description including instant move and hardlinks support 5 years ago			`I will only explain the so called most important paths.`
How To Setup NZBGet Initial Release 5 years ago
Large mkdocs adoption 4 years ago			`\| Name \| Description \|`
			`\|:--- \|:--- \|`
			\| `MainDir` \| `/data/.usenet` \|
			\| `DestDir` \| `${MainDir}/completed` (so it will go in to `/data/.usenet/completed`) \|
			\| `InterDir` \| Files are downloaded into this directory (before unpack+par2) \|
			\| `NzbDir` \| Directory for incoming nzb-files. \|
			\| `QueueDir` \| This directory is used to save download queue, history, information statistics, etc. \|
			\| `ScriptDir` \| Directory with post-processing and other scripts. \|
Security Fixes: prevent a type of phishing known as tabnabbing. - Added: noopener noreferrer to external URL redirects (others pages will follow soon) - Info: Tabnabbing, sometimes called reverse tabnabbing, is an exploit that uses the browser's default behavior with target="_blank" to gain partial access to your page through the window.object API. With tabnabbing, a page that you link to could cause your page to redirect to a fake login page. This would be hard for most users to notice because the focus would be on the tab that just opened – not the original tab with your page. 4 years ago			\| `LogFile` \| Where your log files will be stored (Please create a log directory in your config) \|
How To Setup NZBGet Initial Release 5 years ago
Large mkdocs adoption 4 years ago			`## NEWS-SERVERS`
How To Setup NZBGet Initial Release 5 years ago
Security Fixes: prevent a type of phishing known as tabnabbing. - Added: noopener noreferrer to external URL redirects (others pages will follow soon) - Info: Tabnabbing, sometimes called reverse tabnabbing, is an exploit that uses the browser's default behavior with target="_blank" to gain partial access to your page through the window.object API. With tabnabbing, a page that you link to could cause your page to redirect to a fake login page. This would be hard for most users to notice because the focus would be on the tab that just opened – not the original tab with your page. 4 years ago			`![!newsservers](images/newsservers.png)`
How To Setup NZBGet Initial Release 5 years ago
Large mkdocs adoption 4 years ago			`\| Name \| Description \|`
			`\|:--- \|:--- \|`
			\| `Active` \| Use this news server. \|
			\| `Name` \| The name is used in UI and for logging. It can be any string. \|
			\| `Level` \| Put your major download servers at level 0 and your fill servers at levels 1, 2, etc.. \|
			\| `Host` \| Host name of news server. \|
			\| `Port` \| Port to connect to. \|
			\| `Password` \| Password to use for authentication. \|
Security Fixes: prevent a type of phishing known as tabnabbing. - Added: noopener noreferrer to external URL redirects (others pages will follow soon) - Info: Tabnabbing, sometimes called reverse tabnabbing, is an exploit that uses the browser's default behavior with target="_blank" to gain partial access to your page through the window.object API. With tabnabbing, a page that you link to could cause your page to redirect to a fake login page. This would be hard for most users to notice because the focus would be on the tab that just opened – not the original tab with your page. 4 years ago			\| `Encryption` \| Encrypted server connection (TLS/SSL). (preferred to use this) \|
Large mkdocs adoption 4 years ago			\| `Connections` \| Use the lowest possible amount of connections +1 to gain your max download speed. \|
			\| `Retention` \| How long the articles are stored on the news server. \|
How To Setup NZBGet Initial Release 5 years ago
Large mkdocs adoption 4 years ago			`## CATEGORIES`
How To Setup NZBGet Initial Release 5 years ago
Security Fixes: prevent a type of phishing known as tabnabbing. - Added: noopener noreferrer to external URL redirects (others pages will follow soon) - Info: Tabnabbing, sometimes called reverse tabnabbing, is an exploit that uses the browser's default behavior with target="_blank" to gain partial access to your page through the window.object API. With tabnabbing, a page that you link to could cause your page to redirect to a fake login page. This would be hard for most users to notice because the focus would be on the tab that just opened – not the original tab with your page. 4 years ago			`![!categories](images/categories.png)`
Updated screenshots and description including instant move and hardlinks support Updated screenshots and description including instant move and hardlinks support 5 years ago
Large mkdocs adoption 4 years ago			`\| Name \| Description \|`
			`\|:--- \|:--- \|`
			\| `Name` \| This should match what you put in Sonarr/Radarr (tv/movies/sonarr/radarr/series/films) \|
			\| `DestDir` \| `${DestDir}` Destination directory (/data/.usenet/completed/movie) \|
			\| `Unpack` \| Unpack downloaded nzb-files. \|
			\| `Extensions` \| List of extension scripts for this category. \|
How To Setup NZBGet Initial Release 5 years ago
Large mkdocs adoption 4 years ago			`## INCOMING NZBS`
How To Setup NZBGet Initial Release 5 years ago
Security Fixes: prevent a type of phishing known as tabnabbing. - Added: noopener noreferrer to external URL redirects (others pages will follow soon) - Info: Tabnabbing, sometimes called reverse tabnabbing, is an exploit that uses the browser's default behavior with target="_blank" to gain partial access to your page through the window.object API. With tabnabbing, a page that you link to could cause your page to redirect to a fake login page. This would be hard for most users to notice because the focus would be on the tab that just opened – not the original tab with your page. 4 years ago			`![!incoming](images/incoming.png)`
How To Setup NZBGet Initial Release 5 years ago
Large mkdocs adoption 4 years ago			`!!! warning`
			`AppendCategoryDir`: Create subdirectory with category-name in destination-directory.
How To Setup NZBGet Initial Release 5 years ago
Large mkdocs adoption 4 years ago			`## DOWNLOAD QUEUE`
How To Setup NZBGet Initial Release 5 years ago
Security Fixes: prevent a type of phishing known as tabnabbing. - Added: noopener noreferrer to external URL redirects (others pages will follow soon) - Info: Tabnabbing, sometimes called reverse tabnabbing, is an exploit that uses the browser's default behavior with target="_blank" to gain partial access to your page through the window.object API. With tabnabbing, a page that you link to could cause your page to redirect to a fake login page. This would be hard for most users to notice because the focus would be on the tab that just opened – not the original tab with your page. 4 years ago			`![!queue](images/queue.png)`
How To Setup NZBGet Initial Release 5 years ago
Large mkdocs adoption 4 years ago			`!!! warning`
			`WriteBuffer`: If you're low on memory don't set this to high.
How To Setup NZBGet Initial Release 5 years ago
Large mkdocs adoption 4 years ago			`## LOGGING`
How To Setup NZBGet Initial Release 5 years ago
Security Fixes: prevent a type of phishing known as tabnabbing. - Added: noopener noreferrer to external URL redirects (others pages will follow soon) - Info: Tabnabbing, sometimes called reverse tabnabbing, is an exploit that uses the browser's default behavior with target="_blank" to gain partial access to your page through the window.object API. With tabnabbing, a page that you link to could cause your page to redirect to a fake login page. This would be hard for most users to notice because the focus would be on the tab that just opened – not the original tab with your page. 4 years ago			`![!logging](images/logging.png)`
How To Setup NZBGet Initial Release 5 years ago
Large mkdocs adoption 4 years ago			`## CHECK AND REPAIR`
How To Setup NZBGet Initial Release 5 years ago
Security Fixes: prevent a type of phishing known as tabnabbing. - Added: noopener noreferrer to external URL redirects (others pages will follow soon) - Info: Tabnabbing, sometimes called reverse tabnabbing, is an exploit that uses the browser's default behavior with target="_blank" to gain partial access to your page through the window.object API. With tabnabbing, a page that you link to could cause your page to redirect to a fake login page. This would be hard for most users to notice because the focus would be on the tab that just opened – not the original tab with your page. 4 years ago			`![!checkAndRepair](images/checkAndRepair.png)`
How To Setup NZBGet Initial Release 5 years ago
Large mkdocs adoption 4 years ago			`## UNPACK`
How To Setup NZBGet Initial Release 5 years ago
Security Fixes: prevent a type of phishing known as tabnabbing. - Added: noopener noreferrer to external URL redirects (others pages will follow soon) - Info: Tabnabbing, sometimes called reverse tabnabbing, is an exploit that uses the browser's default behavior with target="_blank" to gain partial access to your page through the window.object API. With tabnabbing, a page that you link to could cause your page to redirect to a fake login page. This would be hard for most users to notice because the focus would be on the tab that just opened – not the original tab with your page. 4 years ago			`![!unpack](images/unpack.png)`
How To Setup NZBGet Initial Release 5 years ago
Large mkdocs adoption 4 years ago			`!!! warning`
			`DirectUnpack`: This might lower your download speed but the overall time could be faster. (disable on low powered devices)
How To Setup NZBGet Initial Release 5 years ago
Large mkdocs adoption 4 years ago			`## EXTENSION SCRIPTS`
How To Setup NZBGet Initial Release 5 years ago
Security Fixes: prevent a type of phishing known as tabnabbing. - Added: noopener noreferrer to external URL redirects (others pages will follow soon) - Info: Tabnabbing, sometimes called reverse tabnabbing, is an exploit that uses the browser's default behavior with target="_blank" to gain partial access to your page through the window.object API. With tabnabbing, a page that you link to could cause your page to redirect to a fake login page. This would be hard for most users to notice because the focus would be on the tab that just opened – not the original tab with your page. 4 years ago			`![!extScripts](images/extScripts.png)`
How To Setup NZBGet Initial Release 5 years ago
Large mkdocs adoption 4 years ago			`Depending if you're using some NZBGet script here you can change the order or when it should be used`