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.
Pick the active NZB client under Settings → Download clients. When SABnzbd is selected, that tab also edits its URL, API key, category, download directory, and TLS verification. NZBGet and blackhole keep their connection details in config.ini; the tab names the client and points you at the config file.
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. Choose it under Settings → Download clients, or set NZB_DOWNLOADER to 0 in config.ini. The fields marked below are editable in Settings; the rest are config.ini only.
Connection
| Setting | Type | Default | Description |
|---|---|---|---|
SAB_HOST | string | none | SABnzbd URL including port (e.g. http://localhost:8080). Editable in Settings. |
SAB_USERNAME | string | none | SABnzbd username, if authentication is enabled. |
SAB_PASSWORD | string | none | SABnzbd password. Encrypted at rest. |
SAB_APIKEY | string | none | API key from SABnzbd Config > General. Editable in Settings, stored encrypted, and never returned by the API. |
SAB_VERIFY | bool | False | Verify TLS certificates when connecting over HTTPS. Editable in Settings. Turn it on for an HTTPS SABnzbd with a real certificate. |
Download Behavior
| Setting | Type | Default | Description |
|---|---|---|---|
SAB_CATEGORY | string | none | SABnzbd category to file downloads under. Create the category in SABnzbd first. Editable in Settings. |
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 | none | Download directory for Comicarr downloads. Required when Comicarr does the post-processing, and the path must exist inside the Comicarr environment. Editable in Settings. |
SAB_VERSION | string | none | 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. Choose it under Settings → Download clients, or set NZB_DOWNLOADER to 1. Its connection fields live in config.ini.
Connection
| Setting | Type | Default | Description |
|---|---|---|---|
NZBGET_HOST | string | none | NZBGet hostname or IP (without protocol prefix). |
NZBGET_SUB | string | none | URL sub-path if NZBGet is behind a reverse proxy (e.g. /nzbget). |
NZBGET_PORT | int | none | NZBGet port (default NZBGet port is 6789). |
NZBGET_USERNAME | string | none | NZBGet control username. |
NZBGET_PASSWORD | string | none | NZBGet control password. Encrypted at rest. |
NZBGET_VERIFY | bool | False | Verify TLS certificates when connecting over HTTPS. |
Download Behavior
| Setting | Type | Default | Description |
|---|---|---|---|
NZBGET_PRIORITY | int | unset | Download priority. NZBGet uses integers: 0 = Normal, positive = higher. |
NZBGET_CATEGORY | string | none | NZBGet category for Comicarr downloads. |
NZBGET_DIRECTORY | string | none | 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. Choose it under Settings → Download clients, or set NZB_DOWNLOADER to 2.
Set BLACKHOLE_DIR to the directory that your download client watches for new .nzb files. The path must exist in the Comicarr environment and in the downloader's environment where the file is consumed.
Blackhole mode is useful when your download client does not have an API or when you want a simple file-based workflow.