rflood

Description / name	Input element
Your domain name

Overview

rflood is a Docker image with rTorrent and the Flood UI, also optional WireGuard VPN support.

Manual

Releases

Community

---

Deployment

sb install sandbox-rflood

Usage

Visit https://rflood.iYOUR_DOMAIN_NAMEi.

Role Defaults

Variables can be customized using the Inventory. (1)

1. This role supports multiple instances via rflood_instances.

   Example override

   Role-scopedInstance-scoped

   rflood_role_web_subdomain: "custom"
   

   Applies to all instances of rflood

   rflood2_web_subdomain: "custom2"
   

   Applies to the instance named rflood2

   Avoid overriding variables ending in _default

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

BasicsWebDNSTraefikConfigPortsDockerDocker+Global Override Options

rflood_instances

# Type: list
rflood_instances: ["rflood"]

Example Override

# Type: list
rflood_instances: ["rflood", "rflood2"]

rflood_role_web_subdomainrflood2_web_subdomain

# Type: string
rflood_role_web_subdomain: "{{ rflood_name }}"

# Type: string
rflood2_web_subdomain: "{{ rflood_name }}"

rflood_role_web_domainrflood2_web_domain

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

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

rflood_role_web_portrflood2_web_port

# Type: string
rflood_role_web_port: "3000"

# Type: string
rflood2_web_port: "3000"

rflood_role_web_urlrflood2_web_url

# Type: string
rflood_role_web_url: "{{ lookup('role_web', role='rflood', scheme='https') }}"

# Type: string
rflood2_web_url: "{{ lookup('role_web', role='rflood', scheme='https') }}"

rflood_role_dns_recordrflood2_dns_record

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

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

rflood_role_dns_zonerflood2_dns_zone

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

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

rflood_role_dns_proxyrflood2_dns_proxy

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

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

rflood_role_traefik_sso_middlewarerflood2_traefik_sso_middleware

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

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

rflood_role_traefik_middleware_defaultrflood2_traefik_middleware_default

# Type: string
rflood_role_traefik_middleware_default: "{{ traefik_default_middleware }}"

# Type: string
rflood2_traefik_middleware_default: "{{ traefik_default_middleware }}"

rflood_role_traefik_middleware_customrflood2_traefik_middleware_custom

# Type: string
rflood_role_traefik_middleware_custom: ""

# Type: string
rflood2_traefik_middleware_custom: ""

rflood_role_traefik_middleware_default_apirflood2_traefik_middleware_default_api

# Type: string
rflood_role_traefik_middleware_default_api: "{{ traefik_default_middleware_api }}"

# Type: string
rflood2_traefik_middleware_default_api: "{{ traefik_default_middleware_api }}"

rflood_role_traefik_middleware_custom_apirflood2_traefik_middleware_custom_api

# Type: string
rflood_role_traefik_middleware_custom_api: ""

# Type: string
rflood2_traefik_middleware_custom_api: ""

rflood_role_traefik_certresolverrflood2_traefik_certresolver

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

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

rflood_role_traefik_enabledrflood2_traefik_enabled

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

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

rflood_role_traefik_api_enabledrflood2_traefik_api_enabled

# Disabled for security reasons, no authentication on API /!\
# Type: bool (true/false)
rflood_role_traefik_api_enabled: false

# Disabled for security reasons, no authentication on API /!\
# Type: bool (true/false)
rflood2_traefik_api_enabled: false

rflood_role_traefik_api_endpointrflood2_traefik_api_endpoint

# Type: string
rflood_role_traefik_api_endpoint: "PathPrefix(`/api`)"

# Type: string
rflood2_traefik_api_endpoint: "PathPrefix(`/api`)"

rflood_role_config_public_trackersrflood2_config_public_trackers

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

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

rflood_role_config_rflood_rc_settings_defaultrflood2_config_rflood_rc_settings_default

# rtorrent.rc
# Type: string
rflood_role_config_rflood_rc_settings_default:
  # IP address that is reported to the tracker
  - { option: "network.local_address.set", value: "{{ ip_address_public }}" }
  # Ports
  - { option: "network.port_range.set", value: "{{ rflood_port_assignment.ports.peer }}-{{ rflood_port_assignment.ports.peer }}" }
  - { option: "dht.port.set", value: "{{ rflood_port_assignment.ports.dht }}" }
  # Enable / Disable Public Trackers
  - { option: "dht.mode.set", value: "{{ lookup('role_var', '_config_public_trackers', role='rflood') | ternary('on', 'disable') }}" }
  - { option: "trackers.use_udp.set", value: "{{ lookup('role_var', '_config_public_trackers', role='rflood') | ternary('yes', 'no') }}" }
  - { option: "protocol.pex.set", value: "{{ lookup('role_var', '_config_public_trackers', role='rflood') | ternary('yes', 'no') }}" }
  # Maximum XMLRPC payloads
  - { option: "network.xmlrpc.size_limit.set", value: "20M" }

# rtorrent.rc
# Type: string
rflood2_config_rflood_rc_settings_default:
  # IP address that is reported to the tracker
  - { option: "network.local_address.set", value: "{{ ip_address_public }}" }
  # Ports
  - { option: "network.port_range.set", value: "{{ rflood_port_assignment.ports.peer }}-{{ rflood_port_assignment.ports.peer }}" }
  - { option: "dht.port.set", value: "{{ rflood_port_assignment.ports.dht }}" }
  # Enable / Disable Public Trackers
  - { option: "dht.mode.set", value: "{{ lookup('role_var', '_config_public_trackers', role='rflood') | ternary('on', 'disable') }}" }
  - { option: "trackers.use_udp.set", value: "{{ lookup('role_var', '_config_public_trackers', role='rflood') | ternary('yes', 'no') }}" }
  - { option: "protocol.pex.set", value: "{{ lookup('role_var', '_config_public_trackers', role='rflood') | ternary('yes', 'no') }}" }
  # Maximum XMLRPC payloads
  - { option: "network.xmlrpc.size_limit.set", value: "20M" }

rflood_role_config_rflood_rc_settings_customrflood2_config_rflood_rc_settings_custom

# Type: list
rflood_role_config_rflood_rc_settings_custom: []

# Type: list
rflood2_config_rflood_rc_settings_custom: []

rflood_role_config_rflood_rc_settings_listrflood2_config_rflood_rc_settings_list

# Type: string
rflood_role_config_rflood_rc_settings_list: "{{ lookup('role_var', '_config_rflood_rc_settings_default', role='rflood')
                                                + lookup('role_var', '_config_rflood_rc_settings_custom', role='rflood') }}"

# Type: string
rflood2_config_rflood_rc_settings_list: "{{ lookup('role_var', '_config_rflood_rc_settings_default', role='rflood')
                                            + lookup('role_var', '_config_rflood_rc_settings_custom', role='rflood') }}"

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.

rflood_role_port_peer_low_boundrflood2_port_peer_low_bound

# Type: int
rflood_role_port_peer_low_bound: 50000

# Type: int
rflood2_port_peer_low_bound: 50000

rflood_role_port_peer_high_boundrflood2_port_peer_high_bound

# Type: int
rflood_role_port_peer_high_bound: 50010

# Type: int
rflood2_port_peer_high_bound: 50010

rflood_role_port_dht_low_boundrflood2_port_dht_low_bound

# Type: int
rflood_role_port_dht_low_bound: 6881

# Type: int
rflood2_port_dht_low_bound: 6881

rflood_role_port_dht_high_boundrflood2_port_dht_high_bound

# Type: int
rflood_role_port_dht_high_bound: 6891

# Type: int
rflood2_port_dht_high_bound: 6891

Container

rflood_role_docker_containerrflood2_docker_container

# Type: string
rflood_role_docker_container: "{{ rflood_name }}"

# Type: string
rflood2_docker_container: "{{ rflood_name }}"

Image

rflood_role_docker_image_pullrflood2_docker_image_pull

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

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

rflood_role_docker_image_reporflood2_docker_image_repo

# Type: string
rflood_role_docker_image_repo: "ghcr.io/hotio/rflood"

# Type: string
rflood2_docker_image_repo: "ghcr.io/hotio/rflood"

rflood_role_docker_image_tagrflood2_docker_image_tag

# Type: string
rflood_role_docker_image_tag: "release"

# Type: string
rflood2_docker_image_tag: "release"

rflood_role_docker_imagerflood2_docker_image

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

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

Ports

rflood_role_docker_ports_defaultrflood2_docker_ports_default

# Type: list
rflood_role_docker_ports_default:
  - "{{ rflood_port_assignment.ports.peer }}:{{ rflood_port_assignment.ports.peer }}"
  - "{{ rflood_port_assignment.ports.dht }}:{{ rflood_port_assignment.ports.dht }}/udp"

# Type: list
rflood2_docker_ports_default:
  - "{{ rflood_port_assignment.ports.peer }}:{{ rflood_port_assignment.ports.peer }}"
  - "{{ rflood_port_assignment.ports.dht }}:{{ rflood_port_assignment.ports.dht }}/udp"

rflood_role_docker_ports_customrflood2_docker_ports_custom

# Type: list
rflood_role_docker_ports_custom: []

# Type: list
rflood2_docker_ports_custom: []

Envs

rflood_role_docker_envs_defaultrflood2_docker_envs_default

# Type: dict
rflood_role_docker_envs_default:
  PUID: "{{ uid }}"
  PGID: "{{ gid }}"
  TZ: "{{ tz }}"
  UMASK: "002"
  FLOOD_AUTH: "false"

# Type: dict
rflood2_docker_envs_default:
  PUID: "{{ uid }}"
  PGID: "{{ gid }}"
  TZ: "{{ tz }}"
  UMASK: "002"
  FLOOD_AUTH: "false"

rflood_role_docker_envs_customrflood2_docker_envs_custom

# Type: dict
rflood_role_docker_envs_custom: {}

# Type: dict
rflood2_docker_envs_custom: {}

Volumes

rflood_role_docker_volumes_defaultrflood2_docker_volumes_default

# Type: list
rflood_role_docker_volumes_default:
  - "{{ lookup('role_var', '_paths_location', role='rflood') }}:/config"
  - "{{ server_appdata_path }}/scripts:/scripts"

# Type: list
rflood2_docker_volumes_default:
  - "{{ lookup('role_var', '_paths_location', role='rflood') }}:/config"
  - "{{ server_appdata_path }}/scripts:/scripts"

rflood_role_docker_volumes_customrflood2_docker_volumes_custom

# Type: list
rflood_role_docker_volumes_custom: []

# Type: list
rflood2_docker_volumes_custom: []

Hostname

rflood_role_docker_hostnamerflood2_docker_hostname

# Type: string
rflood_role_docker_hostname: "{{ rflood_name }}"

# Type: string
rflood2_docker_hostname: "{{ rflood_name }}"

Networks

rflood_role_docker_networks_aliasrflood2_docker_networks_alias

# Type: string
rflood_role_docker_networks_alias: "{{ rflood_name }}"

# Type: string
rflood2_docker_networks_alias: "{{ rflood_name }}"

rflood_role_docker_networks_defaultrflood2_docker_networks_default

# Type: list
rflood_role_docker_networks_default: []

# Type: list
rflood2_docker_networks_default: []

rflood_role_docker_networks_customrflood2_docker_networks_custom

# Type: list
rflood_role_docker_networks_custom: []

# Type: list
rflood2_docker_networks_custom: []

Restart Policy

rflood_role_docker_restart_policyrflood2_docker_restart_policy

# Type: string
rflood_role_docker_restart_policy: unless-stopped

# Type: string
rflood2_docker_restart_policy: unless-stopped

Stop Timeout

rflood_role_docker_stop_timeoutrflood2_docker_stop_timeout

# Type: int
rflood_role_docker_stop_timeout: 900

# Type: int
rflood2_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

rflood_role_docker_gpu_enabledrflood2_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)
rflood_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)
rflood2_docker_gpu_enabled: false

rflood_role_docker_nvidia_disabledrflood2_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)
rflood_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)
rflood2_docker_nvidia_disabled: false

rflood_role_docker_dev_dri_disabledrflood2_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)
rflood_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)
rflood2_docker_dev_dri_disabled: false

Resource Limits

rflood_role_docker_blkio_weightrflood2_docker_blkio_weight

# Type: int
rflood_role_docker_blkio_weight:

# Type: int
rflood2_docker_blkio_weight:

rflood_role_docker_cpu_periodrflood2_docker_cpu_period

# Type: int
rflood_role_docker_cpu_period:

# Type: int
rflood2_docker_cpu_period:

rflood_role_docker_cpu_quotarflood2_docker_cpu_quota

# Type: int
rflood_role_docker_cpu_quota:

# Type: int
rflood2_docker_cpu_quota:

rflood_role_docker_cpu_sharesrflood2_docker_cpu_shares

# Type: int
rflood_role_docker_cpu_shares:

# Type: int
rflood2_docker_cpu_shares:

rflood_role_docker_cpusrflood2_docker_cpus

# Type: string
rflood_role_docker_cpus:

# Type: string
rflood2_docker_cpus:

rflood_role_docker_cpuset_cpusrflood2_docker_cpuset_cpus

# Type: string
rflood_role_docker_cpuset_cpus:

# Type: string
rflood2_docker_cpuset_cpus:

rflood_role_docker_cpuset_memsrflood2_docker_cpuset_mems

# Type: string
rflood_role_docker_cpuset_mems:

# Type: string
rflood2_docker_cpuset_mems:

rflood_role_docker_kernel_memoryrflood2_docker_kernel_memory

# Type: string
rflood_role_docker_kernel_memory:

# Type: string
rflood2_docker_kernel_memory:

rflood_role_docker_memoryrflood2_docker_memory

# Type: string
rflood_role_docker_memory:

# Type: string
rflood2_docker_memory:

rflood_role_docker_memory_reservationrflood2_docker_memory_reservation

# Type: string
rflood_role_docker_memory_reservation:

# Type: string
rflood2_docker_memory_reservation:

rflood_role_docker_memory_swaprflood2_docker_memory_swap

# Type: string
rflood_role_docker_memory_swap:

# Type: string
rflood2_docker_memory_swap:

rflood_role_docker_memory_swappinessrflood2_docker_memory_swappiness

# Type: int
rflood_role_docker_memory_swappiness:

# Type: int
rflood2_docker_memory_swappiness:

rflood_role_docker_shm_sizerflood2_docker_shm_size

# Type: string
rflood_role_docker_shm_size:

# Type: string
rflood2_docker_shm_size:

Security & Devices

rflood_role_docker_cap_droprflood2_docker_cap_drop

# Type: list
rflood_role_docker_cap_drop:

# Type: list
rflood2_docker_cap_drop:

rflood_role_docker_cgroupns_moderflood2_docker_cgroupns_mode

# Type: string
rflood_role_docker_cgroupns_mode:

# Type: string
rflood2_docker_cgroupns_mode:

rflood_role_docker_device_cgroup_rulesrflood2_docker_device_cgroup_rules

# Type: list
rflood_role_docker_device_cgroup_rules:

# Type: list
rflood2_docker_device_cgroup_rules:

rflood_role_docker_device_read_bpsrflood2_docker_device_read_bps

# Type: list
rflood_role_docker_device_read_bps:

# Type: list
rflood2_docker_device_read_bps:

rflood_role_docker_device_read_iopsrflood2_docker_device_read_iops

# Type: list
rflood_role_docker_device_read_iops:

# Type: list
rflood2_docker_device_read_iops:

rflood_role_docker_device_requestsrflood2_docker_device_requests

# Type: list
rflood_role_docker_device_requests:

# Type: list
rflood2_docker_device_requests:

rflood_role_docker_device_write_bpsrflood2_docker_device_write_bps

# Type: list
rflood_role_docker_device_write_bps:

# Type: list
rflood2_docker_device_write_bps:

rflood_role_docker_device_write_iopsrflood2_docker_device_write_iops

# Type: list
rflood_role_docker_device_write_iops:

# Type: list
rflood2_docker_device_write_iops:

rflood_role_docker_devicesrflood2_docker_devices

# Type: list
rflood_role_docker_devices:

# Type: list
rflood2_docker_devices:

rflood_role_docker_groupsrflood2_docker_groups

# Type: list
rflood_role_docker_groups:

# Type: list
rflood2_docker_groups:

rflood_role_docker_privilegedrflood2_docker_privileged

# Type: bool (true/false)
rflood_role_docker_privileged:

# Type: bool (true/false)
rflood2_docker_privileged:

rflood_role_docker_security_optsrflood2_docker_security_opts

# Type: list
rflood_role_docker_security_opts:

# Type: list
rflood2_docker_security_opts:

rflood_role_docker_userrflood2_docker_user

# Type: string
rflood_role_docker_user:

# Type: string
rflood2_docker_user:

rflood_role_docker_userns_moderflood2_docker_userns_mode

# Type: string
rflood_role_docker_userns_mode:

# Type: string
rflood2_docker_userns_mode:

Networking

rflood_role_docker_dns_optsrflood2_docker_dns_opts

# Type: list
rflood_role_docker_dns_opts:

# Type: list
rflood2_docker_dns_opts:

rflood_role_docker_dns_search_domainsrflood2_docker_dns_search_domains

# Type: list
rflood_role_docker_dns_search_domains:

# Type: list
rflood2_docker_dns_search_domains:

rflood_role_docker_dns_serversrflood2_docker_dns_servers

# Type: list
rflood_role_docker_dns_servers:

# Type: list
rflood2_docker_dns_servers:

rflood_role_docker_domainnamerflood2_docker_domainname

# Type: string
rflood_role_docker_domainname:

# Type: string
rflood2_docker_domainname:

rflood_role_docker_exposed_portsrflood2_docker_exposed_ports

# Type: list
rflood_role_docker_exposed_ports:

# Type: list
rflood2_docker_exposed_ports:

rflood_role_docker_hostsrflood2_docker_hosts

# Type: dict
rflood_role_docker_hosts:

# Type: dict
rflood2_docker_hosts:

rflood_role_docker_hosts_use_commonrflood2_docker_hosts_use_common

# Type: bool (true/false)
rflood_role_docker_hosts_use_common:

# Type: bool (true/false)
rflood2_docker_hosts_use_common:

rflood_role_docker_ipc_moderflood2_docker_ipc_mode

# Type: string
rflood_role_docker_ipc_mode:

# Type: string
rflood2_docker_ipc_mode:

rflood_role_docker_linksrflood2_docker_links

# Type: list
rflood_role_docker_links:

# Type: list
rflood2_docker_links:

rflood_role_docker_network_moderflood2_docker_network_mode

# Type: string
rflood_role_docker_network_mode:

# Type: string
rflood2_docker_network_mode:

rflood_role_docker_pid_moderflood2_docker_pid_mode

# Type: string
rflood_role_docker_pid_mode:

# Type: string
rflood2_docker_pid_mode:

rflood_role_docker_utsrflood2_docker_uts

# Type: string
rflood_role_docker_uts:

# Type: string
rflood2_docker_uts:

Storage

rflood_role_docker_keep_volumesrflood2_docker_keep_volumes

# Type: bool (true/false)
rflood_role_docker_keep_volumes:

# Type: bool (true/false)
rflood2_docker_keep_volumes:

rflood_role_docker_mountsrflood2_docker_mounts

# Type: list
rflood_role_docker_mounts:

# Type: list
rflood2_docker_mounts:

rflood_role_docker_storage_optsrflood2_docker_storage_opts

# Type: dict
rflood_role_docker_storage_opts:

# Type: dict
rflood2_docker_storage_opts:

rflood_role_docker_tmpfsrflood2_docker_tmpfs

# Type: list
rflood_role_docker_tmpfs:

# Type: list
rflood2_docker_tmpfs:

rflood_role_docker_volume_driverrflood2_docker_volume_driver

# Type: string
rflood_role_docker_volume_driver:

# Type: string
rflood2_docker_volume_driver:

rflood_role_docker_volumes_fromrflood2_docker_volumes_from

# Type: list
rflood_role_docker_volumes_from:

# Type: list
rflood2_docker_volumes_from:

rflood_role_docker_volumes_globalrflood2_docker_volumes_global

# Type: bool (true/false)
rflood_role_docker_volumes_global:

# Type: bool (true/false)
rflood2_docker_volumes_global:

rflood_role_docker_working_dirrflood2_docker_working_dir

# Type: string
rflood_role_docker_working_dir:

# Type: string
rflood2_docker_working_dir:

Monitoring & Lifecycle

rflood_role_docker_auto_removerflood2_docker_auto_remove

# Type: bool (true/false)
rflood_role_docker_auto_remove:

# Type: bool (true/false)
rflood2_docker_auto_remove:

rflood_role_docker_cleanuprflood2_docker_cleanup

# Type: bool (true/false)
rflood_role_docker_cleanup:

# Type: bool (true/false)
rflood2_docker_cleanup:

rflood_role_docker_force_killrflood2_docker_force_kill

# Type: string
rflood_role_docker_force_kill:

# Type: string
rflood2_docker_force_kill:

rflood_role_docker_healthcheckrflood2_docker_healthcheck

# Type: dict
rflood_role_docker_healthcheck:

# Type: dict
rflood2_docker_healthcheck:

rflood_role_docker_healthy_wait_timeoutrflood2_docker_healthy_wait_timeout

# Type: int
rflood_role_docker_healthy_wait_timeout:

# Type: int
rflood2_docker_healthy_wait_timeout:

rflood_role_docker_initrflood2_docker_init

# Type: bool (true/false)
rflood_role_docker_init:

# Type: bool (true/false)
rflood2_docker_init:

rflood_role_docker_kill_signalrflood2_docker_kill_signal

# Type: string
rflood_role_docker_kill_signal:

# Type: string
rflood2_docker_kill_signal:

rflood_role_docker_log_driverrflood2_docker_log_driver

# Type: string
rflood_role_docker_log_driver:

# Type: string
rflood2_docker_log_driver:

rflood_role_docker_log_optionsrflood2_docker_log_options

# Type: dict
rflood_role_docker_log_options:

# Type: dict
rflood2_docker_log_options:

rflood_role_docker_oom_killerrflood2_docker_oom_killer

# Type: bool (true/false)
rflood_role_docker_oom_killer:

# Type: bool (true/false)
rflood2_docker_oom_killer:

rflood_role_docker_oom_score_adjrflood2_docker_oom_score_adj

# Type: int
rflood_role_docker_oom_score_adj:

# Type: int
rflood2_docker_oom_score_adj:

rflood_role_docker_output_logsrflood2_docker_output_logs

# Type: bool (true/false)
rflood_role_docker_output_logs:

# Type: bool (true/false)
rflood2_docker_output_logs:

rflood_role_docker_pausedrflood2_docker_paused

# Type: bool (true/false)
rflood_role_docker_paused:

# Type: bool (true/false)
rflood2_docker_paused:

rflood_role_docker_recreaterflood2_docker_recreate

# Type: bool (true/false)
rflood_role_docker_recreate:

# Type: bool (true/false)
rflood2_docker_recreate:

rflood_role_docker_restart_retriesrflood2_docker_restart_retries

# Type: int
rflood_role_docker_restart_retries:

# Type: int
rflood2_docker_restart_retries:

rflood_role_docker_stop_signalrflood2_docker_stop_signal

# Type: string
rflood_role_docker_stop_signal:

# Type: string
rflood2_docker_stop_signal:

Other Options

rflood_role_docker_capabilitiesrflood2_docker_capabilities

# Type: list
rflood_role_docker_capabilities:

# Type: list
rflood2_docker_capabilities:

rflood_role_docker_cgroup_parentrflood2_docker_cgroup_parent

# Type: string
rflood_role_docker_cgroup_parent:

# Type: string
rflood2_docker_cgroup_parent:

rflood_role_docker_commandsrflood2_docker_commands

# Type: list
rflood_role_docker_commands:

# Type: list
rflood2_docker_commands:

rflood_role_docker_create_timeoutrflood2_docker_create_timeout

# Type: int
rflood_role_docker_create_timeout:

# Type: int
rflood2_docker_create_timeout:

rflood_role_docker_entrypointrflood2_docker_entrypoint

# Type: string
rflood_role_docker_entrypoint:

# Type: string
rflood2_docker_entrypoint:

rflood_role_docker_env_filerflood2_docker_env_file

# Type: string
rflood_role_docker_env_file:

# Type: string
rflood2_docker_env_file:

rflood_role_docker_labelsrflood2_docker_labels

# Type: dict
rflood_role_docker_labels:

# Type: dict
rflood2_docker_labels:

rflood_role_docker_labels_use_commonrflood2_docker_labels_use_common

# Type: bool (true/false)
rflood_role_docker_labels_use_common:

# Type: bool (true/false)
rflood2_docker_labels_use_common:

rflood_role_docker_read_onlyrflood2_docker_read_only

# Type: bool (true/false)
rflood_role_docker_read_only:

# Type: bool (true/false)
rflood2_docker_read_only:

rflood_role_docker_runtimerflood2_docker_runtime

# Type: string
rflood_role_docker_runtime:

# Type: string
rflood2_docker_runtime:

rflood_role_docker_sysctlsrflood2_docker_sysctls

# Type: list
rflood_role_docker_sysctls:

# Type: list
rflood2_docker_sysctls:

rflood_role_docker_ulimitsrflood2_docker_ulimits

# Type: list
rflood_role_docker_ulimits:

# Type: list
rflood2_docker_ulimits:

rflood_role_autoheal_enabledrflood2_autoheal_enabled

# Enable or disable Autoheal monitoring for containers created when deploying
# Type: bool (true/false)
rflood_role_autoheal_enabled: true

# Enable or disable Autoheal monitoring for containers created when deploying
# Type: bool (true/false)
rflood2_autoheal_enabled: true

rflood_role_depends_onrflood2_depends_on

# List of container dependencies that must be running before containers start
# Type: string
rflood_role_depends_on: ""

# List of container dependencies that must be running before containers start
# Type: string
rflood2_depends_on: ""

rflood_role_depends_on_delayrflood2_depends_on_delay

# Delay in seconds before starting containers after dependencies are ready
# Type: string (quoted number)
rflood_role_depends_on_delay: "0"

# Delay in seconds before starting containers after dependencies are ready
# Type: string (quoted number)
rflood2_depends_on_delay: "0"

rflood_role_depends_on_healthchecksrflood2_depends_on_healthchecks

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

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

rflood_role_diun_enabledrflood2_diun_enabled

# Enable or disable Diun update notifications for containers created when deploying
# Type: bool (true/false)
rflood_role_diun_enabled: true

# Enable or disable Diun update notifications for containers created when deploying
# Type: bool (true/false)
rflood2_diun_enabled: true

rflood_role_dns_enabledrflood2_dns_enabled

# Enable or disable automatic DNS record creation for containers
# Type: bool (true/false)
rflood_role_dns_enabled: true

# Enable or disable automatic DNS record creation for containers
# Type: bool (true/false)
rflood2_dns_enabled: true

rflood_role_docker_controllerrflood2_docker_controller

# Enable or disable Saltbox Docker Controller management for containers
# Type: bool (true/false)
rflood_role_docker_controller: true

# Enable or disable Saltbox Docker Controller management for containers
# Type: bool (true/false)
rflood2_docker_controller: true

rflood_role_docker_networks_alias_customrflood2_docker_networks_alias_custom

# Type: list
rflood_role_docker_networks_alias_custom:

# Type: list
rflood2_docker_networks_alias_custom:

rflood_role_docker_volumes_downloadrflood2_docker_volumes_download

# Type: bool (true/false)
rflood_role_docker_volumes_download:

# Type: bool (true/false)
rflood2_docker_volumes_download:

rflood_role_themepark_addonsrflood2_themepark_addons

# Type: string
rflood_role_themepark_addons:

# Type: string
rflood2_themepark_addons:

rflood_role_themepark_apprflood2_themepark_app

# Type: string
rflood_role_themepark_app:

# Type: string
rflood2_themepark_app:

rflood_role_themepark_themerflood2_themepark_theme

# Type: string
rflood_role_themepark_theme:

# Type: string
rflood2_themepark_theme:

rflood_role_traefik_api_middleware_httprflood2_traefik_api_middleware_http

# Type: string
rflood_role_traefik_api_middleware_http:

# Type: string
rflood2_traefik_api_middleware_http:

rflood_role_traefik_autodetect_enabledrflood2_traefik_autodetect_enabled

# Enable Traefik autodetect middleware for containers
# Type: bool (true/false)
rflood_role_traefik_autodetect_enabled: false

# Enable Traefik autodetect middleware for containers
# Type: bool (true/false)
rflood2_traefik_autodetect_enabled: false

rflood_role_traefik_crowdsec_enabledrflood2_traefik_crowdsec_enabled

# Enable CrowdSec middleware for containers
# Type: bool (true/false)
rflood_role_traefik_crowdsec_enabled: false

# Enable CrowdSec middleware for containers
# Type: bool (true/false)
rflood2_traefik_crowdsec_enabled: false

rflood_role_traefik_error_pages_enabledrflood2_traefik_error_pages_enabled

# Enable custom error pages middleware for containers
# Type: bool (true/false)
rflood_role_traefik_error_pages_enabled: false

# Enable custom error pages middleware for containers
# Type: bool (true/false)
rflood2_traefik_error_pages_enabled: false

rflood_role_traefik_gzip_enabledrflood2_traefik_gzip_enabled

# Enable gzip compression middleware for containers
# Type: bool (true/false)
rflood_role_traefik_gzip_enabled: false

# Enable gzip compression middleware for containers
# Type: bool (true/false)
rflood2_traefik_gzip_enabled: false

rflood_role_traefik_middleware_httprflood2_traefik_middleware_http

# Type: string
rflood_role_traefik_middleware_http:

# Type: string
rflood2_traefik_middleware_http:

rflood_role_traefik_middleware_http_api_insecurerflood2_traefik_middleware_http_api_insecure

# Type: bool (true/false)
rflood_role_traefik_middleware_http_api_insecure:

# Type: bool (true/false)
rflood2_traefik_middleware_http_api_insecure:

rflood_role_traefik_middleware_http_insecurerflood2_traefik_middleware_http_insecure

# Type: bool (true/false)
rflood_role_traefik_middleware_http_insecure:

# Type: bool (true/false)
rflood2_traefik_middleware_http_insecure:

rflood_role_traefik_priorityrflood2_traefik_priority

# Type: string
rflood_role_traefik_priority:

# Type: string
rflood2_traefik_priority:

rflood_role_traefik_robot_enabledrflood2_traefik_robot_enabled

# Enable robots.txt middleware for containers
# Type: bool (true/false)
rflood_role_traefik_robot_enabled: true

# Enable robots.txt middleware for containers
# Type: bool (true/false)
rflood2_traefik_robot_enabled: true

rflood_role_traefik_tailscale_enabledrflood2_traefik_tailscale_enabled

# Enable Tailscale-specific Traefik configuration for containers
# Type: bool (true/false)
rflood_role_traefik_tailscale_enabled: false

# Enable Tailscale-specific Traefik configuration for containers
# Type: bool (true/false)
rflood2_traefik_tailscale_enabled: false

rflood_role_traefik_wildcard_enabledrflood2_traefik_wildcard_enabled

# Enable wildcard certificate for containers
# Type: bool (true/false)
rflood_role_traefik_wildcard_enabled: true

# Enable wildcard certificate for containers
# Type: bool (true/false)
rflood2_traefik_wildcard_enabled: true

rflood_role_web_api_http_portrflood2_web_api_http_port

# Type: string (quoted number)
rflood_role_web_api_http_port:

# Type: string (quoted number)
rflood2_web_api_http_port:

rflood_role_web_api_http_schemerflood2_web_api_http_scheme

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

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

rflood_role_web_api_http_serverstransportrflood2_web_api_http_serverstransport

# Type: dict/omit
rflood_role_web_api_http_serverstransport:

# Type: dict/omit
rflood2_web_api_http_serverstransport:

rflood_role_web_api_portrflood2_web_api_port

# Type: string (quoted number)
rflood_role_web_api_port:

# Type: string (quoted number)
rflood2_web_api_port:

rflood_role_web_api_schemerflood2_web_api_scheme

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

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

rflood_role_web_api_serverstransportrflood2_web_api_serverstransport

# Type: dict/omit
rflood_role_web_api_serverstransport:

# Type: dict/omit
rflood2_web_api_serverstransport:

rflood_role_web_fqdn_overriderflood2_web_fqdn_override

# Override the Traefik fully qualified domain name (FQDN) for containers
# Type: list
rflood_role_web_fqdn_override:

# Override the Traefik fully qualified domain name (FQDN) for containers
# Type: list
rflood2_web_fqdn_override:

Example Override

rflood_role_web_fqdn_override:
  - "{{ traefik_host }}"
  - "rflood2.{{ user.domain }}"
  - "rflood.otherdomain.tld"

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

Example Override

rflood2_web_fqdn_override:
  - "{{ traefik_host }}"
  - "rflood2.{{ user.domain }}"
  - "rflood.otherdomain.tld"

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

rflood_role_web_host_overriderflood2_web_host_override

# Override the Traefik web host configuration for containers
# Type: string
rflood_role_web_host_override:

# Override the Traefik web host configuration for containers
# Type: string
rflood2_web_host_override:

Example Override

rflood_role_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'rflood2.' + user.domain }}`)"

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

Example Override

rflood2_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'rflood2.' + user.domain }}`)"

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

rflood_role_web_http_portrflood2_web_http_port

# Type: string (quoted number)
rflood_role_web_http_port:

# Type: string (quoted number)
rflood2_web_http_port:

rflood_role_web_http_schemerflood2_web_http_scheme

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

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

rflood_role_web_http_serverstransportrflood2_web_http_serverstransport

# Type: dict/omit
rflood_role_web_http_serverstransport:

# Type: dict/omit
rflood2_web_http_serverstransport:

rflood_role_web_schemerflood2_web_scheme

# URL scheme to use for web access to containers
# Type: string ("http"/"https")
rflood_role_web_scheme:

# URL scheme to use for web access to containers
# Type: string ("http"/"https")
rflood2_web_scheme:

rflood_role_web_serverstransportrflood2_web_serverstransport

# Type: dict/omit
rflood_role_web_serverstransport:

# Type: dict/omit
rflood2_web_serverstransport: