Deluge¶
| Description / name | Input element |
|---|---|
| Your domain name |
Overview¶
Deluge is a full-featured BitTorrent client for Linux, OS X, Unix and Windows.
Deployment¶
sb install deluge
Usage¶
Visit https://deluge.iYOUR_DOMAIN_NAMEi.
Info
default login
user: admin
password: deluge
Basics¶
-
Change login password.
-
Click Preferences in the top bar and on the Downloads section enter the following paths:
- Download to:
/mnt/unionfs/downloads/torrents/deluge/incoming - Move completed to:
/mnt/unionfs/downloads/torrents/deluge/completed -
Autoadd
.torrent filesfrom:
/mnt/unionfs/downloads/torrents/deluge/watched -
Click the
Pluginssection - enable the
labelsplugin. - enable and the
Extractorplugin.
In order for Sonarr or Radarr to import media packaged within .rar files, they will have to be extracted. - After clicking
"Apply", select theExtractorplugin on the left.
Make sure the directory points to thecompletedfolder within your Deluge data directory.
/mnt/unionfs/downloads/torrents/deluge/completed
Also, make sure that the Create torrent name sub-folder setting is checked.
Adding to Sonarr/Radarr¶
To add Deluge as a download client in Sonarr/Radarr use the following settings. Both are able to remove completed torrents after they have finished seeding.
Role Defaults¶
Use the Inventory to customize variables. (1)
-
This role supports multiple instances via
deluge_instances.Example override
deluge_role_web_subdomain: "custom"Applies to all instances of deluge
deluge2_web_subdomain: "custom2"Applies to the instance named deluge2
Avoid overriding variables ending in
_defaultWhen overriding variables that end in
_default(likedeluge_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
_customvariable (likedeluge_docker_envs_custom) to add your changes. Custom values are merged with defaults, ensuring you receive updates.
deluge_instances
# Type: list
deluge_instances: ["deluge"]
Example Override
# Type: list
deluge_instances: ["deluge", "deluge2"]
deluge_role_web_subdomaindeluge2_web_subdomain
# Type: string
deluge_role_web_subdomain: "{{ deluge_name }}"
# Type: string
deluge2_web_subdomain: "{{ deluge_name }}"
deluge_role_web_domaindeluge2_web_domain
# Type: string
deluge_role_web_domain: "{{ user.domain }}"
# Type: string
deluge2_web_domain: "{{ user.domain }}"
deluge_role_web_portdeluge2_web_port
# Type: string
deluge_role_web_port: "8112"
# Type: string
deluge2_web_port: "8112"
deluge_role_web_urldeluge2_web_url
# Type: string
deluge_role_web_url: "{{ 'https://' + (lookup('role_var', '_web_subdomain', role='deluge') + '.' + lookup('role_var', '_web_domain', role='deluge')
if (lookup('role_var', '_web_subdomain', role='deluge') | length > 0)
else lookup('role_var', '_web_domain', role='deluge')) }}"
# Type: string
deluge2_web_url: "{{ 'https://' + (lookup('role_var', '_web_subdomain', role='deluge') + '.' + lookup('role_var', '_web_domain', role='deluge')
if (lookup('role_var', '_web_subdomain', role='deluge') | length > 0)
else lookup('role_var', '_web_domain', role='deluge')) }}"
deluge_role_dns_recorddeluge2_dns_record
# Type: string
deluge_role_dns_record: "{{ lookup('role_var', '_web_subdomain', role='deluge') }}"
# Type: string
deluge2_dns_record: "{{ lookup('role_var', '_web_subdomain', role='deluge') }}"
deluge_role_dns_zonedeluge2_dns_zone
# Type: string
deluge_role_dns_zone: "{{ lookup('role_var', '_web_domain', role='deluge') }}"
# Type: string
deluge2_dns_zone: "{{ lookup('role_var', '_web_domain', role='deluge') }}"
deluge_role_dns_proxydeluge2_dns_proxy
# Type: bool (true/false)
deluge_role_dns_proxy: "{{ dns_proxied }}"
# Type: bool (true/false)
deluge2_dns_proxy: "{{ dns_proxied }}"
deluge_role_traefik_sso_middlewaredeluge2_traefik_sso_middleware
# Type: string
deluge_role_traefik_sso_middleware: ""
# Type: string
deluge2_traefik_sso_middleware: ""
deluge_role_traefik_middleware_defaultdeluge2_traefik_middleware_default
# Type: string
deluge_role_traefik_middleware_default: "{{ traefik_default_middleware
+ (',themepark-' + deluge_name
if (lookup('role_var', '_themepark_enabled', role='deluge') and global_themepark_plugin_enabled)
else '') }}"
# Type: string
deluge2_traefik_middleware_default: "{{ traefik_default_middleware
+ (',themepark-' + deluge_name
if (lookup('role_var', '_themepark_enabled', role='deluge') and global_themepark_plugin_enabled)
else '') }}"
deluge_role_traefik_middleware_customdeluge2_traefik_middleware_custom
# Type: string
deluge_role_traefik_middleware_custom: ""
# Type: string
deluge2_traefik_middleware_custom: ""
deluge_role_traefik_certresolverdeluge2_traefik_certresolver
# Type: string
deluge_role_traefik_certresolver: "{{ traefik_default_certresolver }}"
# Type: string
deluge2_traefik_certresolver: "{{ traefik_default_certresolver }}"
deluge_role_traefik_enableddeluge2_traefik_enabled
# Type: bool (true/false)
deluge_role_traefik_enabled: true
# Type: bool (true/false)
deluge2_traefik_enabled: true
deluge_role_traefik_api_enableddeluge2_traefik_api_enabled
# Type: bool (true/false)
deluge_role_traefik_api_enabled: false
# Type: bool (true/false)
deluge2_traefik_api_enabled: false
deluge_role_traefik_api_endpointdeluge2_traefik_api_endpoint
# Type: string
deluge_role_traefik_api_endpoint: ""
# Type: string
deluge2_traefik_api_endpoint: ""
deluge_role_themepark_enableddeluge2_themepark_enabled
# Options can be found at https://github.com/themepark-dev/theme.park
# Type: bool (true/false)
deluge_role_themepark_enabled: false
# Options can be found at https://github.com/themepark-dev/theme.park
# Type: bool (true/false)
deluge2_themepark_enabled: false
deluge_role_themepark_appdeluge2_themepark_app
# Type: string
deluge_role_themepark_app: "deluge"
# Type: string
deluge2_themepark_app: "deluge"
deluge_role_themepark_themedeluge2_themepark_theme
# Type: string
deluge_role_themepark_theme: "{{ global_themepark_theme }}"
# Type: string
deluge2_themepark_theme: "{{ global_themepark_theme }}"
deluge_role_themepark_domaindeluge2_themepark_domain
# Type: string
deluge_role_themepark_domain: "{{ global_themepark_domain }}"
# Type: string
deluge2_themepark_domain: "{{ global_themepark_domain }}"
deluge_role_themepark_addonsdeluge2_themepark_addons
# Type: list
deluge_role_themepark_addons: []
# Type: list
deluge2_themepark_addons: []
Container
deluge_role_docker_containerdeluge2_docker_container
# Type: string
deluge_role_docker_container: "{{ deluge_name }}"
# Type: string
deluge2_docker_container: "{{ deluge_name }}"
Image
deluge_role_docker_image_pulldeluge2_docker_image_pull
# Type: bool (true/false)
deluge_role_docker_image_pull: true
# Type: bool (true/false)
deluge2_docker_image_pull: true
deluge_role_docker_image_repodeluge2_docker_image_repo
# Type: string
deluge_role_docker_image_repo: "lscr.io/linuxserver/deluge"
# Type: string
deluge2_docker_image_repo: "lscr.io/linuxserver/deluge"
deluge_role_docker_image_tagdeluge2_docker_image_tag
# Type: string
deluge_role_docker_image_tag: "latest"
# Type: string
deluge2_docker_image_tag: "latest"
deluge_role_docker_imagedeluge2_docker_image
# Type: string
deluge_role_docker_image: "{{ lookup('role_var', '_docker_image_repo', role='deluge') }}:{{ lookup('role_var', '_docker_image_tag', role='deluge') }}"
# Type: string
deluge2_docker_image: "{{ lookup('role_var', '_docker_image_repo', role='deluge') }}:{{ lookup('role_var', '_docker_image_tag', role='deluge') }}"
Ports
deluge_role_docker_ports_58112deluge2_docker_ports_58112
# Type: string
deluge_role_docker_ports_58112: "{{ port_lookup_58112.meta.port
if (port_lookup_58112.meta.port is defined) and (port_lookup_58112.meta.port | trim | length > 0)
else '58112' }}"
# Type: string
deluge2_docker_ports_58112: "{{ port_lookup_58112.meta.port
if (port_lookup_58112.meta.port is defined) and (port_lookup_58112.meta.port | trim | length > 0)
else '58112' }}"
deluge_role_docker_ports_defaultdeluge2_docker_ports_default
# Type: list
deluge_role_docker_ports_default:
- "{{ deluge_role_docker_ports_58112 }}:{{ deluge_role_docker_ports_58112 }}"
- "{{ deluge_role_docker_ports_58112 }}:{{ deluge_role_docker_ports_58112 }}/udp"
# Type: list
deluge2_docker_ports_default:
- "{{ deluge_role_docker_ports_58112 }}:{{ deluge_role_docker_ports_58112 }}"
- "{{ deluge_role_docker_ports_58112 }}:{{ deluge_role_docker_ports_58112 }}/udp"
deluge_role_docker_ports_customdeluge2_docker_ports_custom
# Type: list
deluge_role_docker_ports_custom: []
# Type: list
deluge2_docker_ports_custom: []
Envs
deluge_role_docker_envs_defaultdeluge2_docker_envs_default
# Type: dict
deluge_role_docker_envs_default:
PUID: "{{ uid }}"
PGID: "{{ gid }}"
TZ: "{{ tz }}"
UMASK: "002"
# Type: dict
deluge2_docker_envs_default:
PUID: "{{ uid }}"
PGID: "{{ gid }}"
TZ: "{{ tz }}"
UMASK: "002"
deluge_role_docker_envs_customdeluge2_docker_envs_custom
# Type: dict
deluge_role_docker_envs_custom: {}
# Type: dict
deluge2_docker_envs_custom: {}
Volumes
deluge_role_docker_volumes_defaultdeluge2_docker_volumes_default
# Type: list
deluge_role_docker_volumes_default:
- "{{ deluge_role_paths_location }}:/config"
- "{{ server_appdata_path }}/scripts:/scripts"
# Type: list
deluge2_docker_volumes_default:
- "{{ deluge_role_paths_location }}:/config"
- "{{ server_appdata_path }}/scripts:/scripts"
deluge_role_docker_volumes_customdeluge2_docker_volumes_custom
# Type: list
deluge_role_docker_volumes_custom: []
# Type: list
deluge2_docker_volumes_custom: []
Labels
deluge_role_docker_labels_defaultdeluge2_docker_labels_default
# Type: dict
deluge_role_docker_labels_default: {}
# Type: dict
deluge2_docker_labels_default: {}
deluge_role_docker_labels_customdeluge2_docker_labels_custom
# Type: dict
deluge_role_docker_labels_custom: {}
# Type: dict
deluge2_docker_labels_custom: {}
Hostname
deluge_role_docker_hostnamedeluge2_docker_hostname
# Type: string
deluge_role_docker_hostname: "{{ deluge_name }}"
# Type: string
deluge2_docker_hostname: "{{ deluge_name }}"
Networks
deluge_role_docker_networks_aliasdeluge2_docker_networks_alias
# Type: string
deluge_role_docker_networks_alias: "{{ deluge_name }}"
# Type: string
deluge2_docker_networks_alias: "{{ deluge_name }}"
deluge_role_docker_networks_defaultdeluge2_docker_networks_default
# Type: list
deluge_role_docker_networks_default: []
# Type: list
deluge2_docker_networks_default: []
deluge_role_docker_networks_customdeluge2_docker_networks_custom
# Type: list
deluge_role_docker_networks_custom: []
# Type: list
deluge2_docker_networks_custom: []
Restart Policy
deluge_role_docker_restart_policydeluge2_docker_restart_policy
# Type: string
deluge_role_docker_restart_policy: unless-stopped
# Type: string
deluge2_docker_restart_policy: unless-stopped
Stop Timeout
deluge_role_docker_stop_timeoutdeluge2_docker_stop_timeout
# Type: int
deluge_role_docker_stop_timeout: 900
# Type: int
deluge2_docker_stop_timeout: 900
State
deluge_role_docker_statedeluge2_docker_state
# Type: string
deluge_role_docker_state: started
# Type: string
deluge2_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
deluge_role_docker_blkio_weightdeluge2_docker_blkio_weight
# Type: int
deluge_role_docker_blkio_weight:
# Type: int
deluge2_docker_blkio_weight:
deluge_role_docker_cpu_perioddeluge2_docker_cpu_period
# Type: int
deluge_role_docker_cpu_period:
# Type: int
deluge2_docker_cpu_period:
deluge_role_docker_cpu_quotadeluge2_docker_cpu_quota
# Type: int
deluge_role_docker_cpu_quota:
# Type: int
deluge2_docker_cpu_quota:
deluge_role_docker_cpu_sharesdeluge2_docker_cpu_shares
# Type: int
deluge_role_docker_cpu_shares:
# Type: int
deluge2_docker_cpu_shares:
deluge_role_docker_cpusdeluge2_docker_cpus
# Type: string
deluge_role_docker_cpus:
# Type: string
deluge2_docker_cpus:
deluge_role_docker_cpuset_cpusdeluge2_docker_cpuset_cpus
# Type: string
deluge_role_docker_cpuset_cpus:
# Type: string
deluge2_docker_cpuset_cpus:
deluge_role_docker_cpuset_memsdeluge2_docker_cpuset_mems
# Type: string
deluge_role_docker_cpuset_mems:
# Type: string
deluge2_docker_cpuset_mems:
deluge_role_docker_kernel_memorydeluge2_docker_kernel_memory
# Type: string
deluge_role_docker_kernel_memory:
# Type: string
deluge2_docker_kernel_memory:
deluge_role_docker_memorydeluge2_docker_memory
# Type: string
deluge_role_docker_memory:
# Type: string
deluge2_docker_memory:
deluge_role_docker_memory_reservationdeluge2_docker_memory_reservation
# Type: string
deluge_role_docker_memory_reservation:
# Type: string
deluge2_docker_memory_reservation:
deluge_role_docker_memory_swapdeluge2_docker_memory_swap
# Type: string
deluge_role_docker_memory_swap:
# Type: string
deluge2_docker_memory_swap:
deluge_role_docker_memory_swappinessdeluge2_docker_memory_swappiness
# Type: int
deluge_role_docker_memory_swappiness:
# Type: int
deluge2_docker_memory_swappiness:
deluge_role_docker_shm_sizedeluge2_docker_shm_size
# Type: string
deluge_role_docker_shm_size:
# Type: string
deluge2_docker_shm_size:
Security & Devices
deluge_role_docker_cap_dropdeluge2_docker_cap_drop
# Type: list
deluge_role_docker_cap_drop:
# Type: list
deluge2_docker_cap_drop:
deluge_role_docker_cgroupns_modedeluge2_docker_cgroupns_mode
# Type: string
deluge_role_docker_cgroupns_mode:
# Type: string
deluge2_docker_cgroupns_mode:
deluge_role_docker_device_cgroup_rulesdeluge2_docker_device_cgroup_rules
# Type: list
deluge_role_docker_device_cgroup_rules:
# Type: list
deluge2_docker_device_cgroup_rules:
deluge_role_docker_device_read_bpsdeluge2_docker_device_read_bps
# Type: list
deluge_role_docker_device_read_bps:
# Type: list
deluge2_docker_device_read_bps:
deluge_role_docker_device_read_iopsdeluge2_docker_device_read_iops
# Type: list
deluge_role_docker_device_read_iops:
# Type: list
deluge2_docker_device_read_iops:
deluge_role_docker_device_requestsdeluge2_docker_device_requests
# Type: list
deluge_role_docker_device_requests:
# Type: list
deluge2_docker_device_requests:
deluge_role_docker_device_write_bpsdeluge2_docker_device_write_bps
# Type: list
deluge_role_docker_device_write_bps:
# Type: list
deluge2_docker_device_write_bps:
deluge_role_docker_device_write_iopsdeluge2_docker_device_write_iops
# Type: list
deluge_role_docker_device_write_iops:
# Type: list
deluge2_docker_device_write_iops:
deluge_role_docker_devicesdeluge2_docker_devices
# Type: list
deluge_role_docker_devices:
# Type: list
deluge2_docker_devices:
deluge_role_docker_devices_defaultdeluge2_docker_devices_default
# Type: string
deluge_role_docker_devices_default:
# Type: string
deluge2_docker_devices_default:
deluge_role_docker_groupsdeluge2_docker_groups
# Type: list
deluge_role_docker_groups:
# Type: list
deluge2_docker_groups:
deluge_role_docker_privilegeddeluge2_docker_privileged
# Type: bool (true/false)
deluge_role_docker_privileged:
# Type: bool (true/false)
deluge2_docker_privileged:
deluge_role_docker_security_optsdeluge2_docker_security_opts
# Type: list
deluge_role_docker_security_opts:
# Type: list
deluge2_docker_security_opts:
deluge_role_docker_userdeluge2_docker_user
# Type: string
deluge_role_docker_user:
# Type: string
deluge2_docker_user:
deluge_role_docker_userns_modedeluge2_docker_userns_mode
# Type: string
deluge_role_docker_userns_mode:
# Type: string
deluge2_docker_userns_mode:
Networking
deluge_role_docker_dns_optsdeluge2_docker_dns_opts
# Type: list
deluge_role_docker_dns_opts:
# Type: list
deluge2_docker_dns_opts:
deluge_role_docker_dns_search_domainsdeluge2_docker_dns_search_domains
# Type: list
deluge_role_docker_dns_search_domains:
# Type: list
deluge2_docker_dns_search_domains:
deluge_role_docker_dns_serversdeluge2_docker_dns_servers
# Type: list
deluge_role_docker_dns_servers:
# Type: list
deluge2_docker_dns_servers:
deluge_role_docker_domainnamedeluge2_docker_domainname
# Type: string
deluge_role_docker_domainname:
# Type: string
deluge2_docker_domainname:
deluge_role_docker_exposed_portsdeluge2_docker_exposed_ports
# Type: list
deluge_role_docker_exposed_ports:
# Type: list
deluge2_docker_exposed_ports:
deluge_role_docker_hostsdeluge2_docker_hosts
# Type: dict
deluge_role_docker_hosts:
# Type: dict
deluge2_docker_hosts:
deluge_role_docker_hosts_use_commondeluge2_docker_hosts_use_common
# Type: bool (true/false)
deluge_role_docker_hosts_use_common:
# Type: bool (true/false)
deluge2_docker_hosts_use_common:
deluge_role_docker_ipc_modedeluge2_docker_ipc_mode
# Type: string
deluge_role_docker_ipc_mode:
# Type: string
deluge2_docker_ipc_mode:
deluge_role_docker_linksdeluge2_docker_links
# Type: list
deluge_role_docker_links:
# Type: list
deluge2_docker_links:
deluge_role_docker_network_modedeluge2_docker_network_mode
# Type: string
deluge_role_docker_network_mode:
# Type: string
deluge2_docker_network_mode:
deluge_role_docker_pid_modedeluge2_docker_pid_mode
# Type: string
deluge_role_docker_pid_mode:
# Type: string
deluge2_docker_pid_mode:
deluge_role_docker_utsdeluge2_docker_uts
# Type: string
deluge_role_docker_uts:
# Type: string
deluge2_docker_uts:
Storage
deluge_role_docker_keep_volumesdeluge2_docker_keep_volumes
# Type: bool (true/false)
deluge_role_docker_keep_volumes:
# Type: bool (true/false)
deluge2_docker_keep_volumes:
deluge_role_docker_mountsdeluge2_docker_mounts
# Type: list
deluge_role_docker_mounts:
# Type: list
deluge2_docker_mounts:
deluge_role_docker_storage_optsdeluge2_docker_storage_opts
# Type: dict
deluge_role_docker_storage_opts:
# Type: dict
deluge2_docker_storage_opts:
deluge_role_docker_tmpfsdeluge2_docker_tmpfs
# Type: list
deluge_role_docker_tmpfs:
# Type: list
deluge2_docker_tmpfs:
deluge_role_docker_volume_driverdeluge2_docker_volume_driver
# Type: string
deluge_role_docker_volume_driver:
# Type: string
deluge2_docker_volume_driver:
deluge_role_docker_volumes_fromdeluge2_docker_volumes_from
# Type: list
deluge_role_docker_volumes_from:
# Type: list
deluge2_docker_volumes_from:
deluge_role_docker_volumes_globaldeluge2_docker_volumes_global
# Type: bool (true/false)
deluge_role_docker_volumes_global:
# Type: bool (true/false)
deluge2_docker_volumes_global:
deluge_role_docker_working_dirdeluge2_docker_working_dir
# Type: string
deluge_role_docker_working_dir:
# Type: string
deluge2_docker_working_dir:
Monitoring & Lifecycle
deluge_role_docker_auto_removedeluge2_docker_auto_remove
# Type: bool (true/false)
deluge_role_docker_auto_remove:
# Type: bool (true/false)
deluge2_docker_auto_remove:
deluge_role_docker_cleanupdeluge2_docker_cleanup
# Type: bool (true/false)
deluge_role_docker_cleanup:
# Type: bool (true/false)
deluge2_docker_cleanup:
deluge_role_docker_force_killdeluge2_docker_force_kill
# Type: string
deluge_role_docker_force_kill:
# Type: string
deluge2_docker_force_kill:
deluge_role_docker_healthcheckdeluge2_docker_healthcheck
# Type: dict
deluge_role_docker_healthcheck:
# Type: dict
deluge2_docker_healthcheck:
deluge_role_docker_healthy_wait_timeoutdeluge2_docker_healthy_wait_timeout
# Type: int
deluge_role_docker_healthy_wait_timeout:
# Type: int
deluge2_docker_healthy_wait_timeout:
deluge_role_docker_initdeluge2_docker_init
# Type: bool (true/false)
deluge_role_docker_init:
# Type: bool (true/false)
deluge2_docker_init:
deluge_role_docker_kill_signaldeluge2_docker_kill_signal
# Type: string
deluge_role_docker_kill_signal:
# Type: string
deluge2_docker_kill_signal:
deluge_role_docker_log_driverdeluge2_docker_log_driver
# Type: string
deluge_role_docker_log_driver:
# Type: string
deluge2_docker_log_driver:
deluge_role_docker_log_optionsdeluge2_docker_log_options
# Type: dict
deluge_role_docker_log_options:
# Type: dict
deluge2_docker_log_options:
deluge_role_docker_oom_killerdeluge2_docker_oom_killer
# Type: bool (true/false)
deluge_role_docker_oom_killer:
# Type: bool (true/false)
deluge2_docker_oom_killer:
deluge_role_docker_oom_score_adjdeluge2_docker_oom_score_adj
# Type: int
deluge_role_docker_oom_score_adj:
# Type: int
deluge2_docker_oom_score_adj:
deluge_role_docker_output_logsdeluge2_docker_output_logs
# Type: bool (true/false)
deluge_role_docker_output_logs:
# Type: bool (true/false)
deluge2_docker_output_logs:
deluge_role_docker_pauseddeluge2_docker_paused
# Type: bool (true/false)
deluge_role_docker_paused:
# Type: bool (true/false)
deluge2_docker_paused:
deluge_role_docker_recreatedeluge2_docker_recreate
# Type: bool (true/false)
deluge_role_docker_recreate:
# Type: bool (true/false)
deluge2_docker_recreate:
deluge_role_docker_restart_retriesdeluge2_docker_restart_retries
# Type: int
deluge_role_docker_restart_retries:
# Type: int
deluge2_docker_restart_retries:
Other Options
deluge_role_docker_capabilitiesdeluge2_docker_capabilities
# Type: list
deluge_role_docker_capabilities:
# Type: list
deluge2_docker_capabilities:
deluge_role_docker_cgroup_parentdeluge2_docker_cgroup_parent
# Type: string
deluge_role_docker_cgroup_parent:
# Type: string
deluge2_docker_cgroup_parent:
deluge_role_docker_commandsdeluge2_docker_commands
# Type: list
deluge_role_docker_commands:
# Type: list
deluge2_docker_commands:
deluge_role_docker_create_timeoutdeluge2_docker_create_timeout
# Type: int
deluge_role_docker_create_timeout:
# Type: int
deluge2_docker_create_timeout:
deluge_role_docker_entrypointdeluge2_docker_entrypoint
# Type: string
deluge_role_docker_entrypoint:
# Type: string
deluge2_docker_entrypoint:
deluge_role_docker_env_filedeluge2_docker_env_file
# Type: string
deluge_role_docker_env_file:
# Type: string
deluge2_docker_env_file:
deluge_role_docker_labels_use_commondeluge2_docker_labels_use_common
# Type: bool (true/false)
deluge_role_docker_labels_use_common:
# Type: bool (true/false)
deluge2_docker_labels_use_common:
deluge_role_docker_read_onlydeluge2_docker_read_only
# Type: bool (true/false)
deluge_role_docker_read_only:
# Type: bool (true/false)
deluge2_docker_read_only:
deluge_role_docker_runtimedeluge2_docker_runtime
# Type: string
deluge_role_docker_runtime:
# Type: string
deluge2_docker_runtime:
deluge_role_docker_sysctlsdeluge2_docker_sysctls
# Type: list
deluge_role_docker_sysctls:
# Type: list
deluge2_docker_sysctls:
deluge_role_docker_ulimitsdeluge2_docker_ulimits
# Type: list
deluge_role_docker_ulimits:
# Type: list
deluge2_docker_ulimits:
deluge_role_autoheal_enableddeluge2_autoheal_enabled
# Enable or disable Autoheal monitoring for containers created when deploying
# Type: bool (true/false)
deluge_role_autoheal_enabled: true
# Enable or disable Autoheal monitoring for containers created when deploying
# Type: bool (true/false)
deluge2_autoheal_enabled: true
deluge_role_depends_ondeluge2_depends_on
# List of container dependencies that must be running before containers start
# Type: string
deluge_role_depends_on: ""
# List of container dependencies that must be running before containers start
# Type: string
deluge2_depends_on: ""
deluge_role_depends_on_delaydeluge2_depends_on_delay
# Delay in seconds before starting containers after dependencies are ready
# Type: string (quoted number)
deluge_role_depends_on_delay: "0"
# Delay in seconds before starting containers after dependencies are ready
# Type: string (quoted number)
deluge2_depends_on_delay: "0"
deluge_role_depends_on_healthchecksdeluge2_depends_on_healthchecks
# Enable healthcheck waiting for container dependencies
# Type: string ("true"/"false")
deluge_role_depends_on_healthchecks:
# Enable healthcheck waiting for container dependencies
# Type: string ("true"/"false")
deluge2_depends_on_healthchecks:
deluge_role_diun_enableddeluge2_diun_enabled
# Enable or disable Diun update notifications for containers created when deploying
# Type: bool (true/false)
deluge_role_diun_enabled: true
# Enable or disable Diun update notifications for containers created when deploying
# Type: bool (true/false)
deluge2_diun_enabled: true
deluge_role_dns_enableddeluge2_dns_enabled
# Enable or disable automatic DNS record creation for containers
# Type: bool (true/false)
deluge_role_dns_enabled: true
# Enable or disable automatic DNS record creation for containers
# Type: bool (true/false)
deluge2_dns_enabled: true
deluge_role_docker_controllerdeluge2_docker_controller
# Enable or disable Saltbox Docker Controller management for containers
# Type: bool (true/false)
deluge_role_docker_controller: true
# Enable or disable Saltbox Docker Controller management for containers
# Type: bool (true/false)
deluge2_docker_controller: true
deluge_role_docker_image_repodeluge2_docker_image_repo
# Type: string
deluge_role_docker_image_repo:
# Type: string
deluge2_docker_image_repo:
deluge_role_docker_image_tagdeluge2_docker_image_tag
# Type: string
deluge_role_docker_image_tag:
# Type: string
deluge2_docker_image_tag:
deluge_role_docker_volumes_downloaddeluge2_docker_volumes_download
# Type: bool (true/false)
deluge_role_docker_volumes_download:
# Type: bool (true/false)
deluge2_docker_volumes_download:
deluge_role_themepark_addonsdeluge2_themepark_addons
# Type: string
deluge_role_themepark_addons:
# Type: string
deluge2_themepark_addons:
deluge_role_themepark_appdeluge2_themepark_app
# Type: string
deluge_role_themepark_app:
# Type: string
deluge2_themepark_app:
deluge_role_themepark_enableddeluge2_themepark_enabled
# Type: bool (true/false)
deluge_role_themepark_enabled:
# Type: bool (true/false)
deluge2_themepark_enabled:
deluge_role_themepark_themedeluge2_themepark_theme
# Type: string
deluge_role_themepark_theme:
# Type: string
deluge2_themepark_theme:
deluge_role_traefik_api_endpointdeluge2_traefik_api_endpoint
# Type: dict/omit
deluge_role_traefik_api_endpoint:
# Type: dict/omit
deluge2_traefik_api_endpoint:
deluge_role_traefik_api_middlewaredeluge2_traefik_api_middleware
# Type: string
deluge_role_traefik_api_middleware:
# Type: string
deluge2_traefik_api_middleware:
deluge_role_traefik_api_middleware_httpdeluge2_traefik_api_middleware_http
# Type: string
deluge_role_traefik_api_middleware_http:
# Type: string
deluge2_traefik_api_middleware_http:
deluge_role_traefik_autodetect_enableddeluge2_traefik_autodetect_enabled
# Enable Traefik autodetect middleware for containers
# Type: bool (true/false)
deluge_role_traefik_autodetect_enabled: false
# Enable Traefik autodetect middleware for containers
# Type: bool (true/false)
deluge2_traefik_autodetect_enabled: false
deluge_role_traefik_certresolverdeluge2_traefik_certresolver
# Type: string
deluge_role_traefik_certresolver:
# Type: string
deluge2_traefik_certresolver:
deluge_role_traefik_crowdsec_enableddeluge2_traefik_crowdsec_enabled
# Enable CrowdSec middleware for containers
# Type: bool (true/false)
deluge_role_traefik_crowdsec_enabled: false
# Enable CrowdSec middleware for containers
# Type: bool (true/false)
deluge2_traefik_crowdsec_enabled: false
deluge_role_traefik_error_pages_enableddeluge2_traefik_error_pages_enabled
# Enable custom error pages middleware for containers
# Type: bool (true/false)
deluge_role_traefik_error_pages_enabled: false
# Enable custom error pages middleware for containers
# Type: bool (true/false)
deluge2_traefik_error_pages_enabled: false
deluge_role_traefik_gzip_enableddeluge2_traefik_gzip_enabled
# Enable gzip compression middleware for containers
# Type: bool (true/false)
deluge_role_traefik_gzip_enabled: false
# Enable gzip compression middleware for containers
# Type: bool (true/false)
deluge2_traefik_gzip_enabled: false
deluge_role_traefik_middleware_httpdeluge2_traefik_middleware_http
# Type: string
deluge_role_traefik_middleware_http:
# Type: string
deluge2_traefik_middleware_http:
deluge_role_traefik_middleware_http_api_insecuredeluge2_traefik_middleware_http_api_insecure
# Type: bool (true/false)
deluge_role_traefik_middleware_http_api_insecure:
# Type: bool (true/false)
deluge2_traefik_middleware_http_api_insecure:
deluge_role_traefik_middleware_http_insecuredeluge2_traefik_middleware_http_insecure
# Type: bool (true/false)
deluge_role_traefik_middleware_http_insecure:
# Type: bool (true/false)
deluge2_traefik_middleware_http_insecure:
deluge_role_traefik_prioritydeluge2_traefik_priority
# Type: string
deluge_role_traefik_priority:
# Type: string
deluge2_traefik_priority:
deluge_role_traefik_robot_enableddeluge2_traefik_robot_enabled
# Enable robots.txt middleware for containers
# Type: bool (true/false)
deluge_role_traefik_robot_enabled: true
# Enable robots.txt middleware for containers
# Type: bool (true/false)
deluge2_traefik_robot_enabled: true
deluge_role_traefik_tailscale_enableddeluge2_traefik_tailscale_enabled
# Enable Tailscale-specific Traefik configuration for containers
# Type: bool (true/false)
deluge_role_traefik_tailscale_enabled: false
# Enable Tailscale-specific Traefik configuration for containers
# Type: bool (true/false)
deluge2_traefik_tailscale_enabled: false
deluge_role_traefik_wildcard_enableddeluge2_traefik_wildcard_enabled
# Enable wildcard certificate for containers
# Type: bool (true/false)
deluge_role_traefik_wildcard_enabled: true
# Enable wildcard certificate for containers
# Type: bool (true/false)
deluge2_traefik_wildcard_enabled: true
deluge_role_web_domaindeluge2_web_domain
# Type: string
deluge_role_web_domain:
# Type: string
deluge2_web_domain:
deluge_role_web_fqdn_overridedeluge2_web_fqdn_override
# Override the Traefik fully qualified domain name (FQDN) for containers
# Type: list
deluge_role_web_fqdn_override:
# Override the Traefik fully qualified domain name (FQDN) for containers
# Type: list
deluge2_web_fqdn_override:
Example Override
deluge_role_web_fqdn_override:
- "{{ traefik_host }}"
- "deluge2.{{ user.domain }}"
- "deluge.otherdomain.tld"
Note: Include {{ traefik_host }} to preserve the default FQDN alongside your custom entries
Example Override
deluge2_web_fqdn_override:
- "{{ traefik_host }}"
- "deluge2.{{ user.domain }}"
- "deluge.otherdomain.tld"
Note: Include {{ traefik_host }} to preserve the default FQDN alongside your custom entries
deluge_role_web_host_overridedeluge2_web_host_override
# Override the Traefik web host configuration for containers
# Type: string
deluge_role_web_host_override:
# Override the Traefik web host configuration for containers
# Type: string
deluge2_web_host_override:
Example Override
deluge_role_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'deluge2.' + user.domain }}`)"
Note: Use {{ traefik_host }} to include the default host configuration in your custom rule
Example Override
deluge2_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'deluge2.' + user.domain }}`)"
Note: Use {{ traefik_host }} to include the default host configuration in your custom rule
deluge_role_web_http_portdeluge2_web_http_port
# Type: string (quoted number)
deluge_role_web_http_port:
# Type: string (quoted number)
deluge2_web_http_port:
deluge_role_web_http_schemedeluge2_web_http_scheme
# Type: string ("http"/"https")
deluge_role_web_http_scheme:
# Type: string ("http"/"https")
deluge2_web_http_scheme:
deluge_role_web_http_serverstransportdeluge2_web_http_serverstransport
# Type: dict/omit
deluge_role_web_http_serverstransport:
# Type: dict/omit
deluge2_web_http_serverstransport:
deluge_role_web_schemedeluge2_web_scheme
# URL scheme to use for web access to containers
# Type: string ("http"/"https")
deluge_role_web_scheme:
# URL scheme to use for web access to containers
# Type: string ("http"/"https")
deluge2_web_scheme:
deluge_role_web_serverstransportdeluge2_web_serverstransport
# Type: dict/omit
deluge_role_web_serverstransport:
# Type: dict/omit
deluge2_web_serverstransport:
deluge_role_web_subdomaindeluge2_web_subdomain
# Type: string
deluge_role_web_subdomain:
# Type: string
deluge2_web_subdomain:
