ruTorrent

Deployment

sb install rutorrent

Usage

Visit https://rutorrent.iYOUR_DOMAIN_NAMEi.

Unpacking

You will most likely want to run Unpackerr for this purpose. If so, it is recommended to disable ruTorrent's unpack plugin (along with other plugins you do not require) to save resources.

Role Defaults

Info

Variables can be overridden in /srv/git/saltbox/inventories/host_vars/localhost.yml.

Example Override

rutorrent_name: "custom_value"

Avoid overriding variables ending in _default

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

BasicsWebDNSTraefikConfigThemeDockerDocker+Global Override Options

rutorrent_name

# Type: string
rutorrent_name: rutorrent

rutorrent_role_web_subdomain

# Type: string
rutorrent_role_web_subdomain: "{{ rutorrent_name }}"

rutorrent_role_web_domain

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

rutorrent_role_web_port

# Type: string
rutorrent_role_web_port: "80"

rutorrent_role_web_url

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

rutorrent_role_dns_record

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

rutorrent_role_dns_zone

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

rutorrent_role_dns_proxy

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

rutorrent_role_traefik_sso_middleware

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

rutorrent_role_traefik_middleware_default

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

rutorrent_role_traefik_middleware_custom

# Type: string
rutorrent_role_traefik_middleware_custom: ""

rutorrent_role_traefik_certresolver

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

rutorrent_role_traefik_enabled

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

rutorrent_role_traefik_api_enabled

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

rutorrent_role_traefik_api_middleware

# Type: string
rutorrent_role_traefik_api_middleware: "rutorrent-auth,{{ traefik_default_middleware_api }}"

rutorrent_role_traefik_api_endpoint

# Type: string
rutorrent_role_traefik_api_endpoint: "PathPrefix(`/RPC2`)"

rutorrent_role_config_public_trackers

# Toggles if public tracker functionality is enabled
# Type: bool (true/false)
rutorrent_role_config_public_trackers: false

rutorrent_role_config_diskspace_path

# Path used by the diskspace plugin to check usage
# Type: string
rutorrent_role_config_diskspace_path: "/mnt"

rutorrent_role_config_new_installs_rutorrent_rc_settings_default

# # New Installs
# rtorrent.rc
# Type: string
rutorrent_role_config_new_installs_rutorrent_rc_settings_default:
  # Minimum number of peers to connect to per torrent
  - { option: "throttle.min_peers.normal.set", value: "1" }
  # Maximum number of simultaneous upload slots per torrent
  - { option: "throttle.max_uploads.set", value: "1024" }
  # Maximum number of simultaneous download slots, globally
  - { option: "throttle.max_downloads.global.set", value: "1024" }
  # Maximum number of simultaneous upload slots, globally
  - { option: "throttle.max_uploads.global.set", value: "1024" }
  # Maximum download rate, globally (KiB); 0 = unlimited
  - { option: "throttle.global_down.max_rate.set_kb", value: "0" }
  # Maximum upload rate, globally (KiB); 0 = unlimited
  - { option: "throttle.global_up.max_rate.set_kb", value: "0" }
  # Maximum number of open files
  - { option: "network.max_open_files.set", value: "1024" }
  # Maximum XMLRPC payloads
  - { option: "network.xmlrpc.size_limit.set", value: "20M" }
  # Encryption Parameters
  - { option: "protocol.encryption.set", value: "allow_incoming,try_outgoing,enable_retry,prefer_plaintext" }
  # Hash check on completion - disabled
  - { option: "pieces.hash.on_completion.set", value: "no" }
  # Disk space allocation - disabled
  - { option: "system.file.allocate.set", value: "0" }
  # Download Directory
  - { option: "directory.default.set", value: "/mnt/unionfs/downloads/torrents/rutorrent/completed" }
  # Watched Directory
  - { option: "schedule", value: 'watch_directory,5,5,"load.start=/mnt/unionfs/downloads/torrents/rutorrent/watched/*.torrent,d.delete_tied="' }

rutorrent_role_config_new_installs_rutorrent_rc_settings_custom

# Type: list
rutorrent_role_config_new_installs_rutorrent_rc_settings_custom: []

rutorrent_role_config_new_installs_rutorrent_rc_settings_list

# Type: string
rutorrent_role_config_new_installs_rutorrent_rc_settings_list: "{{ lookup('role_var', '_config_new_installs_rutorrent_rc_settings_default', role='rutorrent')
                                                                   + lookup('role_var', '_config_new_installs_rutorrent_rc_settings_custom', role='rutorrent') }}"

rutorrent_role_config_new_installs_php_local_ini_settings_default

# php-local.ini
# Type: string
rutorrent_role_config_new_installs_php_local_ini_settings_default:
  # Maximum Upload File Size via Web Browser (eg Uploading Torrent Files)
  - { option: "upload_max_filesize", value: "20M" }

rutorrent_role_config_new_installs_php_local_ini_settings_custom

# Type: list
rutorrent_role_config_new_installs_php_local_ini_settings_custom: []

rutorrent_role_config_new_installs_php_local_ini_settings_list

# Type: string
rutorrent_role_config_new_installs_php_local_ini_settings_list: "{{ lookup('role_var', '_config_new_installs_php_local_ini_settings_default', role='rutorrent')
                                                                    + lookup('role_var', '_config_new_installs_php_local_ini_settings_custom', role='rutorrent') }}"

rutorrent_role_config_existing_installs_rutorrent_rc_settings_default

# # Existing Installs
# rtorrent.rc
# Type: string
rutorrent_role_config_existing_installs_rutorrent_rc_settings_default:
  # Execute - Initiate Plugins
  - { option: "execute", value: "{sh,-c,/usr/bin/php /app/rutorrent/php/initplugins.php abc &}" }
  # IP address that is reported to the tracker
  - { option: "network.local_address.set", value: "{{ ip_address_public }}" }
  # Ports
  - { option: "network.port_range.set", value: "{{ rutorrent_role_docker_ports_51413 }}-{{ rutorrent_role_docker_ports_51413 }}" }
  - { option: "dht.port.set", value: "{{ rutorrent_role_docker_ports_6881 }}" }
  # Enable / Disable Public Trackers
  - { option: "dht.mode.set", value: "{{ lookup('role_var', '_config_public_trackers', role='rutorrent') | ternary('on', 'disable') }}" }
  - { option: "trackers.use_udp.set", value: "{{ lookup('role_var', '_config_public_trackers', role='rutorrent') | ternary('yes', 'no') }}" }
  - { option: "protocol.pex.set", value: "{{ lookup('role_var', '_config_public_trackers', role='rutorrent') | ternary('yes', 'no') }}" }

rutorrent_role_config_existing_installs_rutorrent_rc_settings_custom

# Type: list
rutorrent_role_config_existing_installs_rutorrent_rc_settings_custom: []

rutorrent_role_config_existing_installs_rutorrent_rc_settings_list

# Type: string
rutorrent_role_config_existing_installs_rutorrent_rc_settings_list: "{{ lookup('role_var', '_config_existing_installs_rutorrent_rc_settings_default', role='rutorrent')
                                                                        + lookup('role_var', '_config_existing_installs_rutorrent_rc_settings_custom', role='rutorrent') }}"

rutorrent_role_themepark_enabled

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

rutorrent_role_themepark_app

# Type: string
rutorrent_role_themepark_app: "rutorrent"

rutorrent_role_themepark_theme

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

rutorrent_role_themepark_domain

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

rutorrent_role_themepark_addons

# Type: list
rutorrent_role_themepark_addons: []

Container

rutorrent_role_docker_container

# Type: string
rutorrent_role_docker_container: "{{ rutorrent_name }}"

Image

rutorrent_role_docker_image_pull

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

rutorrent_role_docker_image_tag

# Type: string
rutorrent_role_docker_image_tag: "latest"

rutorrent_role_docker_image_repo

# Type: string
rutorrent_role_docker_image_repo: "kudeta/ru-rtorrent"

rutorrent_role_docker_image

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

Ports

rutorrent_role_docker_ports_51413

# Type: string
rutorrent_role_docker_ports_51413: "{{ port_lookup_51413.meta.port
                                    if (port_lookup_51413.meta.port is defined) and (port_lookup_51413.meta.port | trim | length > 0)
                                    else '51413' }}"

rutorrent_role_docker_ports_6881

# Type: string
rutorrent_role_docker_ports_6881: "{{ port_lookup_6881.meta.port
                                   if (port_lookup_6881.meta.port is defined) and (port_lookup_6881.meta.port | trim | length > 0)
                                   else '6881' }}"

rutorrent_role_docker_ports_default

# Type: list
rutorrent_role_docker_ports_default:
  - "{{ lookup('role_var', '_docker_ports_51413', role='rutorrent') }}:{{ lookup('role_var', '_docker_ports_51413', role='rutorrent') }}"
  - "{{ lookup('role_var', '_docker_ports_51413', role='rutorrent') }}:{{ lookup('role_var', '_docker_ports_51413', role='rutorrent') }}/udp"
  - "{{ lookup('role_var', '_docker_ports_6881', role='rutorrent') }}:{{ lookup('role_var', '_docker_ports_6881', role='rutorrent') }}/udp"

rutorrent_role_docker_ports_custom

# Type: list
rutorrent_role_docker_ports_custom: []

Envs

rutorrent_role_docker_envs_default

# Type: dict
rutorrent_role_docker_envs_default:
  PUID: "{{ uid }}"
  PGID: "{{ gid }}"
  TZ: "{{ tz }}"

rutorrent_role_docker_envs_custom

# Type: dict
rutorrent_role_docker_envs_custom: {}

Volumes

rutorrent_role_docker_volumes_default

# Type: list
rutorrent_role_docker_volumes_default:
  - "{{ rutorrent_role_paths_location }}:/config"
  - "{{ server_appdata_path }}/scripts:/scripts"

rutorrent_role_docker_volumes_custom

# Type: list
rutorrent_role_docker_volumes_custom: []

Labels

rutorrent_role_docker_labels_default

# Type: dict
rutorrent_role_docker_labels_default:
  traefik.http.middlewares.rutorrent-auth.basicauth.usersfile: "/etc/traefik/auth"

rutorrent_role_docker_labels_custom

# Type: dict
rutorrent_role_docker_labels_custom: {}

Hostname

rutorrent_role_docker_hostname

# Type: string
rutorrent_role_docker_hostname: "{{ rutorrent_name }}"

Networks

rutorrent_role_docker_networks_alias

# Type: string
rutorrent_role_docker_networks_alias: "{{ rutorrent_name }}"

rutorrent_role_docker_networks_default

# Type: list
rutorrent_role_docker_networks_default: []

rutorrent_role_docker_networks_custom

# Type: list
rutorrent_role_docker_networks_custom: []

Restart Policy

rutorrent_role_docker_restart_policy

# Type: string
rutorrent_role_docker_restart_policy: unless-stopped

Stop Timeout

rutorrent_role_docker_stop_timeout

# Type: int
rutorrent_role_docker_stop_timeout: 900

State

rutorrent_role_docker_state

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

rutorrent_role_docker_blkio_weight

# Type: int
rutorrent_role_docker_blkio_weight:

rutorrent_role_docker_cpu_period

# Type: int
rutorrent_role_docker_cpu_period:

rutorrent_role_docker_cpu_quota

# Type: int
rutorrent_role_docker_cpu_quota:

rutorrent_role_docker_cpu_shares

# Type: int
rutorrent_role_docker_cpu_shares:

rutorrent_role_docker_cpus

# Type: string
rutorrent_role_docker_cpus:

rutorrent_role_docker_cpuset_cpus

# Type: string
rutorrent_role_docker_cpuset_cpus:

rutorrent_role_docker_cpuset_mems

# Type: string
rutorrent_role_docker_cpuset_mems:

rutorrent_role_docker_kernel_memory

# Type: string
rutorrent_role_docker_kernel_memory:

rutorrent_role_docker_memory

# Type: string
rutorrent_role_docker_memory:

rutorrent_role_docker_memory_reservation

# Type: string
rutorrent_role_docker_memory_reservation:

rutorrent_role_docker_memory_swap

# Type: string
rutorrent_role_docker_memory_swap:

rutorrent_role_docker_memory_swappiness

# Type: int
rutorrent_role_docker_memory_swappiness:

rutorrent_role_docker_shm_size

# Type: string
rutorrent_role_docker_shm_size:

Security & Devices

rutorrent_role_docker_cap_drop

# Type: list
rutorrent_role_docker_cap_drop:

rutorrent_role_docker_cgroupns_mode

# Type: string
rutorrent_role_docker_cgroupns_mode:

rutorrent_role_docker_device_cgroup_rules

# Type: list
rutorrent_role_docker_device_cgroup_rules:

rutorrent_role_docker_device_read_bps

# Type: list
rutorrent_role_docker_device_read_bps:

rutorrent_role_docker_device_read_iops

# Type: list
rutorrent_role_docker_device_read_iops:

rutorrent_role_docker_device_requests

# Type: list
rutorrent_role_docker_device_requests:

rutorrent_role_docker_device_write_bps

# Type: list
rutorrent_role_docker_device_write_bps:

rutorrent_role_docker_device_write_iops

# Type: list
rutorrent_role_docker_device_write_iops:

rutorrent_role_docker_devices

# Type: list
rutorrent_role_docker_devices:

rutorrent_role_docker_devices_default

# Type: string
rutorrent_role_docker_devices_default:

rutorrent_role_docker_groups

# Type: list
rutorrent_role_docker_groups:

rutorrent_role_docker_privileged

# Type: bool (true/false)
rutorrent_role_docker_privileged:

rutorrent_role_docker_security_opts

# Type: list
rutorrent_role_docker_security_opts:

rutorrent_role_docker_user

# Type: string
rutorrent_role_docker_user:

rutorrent_role_docker_userns_mode

# Type: string
rutorrent_role_docker_userns_mode:

Networking

rutorrent_role_docker_dns_opts

# Type: list
rutorrent_role_docker_dns_opts:

rutorrent_role_docker_dns_search_domains

# Type: list
rutorrent_role_docker_dns_search_domains:

rutorrent_role_docker_dns_servers

# Type: list
rutorrent_role_docker_dns_servers:

rutorrent_role_docker_domainname

# Type: string
rutorrent_role_docker_domainname:

rutorrent_role_docker_exposed_ports

# Type: list
rutorrent_role_docker_exposed_ports:

rutorrent_role_docker_hosts

# Type: dict
rutorrent_role_docker_hosts:

rutorrent_role_docker_hosts_use_common

# Type: bool (true/false)
rutorrent_role_docker_hosts_use_common:

rutorrent_role_docker_ipc_mode

# Type: string
rutorrent_role_docker_ipc_mode:

rutorrent_role_docker_links

# Type: list
rutorrent_role_docker_links:

rutorrent_role_docker_network_mode

# Type: string
rutorrent_role_docker_network_mode:

rutorrent_role_docker_pid_mode

# Type: string
rutorrent_role_docker_pid_mode:

rutorrent_role_docker_uts

# Type: string
rutorrent_role_docker_uts:

Storage

rutorrent_role_docker_keep_volumes

# Type: bool (true/false)
rutorrent_role_docker_keep_volumes:

rutorrent_role_docker_mounts

# Type: list
rutorrent_role_docker_mounts:

rutorrent_role_docker_storage_opts

# Type: dict
rutorrent_role_docker_storage_opts:

rutorrent_role_docker_tmpfs

# Type: list
rutorrent_role_docker_tmpfs:

rutorrent_role_docker_volume_driver

# Type: string
rutorrent_role_docker_volume_driver:

rutorrent_role_docker_volumes_from

# Type: list
rutorrent_role_docker_volumes_from:

rutorrent_role_docker_volumes_global

# Type: bool (true/false)
rutorrent_role_docker_volumes_global:

rutorrent_role_docker_working_dir

# Type: string
rutorrent_role_docker_working_dir:

Monitoring & Lifecycle

rutorrent_role_docker_auto_remove

# Type: bool (true/false)
rutorrent_role_docker_auto_remove:

rutorrent_role_docker_cleanup

# Type: bool (true/false)
rutorrent_role_docker_cleanup:

rutorrent_role_docker_force_kill

# Type: string
rutorrent_role_docker_force_kill:

rutorrent_role_docker_healthcheck

# Type: dict
rutorrent_role_docker_healthcheck:

rutorrent_role_docker_healthy_wait_timeout

# Type: int
rutorrent_role_docker_healthy_wait_timeout:

rutorrent_role_docker_init

# Type: bool (true/false)
rutorrent_role_docker_init:

rutorrent_role_docker_kill_signal

# Type: string
rutorrent_role_docker_kill_signal:

rutorrent_role_docker_log_driver

# Type: string
rutorrent_role_docker_log_driver:

rutorrent_role_docker_log_options

# Type: dict
rutorrent_role_docker_log_options:

rutorrent_role_docker_oom_killer

# Type: bool (true/false)
rutorrent_role_docker_oom_killer:

rutorrent_role_docker_oom_score_adj

# Type: int
rutorrent_role_docker_oom_score_adj:

rutorrent_role_docker_output_logs

# Type: bool (true/false)
rutorrent_role_docker_output_logs:

rutorrent_role_docker_paused

# Type: bool (true/false)
rutorrent_role_docker_paused:

rutorrent_role_docker_recreate

# Type: bool (true/false)
rutorrent_role_docker_recreate:

rutorrent_role_docker_restart_retries

# Type: int
rutorrent_role_docker_restart_retries:

Other Options

rutorrent_role_docker_capabilities

# Type: list
rutorrent_role_docker_capabilities:

rutorrent_role_docker_cgroup_parent

# Type: string
rutorrent_role_docker_cgroup_parent:

rutorrent_role_docker_commands

# Type: list
rutorrent_role_docker_commands:

rutorrent_role_docker_create_timeout

# Type: int
rutorrent_role_docker_create_timeout:

rutorrent_role_docker_entrypoint

# Type: string
rutorrent_role_docker_entrypoint:

rutorrent_role_docker_env_file

# Type: string
rutorrent_role_docker_env_file:

rutorrent_role_docker_labels_use_common

# Type: bool (true/false)
rutorrent_role_docker_labels_use_common:

rutorrent_role_docker_read_only

# Type: bool (true/false)
rutorrent_role_docker_read_only:

rutorrent_role_docker_runtime

# Type: string
rutorrent_role_docker_runtime:

rutorrent_role_docker_sysctls

# Type: list
rutorrent_role_docker_sysctls:

rutorrent_role_docker_ulimits

# Type: list
rutorrent_role_docker_ulimits:

rutorrent_role_autoheal_enabled

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

rutorrent_role_config_existing_installs_rutorrent_rc_settings_custom

# Type: string
rutorrent_role_config_existing_installs_rutorrent_rc_settings_custom:

rutorrent_role_config_existing_installs_rutorrent_rc_settings_default

# Type: string
rutorrent_role_config_existing_installs_rutorrent_rc_settings_default:

rutorrent_role_config_new_installs_php_local_ini_settings_custom

# Type: string
rutorrent_role_config_new_installs_php_local_ini_settings_custom:

rutorrent_role_config_new_installs_php_local_ini_settings_default

# Type: string
rutorrent_role_config_new_installs_php_local_ini_settings_default:

rutorrent_role_config_new_installs_rutorrent_rc_settings_custom

# Type: string
rutorrent_role_config_new_installs_rutorrent_rc_settings_custom:

rutorrent_role_config_new_installs_rutorrent_rc_settings_default

# Type: string
rutorrent_role_config_new_installs_rutorrent_rc_settings_default:

rutorrent_role_config_public_trackers

# Type: string
rutorrent_role_config_public_trackers:

rutorrent_role_depends_on

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

rutorrent_role_depends_on_delay

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

rutorrent_role_depends_on_healthchecks

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

rutorrent_role_diun_enabled

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

rutorrent_role_dns_enabled

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

rutorrent_role_docker_controller

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

rutorrent_role_docker_image_repo

# Type: string
rutorrent_role_docker_image_repo:

rutorrent_role_docker_image_tag

# Type: string
rutorrent_role_docker_image_tag:

rutorrent_role_docker_ports_51413

# Type: string (quoted number)
rutorrent_role_docker_ports_51413:

rutorrent_role_docker_ports_6881

# Type: string (quoted number)
rutorrent_role_docker_ports_6881:

rutorrent_role_docker_volumes_download

# Type: bool (true/false)
rutorrent_role_docker_volumes_download:

rutorrent_role_themepark_addons

# Type: string
rutorrent_role_themepark_addons:

rutorrent_role_themepark_app

# Type: string
rutorrent_role_themepark_app:

rutorrent_role_themepark_enabled

# Type: bool (true/false)
rutorrent_role_themepark_enabled:

rutorrent_role_themepark_theme

# Type: string
rutorrent_role_themepark_theme:

rutorrent_role_traefik_api_endpoint

# Type: dict/omit
rutorrent_role_traefik_api_endpoint:

rutorrent_role_traefik_api_middleware

# Type: string
rutorrent_role_traefik_api_middleware:

rutorrent_role_traefik_api_middleware_http

# Type: string
rutorrent_role_traefik_api_middleware_http:

rutorrent_role_traefik_autodetect_enabled

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

rutorrent_role_traefik_certresolver

# Type: string
rutorrent_role_traefik_certresolver:

rutorrent_role_traefik_crowdsec_enabled

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

rutorrent_role_traefik_error_pages_enabled

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

rutorrent_role_traefik_gzip_enabled

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

rutorrent_role_traefik_middleware_http

# Type: string
rutorrent_role_traefik_middleware_http:

rutorrent_role_traefik_middleware_http_api_insecure

# Type: bool (true/false)
rutorrent_role_traefik_middleware_http_api_insecure:

rutorrent_role_traefik_middleware_http_insecure

# Type: bool (true/false)
rutorrent_role_traefik_middleware_http_insecure:

rutorrent_role_traefik_priority

# Type: string
rutorrent_role_traefik_priority:

rutorrent_role_traefik_robot_enabled

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

rutorrent_role_traefik_tailscale_enabled

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

rutorrent_role_traefik_wildcard_enabled

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

rutorrent_role_web_domain

# Type: string
rutorrent_role_web_domain:

rutorrent_role_web_fqdn_override

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

Example Override

rutorrent_role_web_fqdn_override:
  - "{{ traefik_host }}"
  - "rutorrent2.{{ user.domain }}"
  - "rutorrent.otherdomain.tld"

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

rutorrent_role_web_host_override

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

Example Override

rutorrent_role_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'rutorrent2.' + user.domain }}`)"

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

rutorrent_role_web_http_port

# Type: string (quoted number)
rutorrent_role_web_http_port:

rutorrent_role_web_http_scheme

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

rutorrent_role_web_http_serverstransport

# Type: dict/omit
rutorrent_role_web_http_serverstransport:

rutorrent_role_web_scheme

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

rutorrent_role_web_serverstransport

# Type: dict/omit
rutorrent_role_web_serverstransport:

rutorrent_role_web_subdomain

# Type: string
rutorrent_role_web_subdomain: