NZBGet¶

Description / name	Input element
Your domain name

Overview¶

NZBGet is a very efficient, cross-platform usenet downloader.

Manual

Releases

Community

Deployment¶

sb install nzbget

Usage¶

Visit https://nzbget.iYOUR_DOMAIN_NAMEi.

Basics¶

Paths¶

Download paths have already been specified, no need to change those.

News-Servers¶

Add your news servers.

Security¶

Login settings are preset out of the box (user / passwd as set in accounts.yml).

Download Queue¶

Disk Space
By default, minimum disk space is set at 100000 (i.e. 100GB). When space goes lower than this, NZBGet will pause the queue. If you have a smaller hard drive, you will need to lower this setting.

Connection¶

DailyQuota
If you are using Google Drive and set up the 300 service accounts in Rclone you can ignore this.
Otherwise, if you are using Google Drive, it's recommended you set this to 750000 (i.e. 750GB), to coincide with the Google Drive daily upload limit.

Extensions¶

Location on server: /opt/scripts/nzbget.
Location within NZBGet: /scripts/nzbget.

Role Defaults¶

Use the Inventory to customize variables. (1)

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

When overriding variables that end in _default (like nzbget_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 nzbget_docker_envs_custom) to add your changes. Custom values are merged with defaults, ensuring you receive updates.

BasicsWebDNSTraefikConfigScriptsThemeDockerDocker+Global Override Options

nzbget_name

# Type: string
nzbget_name: nzbget

nzbget_role_web_subdomain

# Type: string
nzbget_role_web_subdomain: "{{ nzbget_name }}"

nzbget_role_web_domain

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

nzbget_role_web_port

# Type: string
nzbget_role_web_port: "6789"

nzbget_role_web_url

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

nzbget_role_web_login

# Type: string
nzbget_role_web_login: "{{ user.name }}:{{ user.pass }}"

nzbget_role_web_url_with_login

# Type: string
nzbget_role_web_url_with_login: "{{ 'https://' + lookup('role_var', '_web_login', role='nzbget') + '@' + lookup('role_var', '_web_subdomain', role='nzbget') + '.' + lookup('role_var', '_web_domain', role='nzbget') }}"

nzbget_role_web_local_url

# Type: string
nzbget_role_web_local_url: "{{ 'http://' + nzbget_name + ':' + lookup('role_var', '_web_port', role='nzbget') }}"

nzbget_role_web_local_url_web_login

# Type: string
nzbget_role_web_local_url_web_login: "{{ 'http://' + lookup('role_var', '_web_login', role='nzbget') + '@' + nzbget_name + ':' + lookup('role_var', '_web_port', role='nzbget') }}"

nzbget_role_dns_record

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

nzbget_role_dns_zone

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

nzbget_role_dns_proxy

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

nzbget_role_traefik_sso_middleware

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

nzbget_role_traefik_middleware_default

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

nzbget_role_traefik_middleware_custom

# Type: string
nzbget_role_traefik_middleware_custom: ""

nzbget_role_traefik_certresolver

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

nzbget_role_traefik_enabled

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

nzbget_role_traefik_api_enabled

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

nzbget_role_traefik_api_endpoint

# Type: string
nzbget_role_traefik_api_endpoint: "PathRegexp(`^/[A-Za-z0-9]+:[A-Za-z0-9]+/(xml|json|jsonp)rpc`) || PathRegexp(`^/(xml|json|jsonp)rpc`)"

nzbget_role_config_new_installs_settings_default

# New Installs
# Type: string
nzbget_role_config_new_installs_settings_default:
  # Authentication
  - { regexp: '^ControlUsername\s?=.*', line: "ControlUsername={{ user.name }}" }
  - { regexp: '^ControlPassword\s?=.*', line: "ControlPassword={{ user.pass }}" }
  - { regexp: '^FormAuth\s?=.*', line: 'FormAuth=yes' }
  # Paths
  - { regexp: '^MainDir\s?=.*', line: 'MainDir=/mnt/unionfs/downloads/nzbs/{{ nzbget_name }}' }
  - { regexp: '^QueueDir\s?=.*', line: "QueueDir=${MainDir}/queue" }
  - { regexp: '^TempDir\s?=.*', line: "TempDir=${MainDir}/tmp" }
  - { regexp: '^ScriptDir\s?=.*', line: 'ScriptDir=/scripts/nzbget' }
  - { regexp: '^LockFile\s?=.*', line: 'LockFile=config/nzbget.lock' }
  - { regexp: '^LogFile\s?=.*', line: "LogFile=${MainDir}/nzbget.log" }
  # Default Categories
  - { regexp: '^Category1\.Name\s?=.*', line: 'Category1.Name=movies' }
  - { regexp: '^Category1\.Aliases\s?=.*', line: 'Category1.Aliases=movies*, Movies*' }
  - { regexp: '^Category2\.Name\s?=.*', line: 'Category2.Name=series' }
  - { regexp: '^Category2\.Aliases\s?=.*', line: 'Category2.Aliases=TV - HD, TV - SD, TV*' }
  - { regexp: '^Category3\.Name\s?=.*', line: 'Category3.Name=music' }
  - { regexp: '^Category3\.Aliases\s?=.*', line: 'Category3.Aliases=audio*' }
  - { regexp: '^Category4\.Name\s?=.*', line: 'Category4.Name=apps' }
  - { regexp: '^Category4\.Aliases\s?=.*', line: 'Category4.Aliases=apps*, pc*' }
  # New Categories
  - { regexp: '^Category5\.Name\s?=.*', line: 'Category5.Name=sonarr' }
  - { regexp: '^Category6\.Name\s?=.*', line: 'Category6.Name=radarr' }
  - { regexp: '^Category7\.Name\s?=.*', line: 'Category7.Name=lidarr' }
  # Logging
  - { regexp: '^WriteLog\s?=.*', line: 'WriteLog=rotate' }
  - { regexp: '^RotateLog\s?=.*', line: 'RotateLog=3' }
  # Min Disk Space = 100GB
  - { regexp: '^DiskSpace\s?=.*', line: 'DiskSpace=100000' }
  # HealthCheck
  - { regexp: '^HealthCheck\s?=.*', line: 'HealthCheck=Delete' }
  # Unpauser task
  - { regexp: '^#?Task1\.Time\s?=.*', line: 'Task1.Time=*,*:00,*:15,*:30,*:45' }
  - { regexp: '^#?Task1\.WeekDays\s?=.*', line: 'Task1.WeekDays=1-7' }
  - { regexp: '^#?Task1\.Command\s?=.*', line: 'Task1.Command=UnpauseDownload' }
  - { regexp: '^#?Task1\.Param\s?=.*', line: 'Task1.Param=' }
  # Scripts
  - { regexp: '^ShellOverride\s?=.*', line: 'ShellOverride=.py=/usr/bin/python3' }
  - { regexp: '^Extensions\s?=.*', line: 'Extensions=nzbgetpp/unzip.py, flatten.py, DeleteSamples.py, HashRenamer.py, reverse_name.py' }
  - { regexp: '^ScriptOrder\s?=.*', line: 'ScriptOrder=nzbgetpp/unzip.py, flatten.py, DeleteSamples.py, HashRenamer.py, reverse_name.py' }
  # Unpacking
  - { regexp: '^UnrarCmd\s?=.*', line: 'UnrarCmd=/usr/bin/unrar' }
  - { regexp: '^SevenZipCmd\s?=.*', line: 'SevenZipCmd=/usr/bin/7z' }
  - { regexp: '^ParIgnoreExt\s?=.*', line: 'ParIgnoreExt=.sfv, .nzb, .nfo, .srr, .1.rar' }
  - { regexp: '^ExtCleanupDisk\s?=.*', line: 'ExtCleanupDisk=.nzb, .par2, .sfv, .sfv.*, .rar.*,
                                                              .htm, .html, _brokenlog.txt, .srr,
                                                              .duplicate1.rar, .srs, .info, .txt,
                                                              .com, .md5, .png, .1, .url, .jpg,
                                                              .xxx, .rev, .iso, .img, .ifo, .vob' }

nzbget_role_config_new_installs_settings_custom

# Type: list
nzbget_role_config_new_installs_settings_custom: []

nzbget_role_config_new_installs_settings_list

# Type: string
nzbget_role_config_new_installs_settings_list: "{{ lookup('role_var', '_config_new_installs_settings_default', role='nzbget')
                                                   + lookup('role_var', '_config_new_installs_settings_custom', role='nzbget') }}"

nzbget_role_config_existing_installs_settings_default

# Existing Installs
# Type: string
nzbget_role_config_existing_installs_settings_default:
  # Logging
  - { regexp: '^WriteLog\s?=.*', line: 'WriteLog=rotate' }
  - { regexp: '^RotateLog\s?=.*', line: 'RotateLog=3' }
  # Scripts
  - { regexp: '^ShellOverride\s?=.*', line: 'ShellOverride=.py=/usr/bin/python3' }
  # Unpacking
  - { regexp: '^UnrarCmd\s?=.*', line: 'UnrarCmd=ionice -c3 /usr/bin/unrar' }
  - { regexp: '^SevenZipCmd\s?=.*', line: 'SevenZipCmd=ionice -c3 /usr/bin/7z' }

nzbget_role_config_existing_installs_settings_custom

# Type: list
nzbget_role_config_existing_installs_settings_custom: []

nzbget_role_config_existing_installs_settings_list

# Type: string
nzbget_role_config_existing_installs_settings_list: "{{ lookup('role_var', '_config_existing_installs_settings_default', role='nzbget')
                                                        + lookup('role_var', '_config_existing_installs_settings_custom', role='nzbget') }}"

nzbget_role_scripts_paths_location

# Paths
# Default nzbget_scripts_paths_location = /opt/scripts/nzbget
# Type: string
nzbget_role_scripts_paths_location: "{{ server_appdata_path }}/scripts/{{ nzbget_role_paths_folder }}"

nzbget_role_scripts_paths_folders_list

# Type: list
nzbget_role_scripts_paths_folders_list:
  - "{{ nzbget_role_scripts_paths_location }}"
  - "{{ nzbget_role_scripts_paths_location }}/nzbgetpp"

nzbget_role_scripts_paths_rarfile_py_location

# Type: string
nzbget_role_scripts_paths_rarfile_py_location: "{{ nzbget_role_scripts_paths_location }}/nzbgetpp/rarfile/rarfile.py"

nzbget_role_scripts_repos_default

# Repos Downloaded
# Type: list
nzbget_role_scripts_repos_default:
  - 'https://github.com/Prinz23/nzbgetpp.git'

nzbget_role_scripts_repos_custom

# Type: list
nzbget_role_scripts_repos_custom: []

nzbget_role_scripts_repos_list

# Type: string
nzbget_role_scripts_repos_list: "{{ lookup('role_var', '_scripts_repos_default', role='nzbget') + lookup('role_var', '_scripts_repos_custom', role='nzbget') }}"

nzbget_role_scripts_direct_downloads_default

# URLs Downloaded
# Type: list
nzbget_role_scripts_direct_downloads_default:
  - "https://raw.githubusercontent.com/clinton-hall/GetScripts/master/flatten.py"
  - "https://raw.githubusercontent.com/clinton-hall/GetScripts/master/DeleteSamples.py"
  - "https://raw.githubusercontent.com/Prinz23/nzbget-pp-reverse/master/reverse_name.py"
  - "https://raw.githubusercontent.com/l3uddz/nzbgetScripts/master/HashRenamer.py"

nzbget_role_scripts_direct_downloads_custom

# Type: list
nzbget_role_scripts_direct_downloads_custom: []

nzbget_role_scripts_direct_downloads_list

# Type: string
nzbget_role_scripts_direct_downloads_list: "{{ lookup('role_var', '_scripts_direct_downloads_default', role='nzbget')
                                               + lookup('role_var', '_scripts_direct_downloads_custom', role='nzbget') }}"

nzbget_role_scripts_local_copy_default

# Locally Copied
# Type: list
nzbget_role_scripts_local_copy_default: []

nzbget_role_scripts_local_copy_custom

# Type: list
nzbget_role_scripts_local_copy_custom: []

nzbget_role_scripts_local_copy_list

# Type: string
nzbget_role_scripts_local_copy_list: "{{ lookup('role_var', '_scripts_local_copy_default', role='nzbget')
                                         + lookup('role_var', '_scripts_local_copy_custom', role='nzbget') }}"

nzbget_role_themepark_enabled

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

nzbget_role_themepark_app

# Type: string
nzbget_role_themepark_app: "nzbget"

nzbget_role_themepark_theme

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

nzbget_role_themepark_domain

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

nzbget_role_themepark_addons

# Type: list
nzbget_role_themepark_addons: []

Container

nzbget_role_docker_container

# Type: string
nzbget_role_docker_container: "{{ nzbget_name }}"

Image

nzbget_role_docker_image_pull

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

nzbget_role_docker_image_repo

# Type: string
nzbget_role_docker_image_repo: "ghcr.io/hotio/nzbget"

nzbget_role_docker_image_tag

# Type: string
nzbget_role_docker_image_tag: "release"

nzbget_role_docker_image

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

Envs

nzbget_role_docker_envs_default

# Type: dict
nzbget_role_docker_envs_default:
  PUID: "{{ uid }}"
  PGID: "{{ gid }}"
  UMASK: "002"
  TZ: "{{ tz }}"
  LC_ALL: "C"

nzbget_role_docker_envs_custom

# Type: dict
nzbget_role_docker_envs_custom: {}

Volumes

nzbget_role_docker_volumes_default

# Type: list
nzbget_role_docker_volumes_default:
  - "{{ nzbget_role_paths_location }}:/config"
  - "{{ server_appdata_path }}/scripts:/scripts"

nzbget_role_docker_volumes_custom

# Type: list
nzbget_role_docker_volumes_custom: []

Labels

nzbget_role_docker_labels_default

# Type: dict
nzbget_role_docker_labels_default: {}

nzbget_role_docker_labels_custom

# Type: dict
nzbget_role_docker_labels_custom: {}

Hostname

nzbget_role_docker_hostname

# Type: string
nzbget_role_docker_hostname: "{{ nzbget_name }}"

Networks

nzbget_role_docker_networks_alias

# Type: string
nzbget_role_docker_networks_alias: "{{ nzbget_name }}"

nzbget_role_docker_networks_default

# Type: list
nzbget_role_docker_networks_default: []

nzbget_role_docker_networks_custom

# Type: list
nzbget_role_docker_networks_custom: []

Restart Policy

nzbget_role_docker_restart_policy

# Type: string
nzbget_role_docker_restart_policy: unless-stopped

State

nzbget_role_docker_state

# Type: string
nzbget_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

nzbget_role_docker_blkio_weight

# Type: int
nzbget_role_docker_blkio_weight:

nzbget_role_docker_cpu_period

# Type: int
nzbget_role_docker_cpu_period:

nzbget_role_docker_cpu_quota

# Type: int
nzbget_role_docker_cpu_quota:

nzbget_role_docker_cpu_shares

# Type: int
nzbget_role_docker_cpu_shares:

nzbget_role_docker_cpus

# Type: string
nzbget_role_docker_cpus:

nzbget_role_docker_cpuset_cpus

# Type: string
nzbget_role_docker_cpuset_cpus:

nzbget_role_docker_cpuset_mems

# Type: string
nzbget_role_docker_cpuset_mems:

nzbget_role_docker_kernel_memory

# Type: string
nzbget_role_docker_kernel_memory:

nzbget_role_docker_memory

# Type: string
nzbget_role_docker_memory:

nzbget_role_docker_memory_reservation

# Type: string
nzbget_role_docker_memory_reservation:

nzbget_role_docker_memory_swap

# Type: string
nzbget_role_docker_memory_swap:

nzbget_role_docker_memory_swappiness

# Type: int
nzbget_role_docker_memory_swappiness:

nzbget_role_docker_shm_size

# Type: string
nzbget_role_docker_shm_size:

Security & Devices

nzbget_role_docker_cap_drop

# Type: list
nzbget_role_docker_cap_drop:

nzbget_role_docker_cgroupns_mode

# Type: string
nzbget_role_docker_cgroupns_mode:

nzbget_role_docker_device_cgroup_rules

# Type: list
nzbget_role_docker_device_cgroup_rules:

nzbget_role_docker_device_read_bps

# Type: list
nzbget_role_docker_device_read_bps:

nzbget_role_docker_device_read_iops

# Type: list
nzbget_role_docker_device_read_iops:

nzbget_role_docker_device_requests

# Type: list
nzbget_role_docker_device_requests:

nzbget_role_docker_device_write_bps

# Type: list
nzbget_role_docker_device_write_bps:

nzbget_role_docker_device_write_iops

# Type: list
nzbget_role_docker_device_write_iops:

nzbget_role_docker_devices

# Type: list
nzbget_role_docker_devices:

nzbget_role_docker_devices_default

# Type: string
nzbget_role_docker_devices_default:

nzbget_role_docker_groups

# Type: list
nzbget_role_docker_groups:

nzbget_role_docker_privileged

# Type: bool (true/false)
nzbget_role_docker_privileged:

nzbget_role_docker_security_opts

# Type: list
nzbget_role_docker_security_opts:

nzbget_role_docker_user

# Type: string
nzbget_role_docker_user:

nzbget_role_docker_userns_mode

# Type: string
nzbget_role_docker_userns_mode:

Networking

nzbget_role_docker_dns_opts

# Type: list
nzbget_role_docker_dns_opts:

nzbget_role_docker_dns_search_domains

# Type: list
nzbget_role_docker_dns_search_domains:

nzbget_role_docker_dns_servers

# Type: list
nzbget_role_docker_dns_servers:

nzbget_role_docker_domainname

# Type: string
nzbget_role_docker_domainname:

nzbget_role_docker_exposed_ports

# Type: list
nzbget_role_docker_exposed_ports:

nzbget_role_docker_hosts

# Type: dict
nzbget_role_docker_hosts:

nzbget_role_docker_hosts_use_common

# Type: bool (true/false)
nzbget_role_docker_hosts_use_common:

nzbget_role_docker_ipc_mode

# Type: string
nzbget_role_docker_ipc_mode:

nzbget_role_docker_links

# Type: list
nzbget_role_docker_links:

nzbget_role_docker_network_mode

# Type: string
nzbget_role_docker_network_mode:

nzbget_role_docker_pid_mode

# Type: string
nzbget_role_docker_pid_mode:

nzbget_role_docker_ports

# Type: list
nzbget_role_docker_ports:

nzbget_role_docker_uts

# Type: string
nzbget_role_docker_uts:

Storage

nzbget_role_docker_keep_volumes

# Type: bool (true/false)
nzbget_role_docker_keep_volumes:

nzbget_role_docker_mounts

# Type: list
nzbget_role_docker_mounts:

nzbget_role_docker_storage_opts

# Type: dict
nzbget_role_docker_storage_opts:

nzbget_role_docker_tmpfs

# Type: list
nzbget_role_docker_tmpfs:

nzbget_role_docker_volume_driver

# Type: string
nzbget_role_docker_volume_driver:

nzbget_role_docker_volumes_from

# Type: list
nzbget_role_docker_volumes_from:

nzbget_role_docker_volumes_global

# Type: bool (true/false)
nzbget_role_docker_volumes_global:

nzbget_role_docker_working_dir

# Type: string
nzbget_role_docker_working_dir:

Monitoring & Lifecycle

nzbget_role_docker_auto_remove

# Type: bool (true/false)
nzbget_role_docker_auto_remove:

nzbget_role_docker_cleanup

# Type: bool (true/false)
nzbget_role_docker_cleanup:

nzbget_role_docker_force_kill

# Type: string
nzbget_role_docker_force_kill:

nzbget_role_docker_healthcheck

# Type: dict
nzbget_role_docker_healthcheck:

nzbget_role_docker_healthy_wait_timeout

# Type: int
nzbget_role_docker_healthy_wait_timeout:

nzbget_role_docker_init

# Type: bool (true/false)
nzbget_role_docker_init:

nzbget_role_docker_kill_signal

# Type: string
nzbget_role_docker_kill_signal:

nzbget_role_docker_log_driver

# Type: string
nzbget_role_docker_log_driver:

nzbget_role_docker_log_options

# Type: dict
nzbget_role_docker_log_options:

nzbget_role_docker_oom_killer

# Type: bool (true/false)
nzbget_role_docker_oom_killer:

nzbget_role_docker_oom_score_adj

# Type: int
nzbget_role_docker_oom_score_adj:

nzbget_role_docker_output_logs

# Type: bool (true/false)
nzbget_role_docker_output_logs:

nzbget_role_docker_paused

# Type: bool (true/false)
nzbget_role_docker_paused:

nzbget_role_docker_recreate

# Type: bool (true/false)
nzbget_role_docker_recreate:

nzbget_role_docker_restart_retries

# Type: int
nzbget_role_docker_restart_retries:

nzbget_role_docker_stop_timeout

# Type: int
nzbget_role_docker_stop_timeout:

Other Options

nzbget_role_docker_capabilities

# Type: list
nzbget_role_docker_capabilities:

nzbget_role_docker_cgroup_parent

# Type: string
nzbget_role_docker_cgroup_parent:

nzbget_role_docker_commands

# Type: list
nzbget_role_docker_commands:

nzbget_role_docker_create_timeout

# Type: int
nzbget_role_docker_create_timeout:

nzbget_role_docker_entrypoint

# Type: string
nzbget_role_docker_entrypoint:

nzbget_role_docker_env_file

# Type: string
nzbget_role_docker_env_file:

nzbget_role_docker_labels_use_common

# Type: bool (true/false)
nzbget_role_docker_labels_use_common:

nzbget_role_docker_read_only

# Type: bool (true/false)
nzbget_role_docker_read_only:

nzbget_role_docker_runtime

# Type: string
nzbget_role_docker_runtime:

nzbget_role_docker_sysctls

# Type: list
nzbget_role_docker_sysctls:

nzbget_role_docker_ulimits

# Type: list
nzbget_role_docker_ulimits:

nzbget_role_autoheal_enabled

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

nzbget_role_config_existing_installs_settings_custom

# Type: string
nzbget_role_config_existing_installs_settings_custom:

nzbget_role_config_existing_installs_settings_default

# Type: string
nzbget_role_config_existing_installs_settings_default:

nzbget_role_config_new_installs_settings_custom

# Type: string
nzbget_role_config_new_installs_settings_custom:

nzbget_role_config_new_installs_settings_default

# Type: string
nzbget_role_config_new_installs_settings_default:

nzbget_role_depends_on

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

nzbget_role_depends_on_delay

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

nzbget_role_depends_on_healthchecks

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

nzbget_role_diun_enabled

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

nzbget_role_dns_enabled

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

nzbget_role_docker_controller

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

nzbget_role_docker_image_repo

# Type: string
nzbget_role_docker_image_repo:

nzbget_role_docker_image_tag

# Type: string
nzbget_role_docker_image_tag:

nzbget_role_docker_volumes_download

# Type: bool (true/false)
nzbget_role_docker_volumes_download:

nzbget_role_scripts_direct_downloads_custom

# Type: string
nzbget_role_scripts_direct_downloads_custom:

nzbget_role_scripts_direct_downloads_default

# Type: string
nzbget_role_scripts_direct_downloads_default:

nzbget_role_scripts_local_copy_custom

# Type: string
nzbget_role_scripts_local_copy_custom:

nzbget_role_scripts_local_copy_default

# Type: string
nzbget_role_scripts_local_copy_default:

nzbget_role_scripts_repos_custom

# Type: string
nzbget_role_scripts_repos_custom:

nzbget_role_scripts_repos_default

# Type: string
nzbget_role_scripts_repos_default:

nzbget_role_themepark_addons

# Type: string
nzbget_role_themepark_addons:

nzbget_role_themepark_app

# Type: string
nzbget_role_themepark_app:

nzbget_role_themepark_enabled

# Type: bool (true/false)
nzbget_role_themepark_enabled:

nzbget_role_themepark_theme

# Type: string
nzbget_role_themepark_theme:

nzbget_role_traefik_api_endpoint

# Type: dict/omit
nzbget_role_traefik_api_endpoint:

nzbget_role_traefik_api_middleware

# Type: string
nzbget_role_traefik_api_middleware:

nzbget_role_traefik_api_middleware_http

# Type: string
nzbget_role_traefik_api_middleware_http:

nzbget_role_traefik_autodetect_enabled

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

nzbget_role_traefik_certresolver

# Type: string
nzbget_role_traefik_certresolver:

nzbget_role_traefik_crowdsec_enabled

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

nzbget_role_traefik_error_pages_enabled

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

nzbget_role_traefik_gzip_enabled

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

nzbget_role_traefik_middleware_http

# Type: string
nzbget_role_traefik_middleware_http:

nzbget_role_traefik_middleware_http_api_insecure

# Type: bool (true/false)
nzbget_role_traefik_middleware_http_api_insecure:

nzbget_role_traefik_middleware_http_insecure

# Type: bool (true/false)
nzbget_role_traefik_middleware_http_insecure:

nzbget_role_traefik_priority

# Type: string
nzbget_role_traefik_priority:

nzbget_role_traefik_robot_enabled

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

nzbget_role_traefik_tailscale_enabled

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

nzbget_role_traefik_wildcard_enabled

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

nzbget_role_web_domain

# Type: string
nzbget_role_web_domain:

nzbget_role_web_fqdn_override

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

Example Override

nzbget_role_web_fqdn_override:
  - "{{ traefik_host }}"
  - "nzbget2.{{ user.domain }}"
  - "nzbget.otherdomain.tld"

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

nzbget_role_web_host_override

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

Example Override

nzbget_role_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'nzbget2.' + user.domain }}`)"

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

nzbget_role_web_http_port

# Type: string (quoted number)
nzbget_role_web_http_port:

nzbget_role_web_http_scheme

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

nzbget_role_web_http_serverstransport

# Type: dict/omit
nzbget_role_web_http_serverstransport:

nzbget_role_web_login

# Type: string
nzbget_role_web_login:

nzbget_role_web_port

# Type: string (quoted number)
nzbget_role_web_port:

nzbget_role_web_scheme

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

nzbget_role_web_serverstransport

# Type: dict/omit
nzbget_role_web_serverstransport:

nzbget_role_web_subdomain

# Type: string
nzbget_role_web_subdomain: