SABnzbd¶

Description / name	Input element
Your domain name

Overview¶

SABnzbd is a free, open-source Usenet client designed to simplify downloading files from Usenet by automating the entire process using NZB files, which act as blueprints for locating content on Usenet servers.

Manual

Releases

Community

Saltbox Setup Process

Opting out of Usenet?

Skip to qBittorrent

Opting for another Usenet client?

Explore alternatives

Skip to NZBHydra2

Deployment¶

sb install sabnzbd

Usage¶

Visit https://sabnzbd.iYOUR_DOMAIN_NAMEi.

Basics¶

Go through the setup wizard. You will need to enter server details:

When you get to the end of the wizard, click "Go To SABnzbd"

Go to SABnzbd Config

You will need to add in categories for sonarr, radarr, and lidarr.

Set a relative directory name for each category.

You will need a category for each instance of sonarr/radarr/lidarr (for example, if you have a radarr and radarr4k you will need a category for each)

SABnzbd requires the server to be filled in to set categories up.

This needs to be done BEFORE adding SABnzbd as a downloader to any of those apps.

Direct unpack is disabled by default. Configure this as you prefer.
Make note of the API Key in the "General" section

When creating the connection in the arrs, use API Key rather than user/pass.

Note that the category matches between Radarr and SABnzbd. The specific category doesn't matter; just that they match.

Next¶

Are you setting Saltbox up for the first time?

Continue to NZBHydra2

Role Defaults¶

Use the Inventory to customize variables. (1)

Example override
```
sabnzbd_name: "custom_value"
```
Avoid overriding variables ending in _default

When overriding variables that end in _default (like sabnzbd_docker_envs_default), you replace the entire default configuration. Future updates that add new default values will not be applied to your setup, potentially breaking functionality.

Instead, use the corresponding _custom variable (like sabnzbd_docker_envs_custom) to add your changes. Custom values are merged with defaults, ensuring you receive updates.

BasicsWebDNSTraefikConfigThemeDockerDocker+Global Override Options

sabnzbd_name

# Type: string
sabnzbd_name: sabnzbd

sabnzbd_role_web_subdomain

# Type: string
sabnzbd_role_web_subdomain: "{{ sabnzbd_name }}"

sabnzbd_role_web_domain

# Type: string
sabnzbd_role_web_domain: "{{ user.domain }}"

sabnzbd_role_web_port

# Type: string
sabnzbd_role_web_port: "8080"

sabnzbd_role_web_url

# Type: string
sabnzbd_role_web_url: "{{ 'https://' + (lookup('role_var', '_web_subdomain', role='sabnzbd') + '.' + lookup('role_var', '_web_domain', role='sabnzbd')
                       if (lookup('role_var', '_web_subdomain', role='sabnzbd') | length > 0)
                       else lookup('role_var', '_web_domain', role='sabnzbd')) }}"

sabnzbd_role_web_local_url

# Type: string
sabnzbd_role_web_local_url: "{{ 'http://' + sabnzbd_name + ':' + lookup('role_var', '_web_port', role='sabnzbd') }}"

sabnzbd_role_dns_record

# Type: string
sabnzbd_role_dns_record: "{{ lookup('role_var', '_web_subdomain', role='sabnzbd') }}"

sabnzbd_role_dns_zone

# Type: string
sabnzbd_role_dns_zone: "{{ lookup('role_var', '_web_domain', role='sabnzbd') }}"

sabnzbd_role_dns_proxy

# Type: bool (true/false)
sabnzbd_role_dns_proxy: "{{ dns_proxied }}"

sabnzbd_role_traefik_sso_middleware

# Type: string
sabnzbd_role_traefik_sso_middleware: "{{ traefik_default_sso_middleware }}"

sabnzbd_role_traefik_middleware_default

# Type: string
sabnzbd_role_traefik_middleware_default: "{{ traefik_default_middleware
                                             + (',themepark-' + sabnzbd_name
                                               if (lookup('role_var', '_themepark_enabled', role='sabnzbd') and global_themepark_plugin_enabled)
                                               else '') }}"

sabnzbd_role_traefik_middleware_custom

# Type: string
sabnzbd_role_traefik_middleware_custom: ""

sabnzbd_role_traefik_certresolver

# Type: string
sabnzbd_role_traefik_certresolver: "{{ traefik_default_certresolver }}"

sabnzbd_role_traefik_enabled

# Type: bool (true/false)
sabnzbd_role_traefik_enabled: true

sabnzbd_role_traefik_api_enabled

# Type: bool (true/false)
sabnzbd_role_traefik_api_enabled: true

sabnzbd_role_traefik_api_endpoint

# Type: string
sabnzbd_role_traefik_api_endpoint: "PathPrefix(`/api`)"

sabnzbd_role_config_settings_web

# Type: string
sabnzbd_role_config_settings_web:
  # Web
  - { option: "host_whitelist", value: "{{ lookup('role_var', '_web_subdomain', role='sabnzbd') }}.{{ lookup('role_var', '_web_domain', role='sabnzbd') }}, {{ sabnzbd_name }}" }
  - { option: "url_base", value: "" }
  - { option: "log_dir", value: "/config/logs" }

sabnzbd_role_config_settings_default

# Type: string
sabnzbd_role_config_settings_default:
  # Web
  - { option: "host_whitelist", value: "{{ lookup('role_var', '_web_subdomain', role='sabnzbd') }}.{{ lookup('role_var', '_web_domain', role='sabnzbd') }}, {{ sabnzbd_name }}" }
  - { option: "url_base", value: "" }
  # Paths
  - { option: "dirscan_dir", value: "{{ lookup('role_var', '_paths_downloads_location', role='sabnzbd') }}/watch" }
  - { option: "download_dir", value: "{{ lookup('role_var', '_paths_downloads_location', role='sabnzbd') }}/incomplete" }
  - { option: "complete_dir", value: "{{ lookup('role_var', '_paths_downloads_location', role='sabnzbd') }}/complete" }
  - { option: "log_dir", value: "/config/logs" }

sabnzbd_role_config_settings_custom

# Type: list
sabnzbd_role_config_settings_custom: []

sabnzbd_role_config_settings_list

# Type: string
sabnzbd_role_config_settings_list: "{{ lookup('role_var', '_config_settings_default', role='sabnzbd')
                                       + lookup('role_var', '_config_settings_custom', role='sabnzbd') }}"

sabnzbd_role_themepark_enabled

# Options can be found at https://github.com/themepark-dev/theme.park
# Type: bool (true/false)
sabnzbd_role_themepark_enabled: false

sabnzbd_role_themepark_app

# Type: string
sabnzbd_role_themepark_app: "sabnzbd"

sabnzbd_role_themepark_theme

# Type: string
sabnzbd_role_themepark_theme: "{{ global_themepark_theme }}"

sabnzbd_role_themepark_domain

# Type: string
sabnzbd_role_themepark_domain: "{{ global_themepark_domain }}"

sabnzbd_role_themepark_addons

# Type: list
sabnzbd_role_themepark_addons: []

Container

sabnzbd_role_docker_container

# Type: string
sabnzbd_role_docker_container: "{{ sabnzbd_name }}"

Image

sabnzbd_role_docker_image_pull

# Type: bool (true/false)
sabnzbd_role_docker_image_pull: true

sabnzbd_role_docker_image_repo

# Type: string
sabnzbd_role_docker_image_repo: "ghcr.io/hotio/sabnzbd"

sabnzbd_role_docker_image_tag

# Type: string
sabnzbd_role_docker_image_tag: "latest"

sabnzbd_role_docker_image

# Type: string
sabnzbd_role_docker_image: "{{ lookup('role_var', '_docker_image_repo', role='sabnzbd') }}:{{ lookup('role_var', '_docker_image_tag', role='sabnzbd') }}"

Envs

sabnzbd_role_docker_envs_default

# Type: dict
sabnzbd_role_docker_envs_default:
  PUID: "{{ uid }}"
  PGID: "{{ gid }}"
  UMASK: "002"
  TZ: "{{ tz }}"

sabnzbd_role_docker_envs_custom

# Type: dict
sabnzbd_role_docker_envs_custom: {}

Volumes

sabnzbd_role_docker_volumes_default

# Type: list
sabnzbd_role_docker_volumes_default:
  - "{{ sabnzbd_role_paths_location }}:/config"
  - "{{ server_appdata_path }}/scripts:/scripts"

sabnzbd_role_docker_volumes_custom

# Type: list
sabnzbd_role_docker_volumes_custom: []

Labels

sabnzbd_role_docker_labels_default

# Type: dict
sabnzbd_role_docker_labels_default: {}

sabnzbd_role_docker_labels_custom

# Type: dict
sabnzbd_role_docker_labels_custom: {}

Hostname

sabnzbd_role_docker_hostname

# Type: string
sabnzbd_role_docker_hostname: "{{ sabnzbd_name }}"

Networks

sabnzbd_role_docker_networks_alias

# Type: string
sabnzbd_role_docker_networks_alias: "{{ sabnzbd_name }}"

sabnzbd_role_docker_networks_default

# Type: list
sabnzbd_role_docker_networks_default: []

sabnzbd_role_docker_networks_custom

# Type: list
sabnzbd_role_docker_networks_custom: []

Restart Policy

sabnzbd_role_docker_restart_policy

# Type: string
sabnzbd_role_docker_restart_policy: unless-stopped

State

sabnzbd_role_docker_state

# Type: string
sabnzbd_role_docker_state: started

The following advanced options are available via create_docker_container but are not defined in the role. See: docker_container module

Resource Limits

sabnzbd_role_docker_blkio_weight

# Type: int
sabnzbd_role_docker_blkio_weight:

sabnzbd_role_docker_cpu_period

# Type: int
sabnzbd_role_docker_cpu_period:

sabnzbd_role_docker_cpu_quota

# Type: int
sabnzbd_role_docker_cpu_quota:

sabnzbd_role_docker_cpu_shares

# Type: int
sabnzbd_role_docker_cpu_shares:

sabnzbd_role_docker_cpus

# Type: string
sabnzbd_role_docker_cpus:

sabnzbd_role_docker_cpuset_cpus

# Type: string
sabnzbd_role_docker_cpuset_cpus:

sabnzbd_role_docker_cpuset_mems

# Type: string
sabnzbd_role_docker_cpuset_mems:

sabnzbd_role_docker_kernel_memory

# Type: string
sabnzbd_role_docker_kernel_memory:

sabnzbd_role_docker_memory

# Type: string
sabnzbd_role_docker_memory:

sabnzbd_role_docker_memory_reservation

# Type: string
sabnzbd_role_docker_memory_reservation:

sabnzbd_role_docker_memory_swap

# Type: string
sabnzbd_role_docker_memory_swap:

sabnzbd_role_docker_memory_swappiness

# Type: int
sabnzbd_role_docker_memory_swappiness:

sabnzbd_role_docker_shm_size

# Type: string
sabnzbd_role_docker_shm_size:

Security & Devices

sabnzbd_role_docker_cap_drop

# Type: list
sabnzbd_role_docker_cap_drop:

sabnzbd_role_docker_cgroupns_mode

# Type: string
sabnzbd_role_docker_cgroupns_mode:

sabnzbd_role_docker_device_cgroup_rules

# Type: list
sabnzbd_role_docker_device_cgroup_rules:

sabnzbd_role_docker_device_read_bps

# Type: list
sabnzbd_role_docker_device_read_bps:

sabnzbd_role_docker_device_read_iops

# Type: list
sabnzbd_role_docker_device_read_iops:

sabnzbd_role_docker_device_requests

# Type: list
sabnzbd_role_docker_device_requests:

sabnzbd_role_docker_device_write_bps

# Type: list
sabnzbd_role_docker_device_write_bps:

sabnzbd_role_docker_device_write_iops

# Type: list
sabnzbd_role_docker_device_write_iops:

sabnzbd_role_docker_devices

# Type: list
sabnzbd_role_docker_devices:

sabnzbd_role_docker_devices_default

# Type: string
sabnzbd_role_docker_devices_default:

sabnzbd_role_docker_groups

# Type: list
sabnzbd_role_docker_groups:

sabnzbd_role_docker_privileged

# Type: bool (true/false)
sabnzbd_role_docker_privileged:

sabnzbd_role_docker_security_opts

# Type: list
sabnzbd_role_docker_security_opts:

sabnzbd_role_docker_user

# Type: string
sabnzbd_role_docker_user:

sabnzbd_role_docker_userns_mode

# Type: string
sabnzbd_role_docker_userns_mode:

Networking

sabnzbd_role_docker_dns_opts

# Type: list
sabnzbd_role_docker_dns_opts:

sabnzbd_role_docker_dns_search_domains

# Type: list
sabnzbd_role_docker_dns_search_domains:

sabnzbd_role_docker_dns_servers

# Type: list
sabnzbd_role_docker_dns_servers:

sabnzbd_role_docker_domainname

# Type: string
sabnzbd_role_docker_domainname:

sabnzbd_role_docker_exposed_ports

# Type: list
sabnzbd_role_docker_exposed_ports:

sabnzbd_role_docker_hosts

# Type: dict
sabnzbd_role_docker_hosts:

sabnzbd_role_docker_hosts_use_common

# Type: bool (true/false)
sabnzbd_role_docker_hosts_use_common:

sabnzbd_role_docker_ipc_mode

# Type: string
sabnzbd_role_docker_ipc_mode:

sabnzbd_role_docker_links

# Type: list
sabnzbd_role_docker_links:

sabnzbd_role_docker_network_mode

# Type: string
sabnzbd_role_docker_network_mode:

sabnzbd_role_docker_pid_mode

# Type: string
sabnzbd_role_docker_pid_mode:

sabnzbd_role_docker_ports

# Type: list
sabnzbd_role_docker_ports:

sabnzbd_role_docker_uts

# Type: string
sabnzbd_role_docker_uts:

Storage

sabnzbd_role_docker_keep_volumes

# Type: bool (true/false)
sabnzbd_role_docker_keep_volumes:

sabnzbd_role_docker_mounts

# Type: list
sabnzbd_role_docker_mounts:

sabnzbd_role_docker_storage_opts

# Type: dict
sabnzbd_role_docker_storage_opts:

sabnzbd_role_docker_tmpfs

# Type: list
sabnzbd_role_docker_tmpfs:

sabnzbd_role_docker_volume_driver

# Type: string
sabnzbd_role_docker_volume_driver:

sabnzbd_role_docker_volumes_from

# Type: list
sabnzbd_role_docker_volumes_from:

sabnzbd_role_docker_volumes_global

# Type: bool (true/false)
sabnzbd_role_docker_volumes_global:

sabnzbd_role_docker_working_dir

# Type: string
sabnzbd_role_docker_working_dir:

Monitoring & Lifecycle

sabnzbd_role_docker_auto_remove

# Type: bool (true/false)
sabnzbd_role_docker_auto_remove:

sabnzbd_role_docker_cleanup

# Type: bool (true/false)
sabnzbd_role_docker_cleanup:

sabnzbd_role_docker_force_kill

# Type: string
sabnzbd_role_docker_force_kill:

sabnzbd_role_docker_healthcheck

# Type: dict
sabnzbd_role_docker_healthcheck:

sabnzbd_role_docker_healthy_wait_timeout

# Type: int
sabnzbd_role_docker_healthy_wait_timeout:

sabnzbd_role_docker_init

# Type: bool (true/false)
sabnzbd_role_docker_init:

sabnzbd_role_docker_kill_signal

# Type: string
sabnzbd_role_docker_kill_signal:

sabnzbd_role_docker_log_driver

# Type: string
sabnzbd_role_docker_log_driver:

sabnzbd_role_docker_log_options

# Type: dict
sabnzbd_role_docker_log_options:

sabnzbd_role_docker_oom_killer

# Type: bool (true/false)
sabnzbd_role_docker_oom_killer:

sabnzbd_role_docker_oom_score_adj

# Type: int
sabnzbd_role_docker_oom_score_adj:

sabnzbd_role_docker_output_logs

# Type: bool (true/false)
sabnzbd_role_docker_output_logs:

sabnzbd_role_docker_paused

# Type: bool (true/false)
sabnzbd_role_docker_paused:

sabnzbd_role_docker_recreate

# Type: bool (true/false)
sabnzbd_role_docker_recreate:

sabnzbd_role_docker_restart_retries

# Type: int
sabnzbd_role_docker_restart_retries:

sabnzbd_role_docker_stop_timeout

# Type: int
sabnzbd_role_docker_stop_timeout:

Other Options

sabnzbd_role_docker_capabilities

# Type: list
sabnzbd_role_docker_capabilities:

sabnzbd_role_docker_cgroup_parent

# Type: string
sabnzbd_role_docker_cgroup_parent:

sabnzbd_role_docker_commands

# Type: list
sabnzbd_role_docker_commands:

sabnzbd_role_docker_create_timeout

# Type: int
sabnzbd_role_docker_create_timeout:

sabnzbd_role_docker_entrypoint

# Type: string
sabnzbd_role_docker_entrypoint:

sabnzbd_role_docker_env_file

# Type: string
sabnzbd_role_docker_env_file:

sabnzbd_role_docker_labels_use_common

# Type: bool (true/false)
sabnzbd_role_docker_labels_use_common:

sabnzbd_role_docker_read_only

# Type: bool (true/false)
sabnzbd_role_docker_read_only:

sabnzbd_role_docker_runtime

# Type: string
sabnzbd_role_docker_runtime:

sabnzbd_role_docker_sysctls

# Type: list
sabnzbd_role_docker_sysctls:

sabnzbd_role_docker_ulimits

# Type: list
sabnzbd_role_docker_ulimits:

sabnzbd_role_autoheal_enabled

# Enable or disable Autoheal monitoring for the container created when deploying
# Type: bool (true/false)
sabnzbd_role_autoheal_enabled: true

sabnzbd_role_config_settings_custom

# Type: string
sabnzbd_role_config_settings_custom:

sabnzbd_role_config_settings_default

# Type: string
sabnzbd_role_config_settings_default:

sabnzbd_role_depends_on

# List of container dependencies that must be running before the container start
# Type: string
sabnzbd_role_depends_on: ""

sabnzbd_role_depends_on_delay

# Delay in seconds before starting the container after dependencies are ready
# Type: string (quoted number)
sabnzbd_role_depends_on_delay: "0"

sabnzbd_role_depends_on_healthchecks

# Enable healthcheck waiting for container dependencies
# Type: string ("true"/"false")
sabnzbd_role_depends_on_healthchecks:

sabnzbd_role_diun_enabled

# Enable or disable Diun update notifications for the container created when deploying
# Type: bool (true/false)
sabnzbd_role_diun_enabled: true

sabnzbd_role_dns_enabled

# Enable or disable automatic DNS record creation for the container
# Type: bool (true/false)
sabnzbd_role_dns_enabled: true

sabnzbd_role_docker_controller

# Enable or disable Saltbox Docker Controller management for the container
# Type: bool (true/false)
sabnzbd_role_docker_controller: true

sabnzbd_role_docker_image_repo

# Type: string
sabnzbd_role_docker_image_repo:

sabnzbd_role_docker_image_tag

# Type: string
sabnzbd_role_docker_image_tag:

sabnzbd_role_docker_volumes_download

# Type: bool (true/false)
sabnzbd_role_docker_volumes_download:

sabnzbd_role_paths_downloads_location

# Type: string
sabnzbd_role_paths_downloads_location:

sabnzbd_role_themepark_addons

# Type: string
sabnzbd_role_themepark_addons:

sabnzbd_role_themepark_app

# Type: string
sabnzbd_role_themepark_app:

sabnzbd_role_themepark_enabled

# Type: bool (true/false)
sabnzbd_role_themepark_enabled:

sabnzbd_role_themepark_theme

# Type: string
sabnzbd_role_themepark_theme:

sabnzbd_role_traefik_api_endpoint

# Type: dict/omit
sabnzbd_role_traefik_api_endpoint:

sabnzbd_role_traefik_api_middleware

# Type: string
sabnzbd_role_traefik_api_middleware:

sabnzbd_role_traefik_api_middleware_http

# Type: string
sabnzbd_role_traefik_api_middleware_http:

sabnzbd_role_traefik_autodetect_enabled

# Enable Traefik autodetect middleware for the container
# Type: bool (true/false)
sabnzbd_role_traefik_autodetect_enabled: false

sabnzbd_role_traefik_certresolver

# Type: string
sabnzbd_role_traefik_certresolver:

sabnzbd_role_traefik_crowdsec_enabled

# Enable CrowdSec middleware for the container
# Type: bool (true/false)
sabnzbd_role_traefik_crowdsec_enabled: false

sabnzbd_role_traefik_error_pages_enabled

# Enable custom error pages middleware for the container
# Type: bool (true/false)
sabnzbd_role_traefik_error_pages_enabled: false

sabnzbd_role_traefik_gzip_enabled

# Enable gzip compression middleware for the container
# Type: bool (true/false)
sabnzbd_role_traefik_gzip_enabled: false

sabnzbd_role_traefik_middleware_http

# Type: string
sabnzbd_role_traefik_middleware_http:

sabnzbd_role_traefik_middleware_http_api_insecure

# Type: bool (true/false)
sabnzbd_role_traefik_middleware_http_api_insecure:

sabnzbd_role_traefik_middleware_http_insecure

# Type: bool (true/false)
sabnzbd_role_traefik_middleware_http_insecure:

sabnzbd_role_traefik_priority

# Type: string
sabnzbd_role_traefik_priority:

sabnzbd_role_traefik_robot_enabled

# Enable robots.txt middleware for the container
# Type: bool (true/false)
sabnzbd_role_traefik_robot_enabled: true

sabnzbd_role_traefik_tailscale_enabled

# Enable Tailscale-specific Traefik configuration for the container
# Type: bool (true/false)
sabnzbd_role_traefik_tailscale_enabled: false

sabnzbd_role_traefik_wildcard_enabled

# Enable wildcard certificate for the container
# Type: bool (true/false)
sabnzbd_role_traefik_wildcard_enabled: true

sabnzbd_role_web_domain

# Type: string
sabnzbd_role_web_domain:

sabnzbd_role_web_fqdn_override

# Override the Traefik fully qualified domain name (FQDN) for the container
# Type: list
sabnzbd_role_web_fqdn_override:

Example Override

sabnzbd_role_web_fqdn_override:
  - "{{ traefik_host }}"
  - "sabnzbd2.{{ user.domain }}"
  - "sabnzbd.otherdomain.tld"

Note: Include {{ traefik_host }} to preserve the default FQDN alongside your custom entries

sabnzbd_role_web_host_override

# Override the Traefik web host configuration for the container
# Type: string
sabnzbd_role_web_host_override:

Example Override

sabnzbd_role_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'sabnzbd2.' + user.domain }}`)"

Note: Use {{ traefik_host }} to include the default host configuration in your custom rule

sabnzbd_role_web_http_port

# Type: string (quoted number)
sabnzbd_role_web_http_port:

sabnzbd_role_web_http_scheme

# Type: string ("http"/"https")
sabnzbd_role_web_http_scheme:

sabnzbd_role_web_http_serverstransport

# Type: dict/omit
sabnzbd_role_web_http_serverstransport:

sabnzbd_role_web_port

# Type: string (quoted number)
sabnzbd_role_web_port:

sabnzbd_role_web_scheme

# URL scheme to use for web access to the container
# Type: string ("http"/"https")
sabnzbd_role_web_scheme:

sabnzbd_role_web_serverstransport

# Type: dict/omit
sabnzbd_role_web_serverstransport:

sabnzbd_role_web_subdomain

# Type: string
sabnzbd_role_web_subdomain: