Skip to content

Transmission¶

Description / nameInput element
Your domain name

Overview¶

Transmission is a fast, easy, and free BitTorrent client.


Deployment¶

sb install sandbox-transmission

Usage¶

Visit https://transmission.iYOUR_DOMAIN_NAMEi.

  • Suggested desktop client is Transmission Remote GUI. It is to be set up with ssl enabled on port 443

  • /watch is hard-coded in the software and not editable from the settings.json, see related issue. To get around this the folder is mounted to /mnt/local/downloads/torrents/transmission{{ rolename }}/watch

  • Do not change the published ports if you want to be connectable.

Role Defaults¶

Variables can be customized using the Inventory. (1)

  1. This role supports multiple instances via transmission_instances.

    Example override

    transmission_role_web_subdomain: "custom"
    

    Applies to all instances of transmission

    transmission2_web_subdomain: "custom2"
    

    Applies to the instance named transmission2

    Avoid overriding variables ending in _default

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

transmission_instances
# Type: list
transmission_instances: ["transmission"]

Example Override

# Type: list
transmission_instances: ["transmission", "transmission2"]
transmission_role_web_subdomaintransmission2_web_subdomain
# Type: string
transmission_role_web_subdomain: "{{ transmission_name }}"
# Type: string
transmission2_web_subdomain: "{{ transmission_name }}"
transmission_role_web_domaintransmission2_web_domain
# Type: string
transmission_role_web_domain: "{{ user.domain }}"
# Type: string
transmission2_web_domain: "{{ user.domain }}"
transmission_role_web_porttransmission2_web_port
# Type: string
transmission_role_web_port: "9091"
# Type: string
transmission2_web_port: "9091"
transmission_role_web_urltransmission2_web_url
# Type: string
transmission_role_web_url: "{{ lookup('role_web', role='transmission', scheme='https') }}"
# Type: string
transmission2_web_url: "{{ lookup('role_web', role='transmission', scheme='https') }}"
transmission_role_dns_recordtransmission2_dns_record
# Type: string
transmission_role_dns_record: "{{ lookup('role_var', '_web_subdomain', role='transmission') }}"
# Type: string
transmission2_dns_record: "{{ lookup('role_var', '_web_subdomain', role='transmission') }}"
transmission_role_dns_zonetransmission2_dns_zone
# Type: string
transmission_role_dns_zone: "{{ lookup('role_var', '_web_domain', role='transmission') }}"
# Type: string
transmission2_dns_zone: "{{ lookup('role_var', '_web_domain', role='transmission') }}"
transmission_role_dns_proxytransmission2_dns_proxy
# Type: bool (true/false)
transmission_role_dns_proxy: "{{ dns_proxied }}"
# Type: bool (true/false)
transmission2_dns_proxy: "{{ dns_proxied }}"
transmission_role_traefik_sso_middlewaretransmission2_traefik_sso_middleware
# Type: string
transmission_role_traefik_sso_middleware: "{{ traefik_default_sso_middleware }}"
# Type: string
transmission2_traefik_sso_middleware: "{{ traefik_default_sso_middleware }}"
transmission_role_traefik_middleware_defaulttransmission2_traefik_middleware_default
# Type: string
transmission_role_traefik_middleware_default: "{{ traefik_default_middleware }}"
# Type: string
transmission2_traefik_middleware_default: "{{ traefik_default_middleware }}"
transmission_role_traefik_middleware_customtransmission2_traefik_middleware_custom
# Type: string
transmission_role_traefik_middleware_custom: ""
# Type: string
transmission2_traefik_middleware_custom: ""
transmission_role_traefik_middleware_default_apitransmission2_traefik_middleware_default_api
# Type: string
transmission_role_traefik_middleware_default_api: "{{ traefik_default_middleware_api }}"
# Type: string
transmission2_traefik_middleware_default_api: "{{ traefik_default_middleware_api }}"
transmission_role_traefik_middleware_custom_apitransmission2_traefik_middleware_custom_api
# Type: string
transmission_role_traefik_middleware_custom_api: ""
# Type: string
transmission2_traefik_middleware_custom_api: ""
transmission_role_traefik_certresolvertransmission2_traefik_certresolver
# Type: string
transmission_role_traefik_certresolver: "{{ traefik_default_certresolver }}"
# Type: string
transmission2_traefik_certresolver: "{{ traefik_default_certresolver }}"
transmission_role_traefik_enabledtransmission2_traefik_enabled
# Type: bool (true/false)
transmission_role_traefik_enabled: true
# Type: bool (true/false)
transmission2_traefik_enabled: true
transmission_role_traefik_api_enabledtransmission2_traefik_api_enabled
# Type: bool (true/false)
transmission_role_traefik_api_enabled: true
# Type: bool (true/false)
transmission2_traefik_api_enabled: true
transmission_role_traefik_api_endpointtransmission2_traefik_api_endpoint
# Type: string
transmission_role_traefik_api_endpoint: "PathPrefix(`/rpc`)"
# Type: string
transmission2_traefik_api_endpoint: "PathPrefix(`/rpc`)"

When no saved assignment exists, the role allocates the first available port within the inclusive low and high bounds and retains it for future runs. Override an instance's bounds to control new allocation; set both bounds to the same value to require one exact port.

Existing assignments are stored in /opt/saltbox/port-assignments.json. A conflict-free saved port remains authoritative even outside the current bounds, including a port manually changed in that file. If a saved assignment conflicts, another available port is selected from the current bounds and a warning shows the old port, new port, and conflict source.

transmission_role_port_peer_low_boundtransmission2_port_peer_low_bound
# Type: int
transmission_role_port_peer_low_bound: 51413
# Type: int
transmission2_port_peer_low_bound: 51413
transmission_role_port_peer_high_boundtransmission2_port_peer_high_bound
# Type: int
transmission_role_port_peer_high_bound: 51433
# Type: int
transmission2_port_peer_high_bound: 51433

Container

transmission_role_docker_containertransmission2_docker_container
# Type: string
transmission_role_docker_container: "{{ transmission_name }}"
# Type: string
transmission2_docker_container: "{{ transmission_name }}"

Image

transmission_role_docker_image_pulltransmission2_docker_image_pull
# Type: bool (true/false)
transmission_role_docker_image_pull: true
# Type: bool (true/false)
transmission2_docker_image_pull: true
transmission_role_docker_image_repotransmission2_docker_image_repo
# Type: string
transmission_role_docker_image_repo: "lscr.io/linuxserver/transmission"
# Type: string
transmission2_docker_image_repo: "lscr.io/linuxserver/transmission"
transmission_role_docker_image_tagtransmission2_docker_image_tag
# Type: string
transmission_role_docker_image_tag: "latest"
# Type: string
transmission2_docker_image_tag: "latest"
transmission_role_docker_imagetransmission2_docker_image
# Type: string
transmission_role_docker_image: "{{ lookup('role_var', '_docker_image_repo', role='transmission') }}:{{ lookup('role_var', '_docker_image_tag', role='transmission') }}"
# Type: string
transmission2_docker_image: "{{ lookup('role_var', '_docker_image_repo', role='transmission') }}:{{ lookup('role_var', '_docker_image_tag', role='transmission') }}"

Ports

transmission_role_docker_ports_defaulttransmission2_docker_ports_default
# Type: list
transmission_role_docker_ports_default:
  - "{{ transmission_port_assignment.ports.peer }}:{{ transmission_port_assignment.ports.peer }}"
  - "{{ transmission_port_assignment.ports.peer }}:{{ transmission_port_assignment.ports.peer }}/udp"
# Type: list
transmission2_docker_ports_default:
  - "{{ transmission_port_assignment.ports.peer }}:{{ transmission_port_assignment.ports.peer }}"
  - "{{ transmission_port_assignment.ports.peer }}:{{ transmission_port_assignment.ports.peer }}/udp"
transmission_role_docker_ports_customtransmission2_docker_ports_custom
# Type: list
transmission_role_docker_ports_custom: []
# Type: list
transmission2_docker_ports_custom: []

Envs

transmission_role_docker_envs_defaulttransmission2_docker_envs_default
# Type: dict
transmission_role_docker_envs_default:
  PUID: "{{ uid }}"
  PGID: "{{ gid }}"
  TZ: "{{ tz }}"
  UMASK: "002"
  USER: "{{ user.name }}"
  PASS: "{{ user.pass }}"
# Type: dict
transmission2_docker_envs_default:
  PUID: "{{ uid }}"
  PGID: "{{ gid }}"
  TZ: "{{ tz }}"
  UMASK: "002"
  USER: "{{ user.name }}"
  PASS: "{{ user.pass }}"
transmission_role_docker_envs_customtransmission2_docker_envs_custom
# Type: dict
transmission_role_docker_envs_custom: {}
# Type: dict
transmission2_docker_envs_custom: {}

Volumes

transmission_role_docker_volumes_defaulttransmission2_docker_volumes_default
# Type: list
transmission_role_docker_volumes_default:
  - "{{ transmission_role_paths_location }}:/config"
  - "{{ server_appdata_path }}/scripts:/scripts"
  - "{{ transmission_role_paths_downloads_location }}/watched:/watch"
# Type: list
transmission2_docker_volumes_default:
  - "{{ transmission_role_paths_location }}:/config"
  - "{{ server_appdata_path }}/scripts:/scripts"
  - "{{ transmission_role_paths_downloads_location }}/watched:/watch"
transmission_role_docker_volumes_customtransmission2_docker_volumes_custom
# Type: list
transmission_role_docker_volumes_custom: []
# Type: list
transmission2_docker_volumes_custom: []

Hostname

transmission_role_docker_hostnametransmission2_docker_hostname
# Type: string
transmission_role_docker_hostname: "{{ transmission_name }}"
# Type: string
transmission2_docker_hostname: "{{ transmission_name }}"

Networks

transmission_role_docker_networks_aliastransmission2_docker_networks_alias
# Type: string
transmission_role_docker_networks_alias: "{{ transmission_name }}"
# Type: string
transmission2_docker_networks_alias: "{{ transmission_name }}"
transmission_role_docker_networks_defaulttransmission2_docker_networks_default
# Type: list
transmission_role_docker_networks_default: []
# Type: list
transmission2_docker_networks_default: []
transmission_role_docker_networks_customtransmission2_docker_networks_custom
# Type: list
transmission_role_docker_networks_custom: []
# Type: list
transmission2_docker_networks_custom: []

Restart Policy

transmission_role_docker_restart_policytransmission2_docker_restart_policy
# Type: string
transmission_role_docker_restart_policy: unless-stopped
# Type: string
transmission2_docker_restart_policy: unless-stopped

Stop Timeout

transmission_role_docker_stop_timeouttransmission2_docker_stop_timeout
# Type: int
transmission_role_docker_stop_timeout: 900
# Type: int
transmission2_docker_stop_timeout: 900

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

A blank value is YAML null and inherits any lower-precedence role or shared default. Explicit Ansible omit is accepted only for optional Docker settings; default-backed and required settings reject it. Use the documented typed empty value, such as "", [], or {}, when disabling a guaranteed setting.

GPU

transmission_role_docker_gpu_enabledtransmission2_docker_gpu_enabled
# Set this to true to let the app use a GPU.
# Intel access also requires gpu.intel: true.
# NVIDIA access also requires nvidia_enabled: true.
# This setting does not install or enable GPU support on the server.
# Type: bool (true/false)
transmission_role_docker_gpu_enabled: false
# Set this to true to let the app use a GPU.
# Intel access also requires gpu.intel: true.
# NVIDIA access also requires nvidia_enabled: true.
# This setting does not install or enable GPU support on the server.
# Type: bool (true/false)
transmission2_docker_gpu_enabled: false
transmission_role_docker_nvidia_disabledtransmission2_docker_nvidia_disabled
# Set this to true to turn off automatic NVIDIA access for this app.
# It only has an effect when the app's _docker_gpu_enabled option and
# nvidia_enabled are both true.
# Automatic /dev/dri access may remain.
# Type: bool (true/false)
transmission_role_docker_nvidia_disabled: false
# Set this to true to turn off automatic NVIDIA access for this app.
# It only has an effect when the app's _docker_gpu_enabled option and
# nvidia_enabled are both true.
# Automatic /dev/dri access may remain.
# Type: bool (true/false)
transmission2_docker_nvidia_disabled: false
transmission_role_docker_dev_dri_disabledtransmission2_docker_dev_dri_disabled
# Set this to true to stop Saltbox from automatically sharing the
# server's /dev/dri video devices with this app.
# It only has an effect when the app's _docker_gpu_enabled option is true
# and either gpu.intel or nvidia_enabled is true.
# NVIDIA-specific access may remain.
# Type: bool (true/false)
transmission_role_docker_dev_dri_disabled: false
# Set this to true to stop Saltbox from automatically sharing the
# server's /dev/dri video devices with this app.
# It only has an effect when the app's _docker_gpu_enabled option is true
# and either gpu.intel or nvidia_enabled is true.
# NVIDIA-specific access may remain.
# Type: bool (true/false)
transmission2_docker_dev_dri_disabled: false

Resource Limits

transmission_role_docker_blkio_weighttransmission2_docker_blkio_weight
# Type: int
transmission_role_docker_blkio_weight:
# Type: int
transmission2_docker_blkio_weight:
transmission_role_docker_cpu_periodtransmission2_docker_cpu_period
# Type: int
transmission_role_docker_cpu_period:
# Type: int
transmission2_docker_cpu_period:
transmission_role_docker_cpu_quotatransmission2_docker_cpu_quota
# Type: int
transmission_role_docker_cpu_quota:
# Type: int
transmission2_docker_cpu_quota:
transmission_role_docker_cpu_sharestransmission2_docker_cpu_shares
# Type: int
transmission_role_docker_cpu_shares:
# Type: int
transmission2_docker_cpu_shares:
transmission_role_docker_cpustransmission2_docker_cpus
# Type: string
transmission_role_docker_cpus:
# Type: string
transmission2_docker_cpus:
transmission_role_docker_cpuset_cpustransmission2_docker_cpuset_cpus
# Type: string
transmission_role_docker_cpuset_cpus:
# Type: string
transmission2_docker_cpuset_cpus:
transmission_role_docker_cpuset_memstransmission2_docker_cpuset_mems
# Type: string
transmission_role_docker_cpuset_mems:
# Type: string
transmission2_docker_cpuset_mems:
transmission_role_docker_kernel_memorytransmission2_docker_kernel_memory
# Type: string
transmission_role_docker_kernel_memory:
# Type: string
transmission2_docker_kernel_memory:
transmission_role_docker_memorytransmission2_docker_memory
# Type: string
transmission_role_docker_memory:
# Type: string
transmission2_docker_memory:
transmission_role_docker_memory_reservationtransmission2_docker_memory_reservation
# Type: string
transmission_role_docker_memory_reservation:
# Type: string
transmission2_docker_memory_reservation:
transmission_role_docker_memory_swaptransmission2_docker_memory_swap
# Type: string
transmission_role_docker_memory_swap:
# Type: string
transmission2_docker_memory_swap:
transmission_role_docker_memory_swappinesstransmission2_docker_memory_swappiness
# Type: int
transmission_role_docker_memory_swappiness:
# Type: int
transmission2_docker_memory_swappiness:
transmission_role_docker_shm_sizetransmission2_docker_shm_size
# Type: string
transmission_role_docker_shm_size:
# Type: string
transmission2_docker_shm_size:

Security & Devices

transmission_role_docker_cap_droptransmission2_docker_cap_drop
# Type: list
transmission_role_docker_cap_drop:
# Type: list
transmission2_docker_cap_drop:
transmission_role_docker_cgroupns_modetransmission2_docker_cgroupns_mode
# Type: string
transmission_role_docker_cgroupns_mode:
# Type: string
transmission2_docker_cgroupns_mode:
transmission_role_docker_device_cgroup_rulestransmission2_docker_device_cgroup_rules
# Type: list
transmission_role_docker_device_cgroup_rules:
# Type: list
transmission2_docker_device_cgroup_rules:
transmission_role_docker_device_read_bpstransmission2_docker_device_read_bps
# Type: list
transmission_role_docker_device_read_bps:
# Type: list
transmission2_docker_device_read_bps:
transmission_role_docker_device_read_iopstransmission2_docker_device_read_iops
# Type: list
transmission_role_docker_device_read_iops:
# Type: list
transmission2_docker_device_read_iops:
transmission_role_docker_device_requeststransmission2_docker_device_requests
# Type: list
transmission_role_docker_device_requests:
# Type: list
transmission2_docker_device_requests:
transmission_role_docker_device_write_bpstransmission2_docker_device_write_bps
# Type: list
transmission_role_docker_device_write_bps:
# Type: list
transmission2_docker_device_write_bps:
transmission_role_docker_device_write_iopstransmission2_docker_device_write_iops
# Type: list
transmission_role_docker_device_write_iops:
# Type: list
transmission2_docker_device_write_iops:
transmission_role_docker_devicestransmission2_docker_devices
# Type: list
transmission_role_docker_devices:
# Type: list
transmission2_docker_devices:
transmission_role_docker_groupstransmission2_docker_groups
# Type: list
transmission_role_docker_groups:
# Type: list
transmission2_docker_groups:
transmission_role_docker_privilegedtransmission2_docker_privileged
# Type: bool (true/false)
transmission_role_docker_privileged:
# Type: bool (true/false)
transmission2_docker_privileged:
transmission_role_docker_security_optstransmission2_docker_security_opts
# Type: list
transmission_role_docker_security_opts:
# Type: list
transmission2_docker_security_opts:
transmission_role_docker_usertransmission2_docker_user
# Type: string
transmission_role_docker_user:
# Type: string
transmission2_docker_user:
transmission_role_docker_userns_modetransmission2_docker_userns_mode
# Type: string
transmission_role_docker_userns_mode:
# Type: string
transmission2_docker_userns_mode:

Networking

transmission_role_docker_dns_optstransmission2_docker_dns_opts
# Type: list
transmission_role_docker_dns_opts:
# Type: list
transmission2_docker_dns_opts:
transmission_role_docker_dns_search_domainstransmission2_docker_dns_search_domains
# Type: list
transmission_role_docker_dns_search_domains:
# Type: list
transmission2_docker_dns_search_domains:
transmission_role_docker_dns_serverstransmission2_docker_dns_servers
# Type: list
transmission_role_docker_dns_servers:
# Type: list
transmission2_docker_dns_servers:
transmission_role_docker_domainnametransmission2_docker_domainname
# Type: string
transmission_role_docker_domainname:
# Type: string
transmission2_docker_domainname:
transmission_role_docker_exposed_portstransmission2_docker_exposed_ports
# Type: list
transmission_role_docker_exposed_ports:
# Type: list
transmission2_docker_exposed_ports:
transmission_role_docker_hoststransmission2_docker_hosts
# Type: dict
transmission_role_docker_hosts:
# Type: dict
transmission2_docker_hosts:
transmission_role_docker_hosts_use_commontransmission2_docker_hosts_use_common
# Type: bool (true/false)
transmission_role_docker_hosts_use_common:
# Type: bool (true/false)
transmission2_docker_hosts_use_common:
transmission_role_docker_ipc_modetransmission2_docker_ipc_mode
# Type: string
transmission_role_docker_ipc_mode:
# Type: string
transmission2_docker_ipc_mode:
transmission_role_docker_linkstransmission2_docker_links
# Type: list
transmission_role_docker_links:
# Type: list
transmission2_docker_links:
transmission_role_docker_network_modetransmission2_docker_network_mode
# Type: string
transmission_role_docker_network_mode:
# Type: string
transmission2_docker_network_mode:
transmission_role_docker_pid_modetransmission2_docker_pid_mode
# Type: string
transmission_role_docker_pid_mode:
# Type: string
transmission2_docker_pid_mode:
transmission_role_docker_utstransmission2_docker_uts
# Type: string
transmission_role_docker_uts:
# Type: string
transmission2_docker_uts:

Storage

transmission_role_docker_keep_volumestransmission2_docker_keep_volumes
# Type: bool (true/false)
transmission_role_docker_keep_volumes:
# Type: bool (true/false)
transmission2_docker_keep_volumes:
transmission_role_docker_mountstransmission2_docker_mounts
# Type: list
transmission_role_docker_mounts:
# Type: list
transmission2_docker_mounts:
transmission_role_docker_storage_optstransmission2_docker_storage_opts
# Type: dict
transmission_role_docker_storage_opts:
# Type: dict
transmission2_docker_storage_opts:
transmission_role_docker_tmpfstransmission2_docker_tmpfs
# Type: list
transmission_role_docker_tmpfs:
# Type: list
transmission2_docker_tmpfs:
transmission_role_docker_volume_drivertransmission2_docker_volume_driver
# Type: string
transmission_role_docker_volume_driver:
# Type: string
transmission2_docker_volume_driver:
transmission_role_docker_volumes_fromtransmission2_docker_volumes_from
# Type: list
transmission_role_docker_volumes_from:
# Type: list
transmission2_docker_volumes_from:
transmission_role_docker_volumes_globaltransmission2_docker_volumes_global
# Type: bool (true/false)
transmission_role_docker_volumes_global:
# Type: bool (true/false)
transmission2_docker_volumes_global:
transmission_role_docker_working_dirtransmission2_docker_working_dir
# Type: string
transmission_role_docker_working_dir:
# Type: string
transmission2_docker_working_dir:

Monitoring & Lifecycle

transmission_role_docker_auto_removetransmission2_docker_auto_remove
# Type: bool (true/false)
transmission_role_docker_auto_remove:
# Type: bool (true/false)
transmission2_docker_auto_remove:
transmission_role_docker_cleanuptransmission2_docker_cleanup
# Type: bool (true/false)
transmission_role_docker_cleanup:
# Type: bool (true/false)
transmission2_docker_cleanup:
transmission_role_docker_force_killtransmission2_docker_force_kill
# Type: string
transmission_role_docker_force_kill:
# Type: string
transmission2_docker_force_kill:
transmission_role_docker_healthchecktransmission2_docker_healthcheck
# Type: dict
transmission_role_docker_healthcheck:
# Type: dict
transmission2_docker_healthcheck:
transmission_role_docker_healthy_wait_timeouttransmission2_docker_healthy_wait_timeout
# Type: int
transmission_role_docker_healthy_wait_timeout:
# Type: int
transmission2_docker_healthy_wait_timeout:
transmission_role_docker_inittransmission2_docker_init
# Type: bool (true/false)
transmission_role_docker_init:
# Type: bool (true/false)
transmission2_docker_init:
transmission_role_docker_kill_signaltransmission2_docker_kill_signal
# Type: string
transmission_role_docker_kill_signal:
# Type: string
transmission2_docker_kill_signal:
transmission_role_docker_log_drivertransmission2_docker_log_driver
# Type: string
transmission_role_docker_log_driver:
# Type: string
transmission2_docker_log_driver:
transmission_role_docker_log_optionstransmission2_docker_log_options
# Type: dict
transmission_role_docker_log_options:
# Type: dict
transmission2_docker_log_options:
transmission_role_docker_oom_killertransmission2_docker_oom_killer
# Type: bool (true/false)
transmission_role_docker_oom_killer:
# Type: bool (true/false)
transmission2_docker_oom_killer:
transmission_role_docker_oom_score_adjtransmission2_docker_oom_score_adj
# Type: int
transmission_role_docker_oom_score_adj:
# Type: int
transmission2_docker_oom_score_adj:
transmission_role_docker_output_logstransmission2_docker_output_logs
# Type: bool (true/false)
transmission_role_docker_output_logs:
# Type: bool (true/false)
transmission2_docker_output_logs:
transmission_role_docker_pausedtransmission2_docker_paused
# Type: bool (true/false)
transmission_role_docker_paused:
# Type: bool (true/false)
transmission2_docker_paused:
transmission_role_docker_recreatetransmission2_docker_recreate
# Type: bool (true/false)
transmission_role_docker_recreate:
# Type: bool (true/false)
transmission2_docker_recreate:
transmission_role_docker_restart_retriestransmission2_docker_restart_retries
# Type: int
transmission_role_docker_restart_retries:
# Type: int
transmission2_docker_restart_retries:
transmission_role_docker_stop_signaltransmission2_docker_stop_signal
# Type: string
transmission_role_docker_stop_signal:
# Type: string
transmission2_docker_stop_signal:

Other Options

transmission_role_docker_capabilitiestransmission2_docker_capabilities
# Type: list
transmission_role_docker_capabilities:
# Type: list
transmission2_docker_capabilities:
transmission_role_docker_cgroup_parenttransmission2_docker_cgroup_parent
# Type: string
transmission_role_docker_cgroup_parent:
# Type: string
transmission2_docker_cgroup_parent:
transmission_role_docker_commandstransmission2_docker_commands
# Type: list
transmission_role_docker_commands:
# Type: list
transmission2_docker_commands:
transmission_role_docker_create_timeouttransmission2_docker_create_timeout
# Type: int
transmission_role_docker_create_timeout:
# Type: int
transmission2_docker_create_timeout:
transmission_role_docker_entrypointtransmission2_docker_entrypoint
# Type: string
transmission_role_docker_entrypoint:
# Type: string
transmission2_docker_entrypoint:
transmission_role_docker_env_filetransmission2_docker_env_file
# Type: string
transmission_role_docker_env_file:
# Type: string
transmission2_docker_env_file:
transmission_role_docker_labelstransmission2_docker_labels
# Type: dict
transmission_role_docker_labels:
# Type: dict
transmission2_docker_labels:
transmission_role_docker_labels_use_commontransmission2_docker_labels_use_common
# Type: bool (true/false)
transmission_role_docker_labels_use_common:
# Type: bool (true/false)
transmission2_docker_labels_use_common:
transmission_role_docker_read_onlytransmission2_docker_read_only
# Type: bool (true/false)
transmission_role_docker_read_only:
# Type: bool (true/false)
transmission2_docker_read_only:
transmission_role_docker_runtimetransmission2_docker_runtime
# Type: string
transmission_role_docker_runtime:
# Type: string
transmission2_docker_runtime:
transmission_role_docker_sysctlstransmission2_docker_sysctls
# Type: list
transmission_role_docker_sysctls:
# Type: list
transmission2_docker_sysctls:
transmission_role_docker_ulimitstransmission2_docker_ulimits
# Type: list
transmission_role_docker_ulimits:
# Type: list
transmission2_docker_ulimits:
transmission_role_autoheal_enabledtransmission2_autoheal_enabled
# Enable or disable Autoheal monitoring for containers created when deploying
# Type: bool (true/false)
transmission_role_autoheal_enabled: true
# Enable or disable Autoheal monitoring for containers created when deploying
# Type: bool (true/false)
transmission2_autoheal_enabled: true
transmission_role_depends_ontransmission2_depends_on
# List of container dependencies that must be running before containers start
# Type: string
transmission_role_depends_on: ""
# List of container dependencies that must be running before containers start
# Type: string
transmission2_depends_on: ""
transmission_role_depends_on_delaytransmission2_depends_on_delay
# Delay in seconds before starting containers after dependencies are ready
# Type: string (quoted number)
transmission_role_depends_on_delay: "0"
# Delay in seconds before starting containers after dependencies are ready
# Type: string (quoted number)
transmission2_depends_on_delay: "0"
transmission_role_depends_on_healthcheckstransmission2_depends_on_healthchecks
# Enable healthcheck waiting for container dependencies
# Type: string ("true"/"false")
transmission_role_depends_on_healthchecks:
# Enable healthcheck waiting for container dependencies
# Type: string ("true"/"false")
transmission2_depends_on_healthchecks:
transmission_role_diun_enabledtransmission2_diun_enabled
# Enable or disable Diun update notifications for containers created when deploying
# Type: bool (true/false)
transmission_role_diun_enabled: true
# Enable or disable Diun update notifications for containers created when deploying
# Type: bool (true/false)
transmission2_diun_enabled: true
transmission_role_dns_enabledtransmission2_dns_enabled
# Enable or disable automatic DNS record creation for containers
# Type: bool (true/false)
transmission_role_dns_enabled: true
# Enable or disable automatic DNS record creation for containers
# Type: bool (true/false)
transmission2_dns_enabled: true
transmission_role_docker_controllertransmission2_docker_controller
# Enable or disable Saltbox Docker Controller management for containers
# Type: bool (true/false)
transmission_role_docker_controller: true
# Enable or disable Saltbox Docker Controller management for containers
# Type: bool (true/false)
transmission2_docker_controller: true
transmission_role_docker_networks_alias_customtransmission2_docker_networks_alias_custom
# Type: list
transmission_role_docker_networks_alias_custom:
# Type: list
transmission2_docker_networks_alias_custom:
transmission_role_docker_volumes_downloadtransmission2_docker_volumes_download
# Type: bool (true/false)
transmission_role_docker_volumes_download:
# Type: bool (true/false)
transmission2_docker_volumes_download:
transmission_role_themepark_addonstransmission2_themepark_addons
# Type: string
transmission_role_themepark_addons:
# Type: string
transmission2_themepark_addons:
transmission_role_themepark_apptransmission2_themepark_app
# Type: string
transmission_role_themepark_app:
# Type: string
transmission2_themepark_app:
transmission_role_themepark_themetransmission2_themepark_theme
# Type: string
transmission_role_themepark_theme:
# Type: string
transmission2_themepark_theme:
transmission_role_traefik_api_middleware_httptransmission2_traefik_api_middleware_http
# Type: string
transmission_role_traefik_api_middleware_http:
# Type: string
transmission2_traefik_api_middleware_http:
transmission_role_traefik_autodetect_enabledtransmission2_traefik_autodetect_enabled
# Enable Traefik autodetect middleware for containers
# Type: bool (true/false)
transmission_role_traefik_autodetect_enabled: false
# Enable Traefik autodetect middleware for containers
# Type: bool (true/false)
transmission2_traefik_autodetect_enabled: false
transmission_role_traefik_crowdsec_enabledtransmission2_traefik_crowdsec_enabled
# Enable CrowdSec middleware for containers
# Type: bool (true/false)
transmission_role_traefik_crowdsec_enabled: false
# Enable CrowdSec middleware for containers
# Type: bool (true/false)
transmission2_traefik_crowdsec_enabled: false
transmission_role_traefik_error_pages_enabledtransmission2_traefik_error_pages_enabled
# Enable custom error pages middleware for containers
# Type: bool (true/false)
transmission_role_traefik_error_pages_enabled: false
# Enable custom error pages middleware for containers
# Type: bool (true/false)
transmission2_traefik_error_pages_enabled: false
transmission_role_traefik_gzip_enabledtransmission2_traefik_gzip_enabled
# Enable gzip compression middleware for containers
# Type: bool (true/false)
transmission_role_traefik_gzip_enabled: false
# Enable gzip compression middleware for containers
# Type: bool (true/false)
transmission2_traefik_gzip_enabled: false
transmission_role_traefik_middleware_httptransmission2_traefik_middleware_http
# Type: string
transmission_role_traefik_middleware_http:
# Type: string
transmission2_traefik_middleware_http:
transmission_role_traefik_middleware_http_api_insecuretransmission2_traefik_middleware_http_api_insecure
# Type: bool (true/false)
transmission_role_traefik_middleware_http_api_insecure:
# Type: bool (true/false)
transmission2_traefik_middleware_http_api_insecure:
transmission_role_traefik_middleware_http_insecuretransmission2_traefik_middleware_http_insecure
# Type: bool (true/false)
transmission_role_traefik_middleware_http_insecure:
# Type: bool (true/false)
transmission2_traefik_middleware_http_insecure:
transmission_role_traefik_prioritytransmission2_traefik_priority
# Type: string
transmission_role_traefik_priority:
# Type: string
transmission2_traefik_priority:
transmission_role_traefik_robot_enabledtransmission2_traefik_robot_enabled
# Enable robots.txt middleware for containers
# Type: bool (true/false)
transmission_role_traefik_robot_enabled: true
# Enable robots.txt middleware for containers
# Type: bool (true/false)
transmission2_traefik_robot_enabled: true
transmission_role_traefik_tailscale_enabledtransmission2_traefik_tailscale_enabled
# Enable Tailscale-specific Traefik configuration for containers
# Type: bool (true/false)
transmission_role_traefik_tailscale_enabled: false
# Enable Tailscale-specific Traefik configuration for containers
# Type: bool (true/false)
transmission2_traefik_tailscale_enabled: false
transmission_role_traefik_wildcard_enabledtransmission2_traefik_wildcard_enabled
# Enable wildcard certificate for containers
# Type: bool (true/false)
transmission_role_traefik_wildcard_enabled: true
# Enable wildcard certificate for containers
# Type: bool (true/false)
transmission2_traefik_wildcard_enabled: true
transmission_role_web_api_http_porttransmission2_web_api_http_port
# Type: string (quoted number)
transmission_role_web_api_http_port:
# Type: string (quoted number)
transmission2_web_api_http_port:
transmission_role_web_api_http_schemetransmission2_web_api_http_scheme
# Type: string ("http"/"https")
transmission_role_web_api_http_scheme:
# Type: string ("http"/"https")
transmission2_web_api_http_scheme:
transmission_role_web_api_http_serverstransporttransmission2_web_api_http_serverstransport
# Type: dict/omit
transmission_role_web_api_http_serverstransport:
# Type: dict/omit
transmission2_web_api_http_serverstransport:
transmission_role_web_api_porttransmission2_web_api_port
# Type: string (quoted number)
transmission_role_web_api_port:
# Type: string (quoted number)
transmission2_web_api_port:
transmission_role_web_api_schemetransmission2_web_api_scheme
# Type: string ("http"/"https")
transmission_role_web_api_scheme:
# Type: string ("http"/"https")
transmission2_web_api_scheme:
transmission_role_web_api_serverstransporttransmission2_web_api_serverstransport
# Type: dict/omit
transmission_role_web_api_serverstransport:
# Type: dict/omit
transmission2_web_api_serverstransport:
transmission_role_web_fqdn_overridetransmission2_web_fqdn_override
# Override the Traefik fully qualified domain name (FQDN) for containers
# Type: list
transmission_role_web_fqdn_override:
# Override the Traefik fully qualified domain name (FQDN) for containers
# Type: list
transmission2_web_fqdn_override:

Example Override

transmission_role_web_fqdn_override:
  - "{{ traefik_host }}"
  - "transmission2.{{ user.domain }}"
  - "transmission.otherdomain.tld"

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

Example Override

transmission2_web_fqdn_override:
  - "{{ traefik_host }}"
  - "transmission2.{{ user.domain }}"
  - "transmission.otherdomain.tld"

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

transmission_role_web_host_overridetransmission2_web_host_override
# Override the Traefik web host configuration for containers
# Type: string
transmission_role_web_host_override:
# Override the Traefik web host configuration for containers
# Type: string
transmission2_web_host_override:

Example Override

transmission_role_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'transmission2.' + user.domain }}`)"

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

Example Override

transmission2_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'transmission2.' + user.domain }}`)"

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

transmission_role_web_http_porttransmission2_web_http_port
# Type: string (quoted number)
transmission_role_web_http_port:
# Type: string (quoted number)
transmission2_web_http_port:
transmission_role_web_http_schemetransmission2_web_http_scheme
# Type: string ("http"/"https")
transmission_role_web_http_scheme:
# Type: string ("http"/"https")
transmission2_web_http_scheme:
transmission_role_web_http_serverstransporttransmission2_web_http_serverstransport
# Type: dict/omit
transmission_role_web_http_serverstransport:
# Type: dict/omit
transmission2_web_http_serverstransport:
transmission_role_web_schemetransmission2_web_scheme
# URL scheme to use for web access to containers
# Type: string ("http"/"https")
transmission_role_web_scheme:
# URL scheme to use for web access to containers
# Type: string ("http"/"https")
transmission2_web_scheme:
transmission_role_web_serverstransporttransmission2_web_serverstransport
# Type: dict/omit
transmission_role_web_serverstransport:
# Type: dict/omit
transmission2_web_serverstransport: