You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
TRaSH-Guides/docs/NZBGet/How-to-setup-NZBGet.md

98 lines
4.5 KiB

# 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