Download Clients
Configure SABnzbd, NZBGet, or NZB blackhole for Usenet downloads.
Comicarr supports three NZB download clients plus a "none" option if you only use torrents or direct downloads.
NZB Downloader Selection
| Setting | Type | Default | Description |
|---|---|---|---|
NZB_DOWNLOADER | int | 3 | Active NZB client: 0 = SABnzbd, 1 = NZBGet, 2 = Blackhole, 3 = None. |
SABnzbd is the most popular Usenet downloader. Set NZB_DOWNLOADER to 0 to use it.
Connection
| Setting | Type | Default | Description |
|---|---|---|---|
SAB_HOST | string | — | SABnzbd URL including port (e.g. http://localhost:8080). |
SAB_USERNAME | string | — | SABnzbd username, if authentication is enabled. |
SAB_PASSWORD | string | — | SABnzbd password. Encrypted at rest. |
SAB_APIKEY | string | — | API key from SABnzbd Config > General. |
SAB_VERIFY | bool | True | Verify TLS certificates when connecting over HTTPS. |
Download Behavior
| Setting | Type | Default | Description |
|---|---|---|---|
SAB_CATEGORY | string | — | SABnzbd category to file downloads under. Create the category in SABnzbd first. |
SAB_PRIORITY | string | Default | Download priority: Default, Low, Normal, High, Force. |
SAB_DIRECT_UNPACK | bool | False | Enable SABnzbd's Direct Unpack feature for faster extraction. |
SAB_DIRECTORY | string | — | Override the default download directory for Comicarr downloads. |
SAB_VERSION | string | — | SABnzbd version hint. Leave blank for auto-detection. |
Post-Processing
| Setting | Type | Default | Description |
|---|---|---|---|
SAB_MOVING_DELAY | int | 5 | Seconds to wait after SABnzbd signals completion before moving files. Helps avoid lock conflicts. |
SAB_CLIENT_POST_PROCESSING | bool | False | Let SABnzbd handle post-processing instead of Comicarr. |
SAB_REMOVE_COMPLETED | bool | False | Remove the download from SABnzbd's history after successful import. |
SAB_REMOVE_FAILED | bool | False | Remove the download from SABnzbd's history after a failure. |
If SAB_CLIENT_POST_PROCESSING is enabled, make sure SABnzbd's category script points back to Comicarr's post-processing endpoint.
NZBGet is a lightweight, high-performance Usenet downloader. Set NZB_DOWNLOADER to 1 to use it.
Connection
| Setting | Type | Default | Description |
|---|---|---|---|
NZBGET_HOST | string | — | NZBGet hostname or IP (without protocol prefix). |
NZBGET_SUB | string | — | URL sub-path if NZBGet is behind a reverse proxy (e.g. /nzbget). |
NZBGET_PORT | int | — | NZBGet port (default NZBGet port is 6789). |
NZBGET_USERNAME | string | — | NZBGet control username. |
NZBGET_PASSWORD | string | — | NZBGet control password. Encrypted at rest. |
NZBGET_VERIFY | bool | True | Verify TLS certificates when connecting over HTTPS. |
Download Behavior
| Setting | Type | Default | Description |
|---|---|---|---|
NZBGET_PRIORITY | int | 0 | Download priority. NZBGet uses integers: 0 = Normal, positive = higher. |
NZBGET_CATEGORY | string | — | NZBGet category for Comicarr downloads. |
NZBGET_DIRECTORY | string | — | Override download directory for Comicarr downloads. |
NZBGET_CLIENT_POST_PROCESSING | bool | False | Let NZBGet handle post-processing instead of Comicarr. |
The blackhole method saves .nzb files to a watched directory. Your download client picks them up automatically. Set NZB_DOWNLOADER to 2 to use it.
Configure your download client to watch the NEWCOM_DIR directory (or a dedicated blackhole folder) for new .nzb files.
Blackhole mode is useful when your download client does not have an API or when you want a simple file-based workflow.