NZBThrottle

Overview

NZBThrottle is a utility that automatically throttles Usenet download speeds based on custom schedules and conditions.

Manual

Releases

Community

---

Deployment

sb install nzbthrottle

Usage

NZBThrottle automatically throttles Usenet download speeds based on custom schedules. Configure your download clients (SABnzbd, NZBGet, etc.) and schedules in /opt/nzbthrottle/config.json, then restart with docker restart nzbthrottle.

Note: Configuration is file-based with no web interface.

Role Defaults

Use the Inventory to customize variables. (1)

1. Example override

   nzbthrottle_name: "custom_value"
   

   Avoid overriding variables ending in _default

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

BasicsDockerDocker+Global Override Options

nzbthrottle_name

# Type: string
nzbthrottle_name: nzbthrottle

Container

nzbthrottle_role_docker_container

# Type: string
nzbthrottle_role_docker_container: "{{ nzbthrottle_name }}"

Image

nzbthrottle_role_docker_image_pull

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

nzbthrottle_role_docker_image_repo

# Type: string
nzbthrottle_role_docker_image_repo: "daghaian/nzbthrottle"

nzbthrottle_role_docker_image_tag

# Type: string
nzbthrottle_role_docker_image_tag: "latest"

nzbthrottle_role_docker_image

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

Envs

nzbthrottle_role_docker_envs_default

# Type: dict
nzbthrottle_role_docker_envs_default:
  TZ: "{{ tz }}"

nzbthrottle_role_docker_envs_custom

# Type: dict
nzbthrottle_role_docker_envs_custom: {}

Volumes

nzbthrottle_role_docker_volumes_default

# Type: list
nzbthrottle_role_docker_volumes_default:
  - "{{ nzbthrottle_role_paths_config_location }}:/nzbthrottle/config.json:ro"

nzbthrottle_role_docker_volumes_custom

# Type: list
nzbthrottle_role_docker_volumes_custom: []

Hostname

nzbthrottle_role_docker_hostname

# Type: string
nzbthrottle_role_docker_hostname: "{{ nzbthrottle_name }}"

Networks

nzbthrottle_role_docker_networks_alias

# Type: string
nzbthrottle_role_docker_networks_alias: "{{ nzbthrottle_name }}"

nzbthrottle_role_docker_networks_default

# Type: list
nzbthrottle_role_docker_networks_default: []

nzbthrottle_role_docker_networks_custom

# Type: list
nzbthrottle_role_docker_networks_custom: []

Restart Policy

nzbthrottle_role_docker_restart_policy

# Type: string
nzbthrottle_role_docker_restart_policy: unless-stopped

State

nzbthrottle_role_docker_state

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

nzbthrottle_role_docker_blkio_weight

# Type: int
nzbthrottle_role_docker_blkio_weight:

nzbthrottle_role_docker_cpu_period

# Type: int
nzbthrottle_role_docker_cpu_period:

nzbthrottle_role_docker_cpu_quota

# Type: int
nzbthrottle_role_docker_cpu_quota:

nzbthrottle_role_docker_cpu_shares

# Type: int
nzbthrottle_role_docker_cpu_shares:

nzbthrottle_role_docker_cpus

# Type: string
nzbthrottle_role_docker_cpus:

nzbthrottle_role_docker_cpuset_cpus

# Type: string
nzbthrottle_role_docker_cpuset_cpus:

nzbthrottle_role_docker_cpuset_mems

# Type: string
nzbthrottle_role_docker_cpuset_mems:

nzbthrottle_role_docker_kernel_memory

# Type: string
nzbthrottle_role_docker_kernel_memory:

nzbthrottle_role_docker_memory

# Type: string
nzbthrottle_role_docker_memory:

nzbthrottle_role_docker_memory_reservation

# Type: string
nzbthrottle_role_docker_memory_reservation:

nzbthrottle_role_docker_memory_swap

# Type: string
nzbthrottle_role_docker_memory_swap:

nzbthrottle_role_docker_memory_swappiness

# Type: int
nzbthrottle_role_docker_memory_swappiness:

nzbthrottle_role_docker_shm_size

# Type: string
nzbthrottle_role_docker_shm_size:

Security & Devices

nzbthrottle_role_docker_cap_drop

# Type: list
nzbthrottle_role_docker_cap_drop:

nzbthrottle_role_docker_cgroupns_mode

# Type: string
nzbthrottle_role_docker_cgroupns_mode:

nzbthrottle_role_docker_device_cgroup_rules

# Type: list
nzbthrottle_role_docker_device_cgroup_rules:

nzbthrottle_role_docker_device_read_bps

# Type: list
nzbthrottle_role_docker_device_read_bps:

nzbthrottle_role_docker_device_read_iops

# Type: list
nzbthrottle_role_docker_device_read_iops:

nzbthrottle_role_docker_device_requests

# Type: list
nzbthrottle_role_docker_device_requests:

nzbthrottle_role_docker_device_write_bps

# Type: list
nzbthrottle_role_docker_device_write_bps:

nzbthrottle_role_docker_device_write_iops

# Type: list
nzbthrottle_role_docker_device_write_iops:

nzbthrottle_role_docker_devices

# Type: list
nzbthrottle_role_docker_devices:

nzbthrottle_role_docker_devices_default

# Type: string
nzbthrottle_role_docker_devices_default:

nzbthrottle_role_docker_groups

# Type: list
nzbthrottle_role_docker_groups:

nzbthrottle_role_docker_privileged

# Type: bool (true/false)
nzbthrottle_role_docker_privileged:

nzbthrottle_role_docker_security_opts

# Type: list
nzbthrottle_role_docker_security_opts:

nzbthrottle_role_docker_user

# Type: string
nzbthrottle_role_docker_user:

nzbthrottle_role_docker_userns_mode

# Type: string
nzbthrottle_role_docker_userns_mode:

Networking

nzbthrottle_role_docker_dns_opts

# Type: list
nzbthrottle_role_docker_dns_opts:

nzbthrottle_role_docker_dns_search_domains

# Type: list
nzbthrottle_role_docker_dns_search_domains:

nzbthrottle_role_docker_dns_servers

# Type: list
nzbthrottle_role_docker_dns_servers:

nzbthrottle_role_docker_domainname

# Type: string
nzbthrottle_role_docker_domainname:

nzbthrottle_role_docker_exposed_ports

# Type: list
nzbthrottle_role_docker_exposed_ports:

nzbthrottle_role_docker_hosts

# Type: dict
nzbthrottle_role_docker_hosts:

nzbthrottle_role_docker_hosts_use_common

# Type: bool (true/false)
nzbthrottle_role_docker_hosts_use_common:

nzbthrottle_role_docker_ipc_mode

# Type: string
nzbthrottle_role_docker_ipc_mode:

nzbthrottle_role_docker_links

# Type: list
nzbthrottle_role_docker_links:

nzbthrottle_role_docker_network_mode

# Type: string
nzbthrottle_role_docker_network_mode:

nzbthrottle_role_docker_pid_mode

# Type: string
nzbthrottle_role_docker_pid_mode:

nzbthrottle_role_docker_ports

# Type: list
nzbthrottle_role_docker_ports:

nzbthrottle_role_docker_uts

# Type: string
nzbthrottle_role_docker_uts:

Storage

nzbthrottle_role_docker_keep_volumes

# Type: bool (true/false)
nzbthrottle_role_docker_keep_volumes:

nzbthrottle_role_docker_mounts

# Type: list
nzbthrottle_role_docker_mounts:

nzbthrottle_role_docker_storage_opts

# Type: dict
nzbthrottle_role_docker_storage_opts:

nzbthrottle_role_docker_tmpfs

# Type: list
nzbthrottle_role_docker_tmpfs:

nzbthrottle_role_docker_volume_driver

# Type: string
nzbthrottle_role_docker_volume_driver:

nzbthrottle_role_docker_volumes_from

# Type: list
nzbthrottle_role_docker_volumes_from:

nzbthrottle_role_docker_volumes_global

# Type: bool (true/false)
nzbthrottle_role_docker_volumes_global:

nzbthrottle_role_docker_working_dir

# Type: string
nzbthrottle_role_docker_working_dir:

Monitoring & Lifecycle

nzbthrottle_role_docker_auto_remove

# Type: bool (true/false)
nzbthrottle_role_docker_auto_remove:

nzbthrottle_role_docker_cleanup

# Type: bool (true/false)
nzbthrottle_role_docker_cleanup:

nzbthrottle_role_docker_force_kill

# Type: string
nzbthrottle_role_docker_force_kill:

nzbthrottle_role_docker_healthcheck

# Type: dict
nzbthrottle_role_docker_healthcheck:

nzbthrottle_role_docker_healthy_wait_timeout

# Type: int
nzbthrottle_role_docker_healthy_wait_timeout:

nzbthrottle_role_docker_init

# Type: bool (true/false)
nzbthrottle_role_docker_init:

nzbthrottle_role_docker_kill_signal

# Type: string
nzbthrottle_role_docker_kill_signal:

nzbthrottle_role_docker_log_driver

# Type: string
nzbthrottle_role_docker_log_driver:

nzbthrottle_role_docker_log_options

# Type: dict
nzbthrottle_role_docker_log_options:

nzbthrottle_role_docker_oom_killer

# Type: bool (true/false)
nzbthrottle_role_docker_oom_killer:

nzbthrottle_role_docker_oom_score_adj

# Type: int
nzbthrottle_role_docker_oom_score_adj:

nzbthrottle_role_docker_output_logs

# Type: bool (true/false)
nzbthrottle_role_docker_output_logs:

nzbthrottle_role_docker_paused

# Type: bool (true/false)
nzbthrottle_role_docker_paused:

nzbthrottle_role_docker_recreate

# Type: bool (true/false)
nzbthrottle_role_docker_recreate:

nzbthrottle_role_docker_restart_retries

# Type: int
nzbthrottle_role_docker_restart_retries:

nzbthrottle_role_docker_stop_timeout

# Type: int
nzbthrottle_role_docker_stop_timeout:

Other Options

nzbthrottle_role_docker_capabilities

# Type: list
nzbthrottle_role_docker_capabilities:

nzbthrottle_role_docker_cgroup_parent

# Type: string
nzbthrottle_role_docker_cgroup_parent:

nzbthrottle_role_docker_commands

# Type: list
nzbthrottle_role_docker_commands:

nzbthrottle_role_docker_create_timeout

# Type: int
nzbthrottle_role_docker_create_timeout:

nzbthrottle_role_docker_entrypoint

# Type: string
nzbthrottle_role_docker_entrypoint:

nzbthrottle_role_docker_env_file

# Type: string
nzbthrottle_role_docker_env_file:

nzbthrottle_role_docker_labels

# Type: dict
nzbthrottle_role_docker_labels:

nzbthrottle_role_docker_labels_use_common

# Type: bool (true/false)
nzbthrottle_role_docker_labels_use_common:

nzbthrottle_role_docker_read_only

# Type: bool (true/false)
nzbthrottle_role_docker_read_only:

nzbthrottle_role_docker_runtime

# Type: string
nzbthrottle_role_docker_runtime:

nzbthrottle_role_docker_sysctls

# Type: list
nzbthrottle_role_docker_sysctls:

nzbthrottle_role_docker_ulimits

# Type: list
nzbthrottle_role_docker_ulimits:

nzbthrottle_role_autoheal_enabled

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

nzbthrottle_role_depends_on

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

nzbthrottle_role_depends_on_delay

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

nzbthrottle_role_depends_on_healthchecks

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

nzbthrottle_role_diun_enabled

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

nzbthrottle_role_docker_controller

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

nzbthrottle_role_docker_image_repo

# Type: string
nzbthrottle_role_docker_image_repo:

nzbthrottle_role_docker_image_tag

# Type: string
nzbthrottle_role_docker_image_tag:

nzbthrottle_role_docker_volumes_download

# Type: bool (true/false)
nzbthrottle_role_docker_volumes_download: