qui¶
| Description / name | Input element |
|---|---|
| Your domain name |
Overview¶
qui is a fast, modern web interface for qBittorrent. Supports managing multiple qBittorrent instances from a single, lightweight application.
Deployment¶
sb install sandbox-qui
Usage¶
Visit https://qui.iYOUR_DOMAIN_NAMEi.
Basics¶
- Configure your qBittorrent instance connections through the web interface.
Role Defaults¶
Use the Inventory to customize variables. (1)
-
This role supports multiple instances via
qui_instances.Example override
qui_role_web_subdomain: "custom"Applies to all instances of qui
qui2_web_subdomain: "custom2"Applies to the instance named qui2
Avoid overriding variables ending in
_defaultWhen overriding variables that end in
_default(likequi_docker_envs_default), you replace the entire default configuration. Future updates that add new default values will not be applied to your setup, potentially breaking functionality.Instead, use the corresponding
_customvariable (likequi_docker_envs_custom) to add your changes. Custom values are merged with defaults, ensuring you receive updates.
qui_instances
# Type: list
qui_instances: ["qui"]
Example Override
# Type: list
qui_instances: ["qui", "qui2"]
qui_role_web_subdomainqui2_web_subdomain
# Type: string
qui_role_web_subdomain: "{{ qui_name }}"
# Type: string
qui2_web_subdomain: "{{ qui_name }}"
qui_role_web_domainqui2_web_domain
# Type: string
qui_role_web_domain: "{{ user.domain }}"
# Type: string
qui2_web_domain: "{{ user.domain }}"
qui_role_web_portqui2_web_port
# Type: string
qui_role_web_port: "7476"
# Type: string
qui2_web_port: "7476"
qui_role_web_urlqui2_web_url
# Type: string
qui_role_web_url: "{{ 'https://' + (lookup('role_var', '_web_subdomain', role='qui') + '.' + lookup('role_var', '_web_domain', role='qui')
if (lookup('role_var', '_web_subdomain', role='qui') | length > 0)
else lookup('role_var', '_web_domain', role='qui')) }}"
# Type: string
qui2_web_url: "{{ 'https://' + (lookup('role_var', '_web_subdomain', role='qui') + '.' + lookup('role_var', '_web_domain', role='qui')
if (lookup('role_var', '_web_subdomain', role='qui') | length > 0)
else lookup('role_var', '_web_domain', role='qui')) }}"
qui_role_dns_recordqui2_dns_record
# Type: string
qui_role_dns_record: "{{ lookup('role_var', '_web_subdomain', role='qui') }}"
# Type: string
qui2_dns_record: "{{ lookup('role_var', '_web_subdomain', role='qui') }}"
qui_role_dns_zonequi2_dns_zone
# Type: string
qui_role_dns_zone: "{{ lookup('role_var', '_web_domain', role='qui') }}"
# Type: string
qui2_dns_zone: "{{ lookup('role_var', '_web_domain', role='qui') }}"
qui_role_dns_proxyqui2_dns_proxy
# Type: bool (true/false)
qui_role_dns_proxy: "{{ dns_proxied }}"
# Type: bool (true/false)
qui2_dns_proxy: "{{ dns_proxied }}"
qui_role_traefik_sso_middlewarequi2_traefik_sso_middleware
# Type: string
qui_role_traefik_sso_middleware: "{{ traefik_default_sso_middleware }}"
# Type: string
qui2_traefik_sso_middleware: "{{ traefik_default_sso_middleware }}"
qui_role_traefik_middleware_defaultqui2_traefik_middleware_default
# Type: string
qui_role_traefik_middleware_default: "{{ traefik_default_middleware }}"
# Type: string
qui2_traefik_middleware_default: "{{ traefik_default_middleware }}"
qui_role_traefik_middleware_customqui2_traefik_middleware_custom
# Type: string
qui_role_traefik_middleware_custom: ""
# Type: string
qui2_traefik_middleware_custom: ""
qui_role_traefik_certresolverqui2_traefik_certresolver
# Type: string
qui_role_traefik_certresolver: "{{ traefik_default_certresolver }}"
# Type: string
qui2_traefik_certresolver: "{{ traefik_default_certresolver }}"
qui_role_traefik_enabledqui2_traefik_enabled
# Type: bool (true/false)
qui_role_traefik_enabled: true
# Type: bool (true/false)
qui2_traefik_enabled: true
qui_role_traefik_api_enabledqui2_traefik_api_enabled
# Type: bool (true/false)
qui_role_traefik_api_enabled: true
# Type: bool (true/false)
qui2_traefik_api_enabled: true
qui_role_traefik_api_endpointqui2_traefik_api_endpoint
# Type: string
qui_role_traefik_api_endpoint: "PathPrefix(`/proxy`)"
# Type: string
qui2_traefik_api_endpoint: "PathPrefix(`/proxy`)"
Container
qui_role_docker_containerqui2_docker_container
# Type: string
qui_role_docker_container: "{{ qui_name }}"
# Type: string
qui2_docker_container: "{{ qui_name }}"
Image
qui_role_docker_image_pullqui2_docker_image_pull
# Type: bool (true/false)
qui_role_docker_image_pull: true
# Type: bool (true/false)
qui2_docker_image_pull: true
qui_role_docker_image_repoqui2_docker_image_repo
# Type: string
qui_role_docker_image_repo: "ghcr.io/autobrr/qui"
# Type: string
qui2_docker_image_repo: "ghcr.io/autobrr/qui"
qui_role_docker_image_tagqui2_docker_image_tag
# Type: string
qui_role_docker_image_tag: "latest"
# Type: string
qui2_docker_image_tag: "latest"
qui_role_docker_imagequi2_docker_image
# Type: string
qui_role_docker_image: "{{ lookup('role_var', '_docker_image_repo', role='qui') }}:{{ lookup('role_var', '_docker_image_tag', role='qui') }}"
# Type: string
qui2_docker_image: "{{ lookup('role_var', '_docker_image_repo', role='qui') }}:{{ lookup('role_var', '_docker_image_tag', role='qui') }}"
Envs
qui_role_docker_envs_defaultqui2_docker_envs_default
# Type: dict
qui_role_docker_envs_default:
TZ: "{{ tz }}"
# Type: dict
qui2_docker_envs_default:
TZ: "{{ tz }}"
qui_role_docker_envs_customqui2_docker_envs_custom
# Type: dict
qui_role_docker_envs_custom: {}
# Type: dict
qui2_docker_envs_custom: {}
Volumes
qui_role_docker_volumes_defaultqui2_docker_volumes_default
# Type: list
qui_role_docker_volumes_default:
- "{{ lookup('role_var', '_paths_location', role='qui') }}:/config"
# Type: list
qui2_docker_volumes_default:
- "{{ lookup('role_var', '_paths_location', role='qui') }}:/config"
qui_role_docker_volumes_customqui2_docker_volumes_custom
# Type: list
qui_role_docker_volumes_custom: []
# Type: list
qui2_docker_volumes_custom: []
Hosts
qui_role_docker_hosts_defaultqui2_docker_hosts_default
# Type: dict
qui_role_docker_hosts_default: {}
# Type: dict
qui2_docker_hosts_default: {}
qui_role_docker_hosts_customqui2_docker_hosts_custom
# Type: dict
qui_role_docker_hosts_custom: {}
# Type: dict
qui2_docker_hosts_custom: {}
Hostname
qui_role_docker_hostnamequi2_docker_hostname
# Type: string
qui_role_docker_hostname: "{{ qui_name }}"
# Type: string
qui2_docker_hostname: "{{ qui_name }}"
Networks
qui_role_docker_networks_aliasqui2_docker_networks_alias
# Type: string
qui_role_docker_networks_alias: "{{ qui_name }}"
# Type: string
qui2_docker_networks_alias: "{{ qui_name }}"
qui_role_docker_networks_defaultqui2_docker_networks_default
# Type: list
qui_role_docker_networks_default: []
# Type: list
qui2_docker_networks_default: []
qui_role_docker_networks_customqui2_docker_networks_custom
# Type: list
qui_role_docker_networks_custom: []
# Type: list
qui2_docker_networks_custom: []
Restart Policy
qui_role_docker_restart_policyqui2_docker_restart_policy
# Type: string
qui_role_docker_restart_policy: unless-stopped
# Type: string
qui2_docker_restart_policy: unless-stopped
State
qui_role_docker_statequi2_docker_state
# Type: string
qui_role_docker_state: started
# Type: string
qui2_docker_state: started
User
qui_role_docker_userqui2_docker_user
# Type: string
qui_role_docker_user: "{{ uid }}:{{ gid }}"
# Type: string
qui2_docker_user: "{{ uid }}:{{ gid }}"
The following advanced options are available via create_docker_container but are not defined in the role. See: docker_container module
Resource Limits
qui_role_docker_blkio_weightqui2_docker_blkio_weight
# Type: int
qui_role_docker_blkio_weight:
# Type: int
qui2_docker_blkio_weight:
qui_role_docker_cpu_periodqui2_docker_cpu_period
# Type: int
qui_role_docker_cpu_period:
# Type: int
qui2_docker_cpu_period:
qui_role_docker_cpu_quotaqui2_docker_cpu_quota
# Type: int
qui_role_docker_cpu_quota:
# Type: int
qui2_docker_cpu_quota:
qui_role_docker_cpu_sharesqui2_docker_cpu_shares
# Type: int
qui_role_docker_cpu_shares:
# Type: int
qui2_docker_cpu_shares:
qui_role_docker_cpusqui2_docker_cpus
# Type: string
qui_role_docker_cpus:
# Type: string
qui2_docker_cpus:
qui_role_docker_cpuset_cpusqui2_docker_cpuset_cpus
# Type: string
qui_role_docker_cpuset_cpus:
# Type: string
qui2_docker_cpuset_cpus:
qui_role_docker_cpuset_memsqui2_docker_cpuset_mems
# Type: string
qui_role_docker_cpuset_mems:
# Type: string
qui2_docker_cpuset_mems:
qui_role_docker_kernel_memoryqui2_docker_kernel_memory
# Type: string
qui_role_docker_kernel_memory:
# Type: string
qui2_docker_kernel_memory:
qui_role_docker_memoryqui2_docker_memory
# Type: string
qui_role_docker_memory:
# Type: string
qui2_docker_memory:
qui_role_docker_memory_reservationqui2_docker_memory_reservation
# Type: string
qui_role_docker_memory_reservation:
# Type: string
qui2_docker_memory_reservation:
qui_role_docker_memory_swapqui2_docker_memory_swap
# Type: string
qui_role_docker_memory_swap:
# Type: string
qui2_docker_memory_swap:
qui_role_docker_memory_swappinessqui2_docker_memory_swappiness
# Type: int
qui_role_docker_memory_swappiness:
# Type: int
qui2_docker_memory_swappiness:
qui_role_docker_shm_sizequi2_docker_shm_size
# Type: string
qui_role_docker_shm_size:
# Type: string
qui2_docker_shm_size:
Security & Devices
qui_role_docker_cap_dropqui2_docker_cap_drop
# Type: list
qui_role_docker_cap_drop:
# Type: list
qui2_docker_cap_drop:
qui_role_docker_cgroupns_modequi2_docker_cgroupns_mode
# Type: string
qui_role_docker_cgroupns_mode:
# Type: string
qui2_docker_cgroupns_mode:
qui_role_docker_device_cgroup_rulesqui2_docker_device_cgroup_rules
# Type: list
qui_role_docker_device_cgroup_rules:
# Type: list
qui2_docker_device_cgroup_rules:
qui_role_docker_device_read_bpsqui2_docker_device_read_bps
# Type: list
qui_role_docker_device_read_bps:
# Type: list
qui2_docker_device_read_bps:
qui_role_docker_device_read_iopsqui2_docker_device_read_iops
# Type: list
qui_role_docker_device_read_iops:
# Type: list
qui2_docker_device_read_iops:
qui_role_docker_device_requestsqui2_docker_device_requests
# Type: list
qui_role_docker_device_requests:
# Type: list
qui2_docker_device_requests:
qui_role_docker_device_write_bpsqui2_docker_device_write_bps
# Type: list
qui_role_docker_device_write_bps:
# Type: list
qui2_docker_device_write_bps:
qui_role_docker_device_write_iopsqui2_docker_device_write_iops
# Type: list
qui_role_docker_device_write_iops:
# Type: list
qui2_docker_device_write_iops:
qui_role_docker_devicesqui2_docker_devices
# Type: list
qui_role_docker_devices:
# Type: list
qui2_docker_devices:
qui_role_docker_devices_defaultqui2_docker_devices_default
# Type: string
qui_role_docker_devices_default:
# Type: string
qui2_docker_devices_default:
qui_role_docker_groupsqui2_docker_groups
# Type: list
qui_role_docker_groups:
# Type: list
qui2_docker_groups:
qui_role_docker_privilegedqui2_docker_privileged
# Type: bool (true/false)
qui_role_docker_privileged:
# Type: bool (true/false)
qui2_docker_privileged:
qui_role_docker_security_optsqui2_docker_security_opts
# Type: list
qui_role_docker_security_opts:
# Type: list
qui2_docker_security_opts:
qui_role_docker_userns_modequi2_docker_userns_mode
# Type: string
qui_role_docker_userns_mode:
# Type: string
qui2_docker_userns_mode:
Networking
qui_role_docker_dns_optsqui2_docker_dns_opts
# Type: list
qui_role_docker_dns_opts:
# Type: list
qui2_docker_dns_opts:
qui_role_docker_dns_search_domainsqui2_docker_dns_search_domains
# Type: list
qui_role_docker_dns_search_domains:
# Type: list
qui2_docker_dns_search_domains:
qui_role_docker_dns_serversqui2_docker_dns_servers
# Type: list
qui_role_docker_dns_servers:
# Type: list
qui2_docker_dns_servers:
qui_role_docker_domainnamequi2_docker_domainname
# Type: string
qui_role_docker_domainname:
# Type: string
qui2_docker_domainname:
qui_role_docker_exposed_portsqui2_docker_exposed_ports
# Type: list
qui_role_docker_exposed_ports:
# Type: list
qui2_docker_exposed_ports:
qui_role_docker_hosts_use_commonqui2_docker_hosts_use_common
# Type: bool (true/false)
qui_role_docker_hosts_use_common:
# Type: bool (true/false)
qui2_docker_hosts_use_common:
qui_role_docker_ipc_modequi2_docker_ipc_mode
# Type: string
qui_role_docker_ipc_mode:
# Type: string
qui2_docker_ipc_mode:
qui_role_docker_linksqui2_docker_links
# Type: list
qui_role_docker_links:
# Type: list
qui2_docker_links:
qui_role_docker_network_modequi2_docker_network_mode
# Type: string
qui_role_docker_network_mode:
# Type: string
qui2_docker_network_mode:
qui_role_docker_pid_modequi2_docker_pid_mode
# Type: string
qui_role_docker_pid_mode:
# Type: string
qui2_docker_pid_mode:
qui_role_docker_portsqui2_docker_ports
# Type: list
qui_role_docker_ports:
# Type: list
qui2_docker_ports:
qui_role_docker_utsqui2_docker_uts
# Type: string
qui_role_docker_uts:
# Type: string
qui2_docker_uts:
Storage
qui_role_docker_keep_volumesqui2_docker_keep_volumes
# Type: bool (true/false)
qui_role_docker_keep_volumes:
# Type: bool (true/false)
qui2_docker_keep_volumes:
qui_role_docker_mountsqui2_docker_mounts
# Type: list
qui_role_docker_mounts:
# Type: list
qui2_docker_mounts:
qui_role_docker_storage_optsqui2_docker_storage_opts
# Type: dict
qui_role_docker_storage_opts:
# Type: dict
qui2_docker_storage_opts:
qui_role_docker_tmpfsqui2_docker_tmpfs
# Type: list
qui_role_docker_tmpfs:
# Type: list
qui2_docker_tmpfs:
qui_role_docker_volume_driverqui2_docker_volume_driver
# Type: string
qui_role_docker_volume_driver:
# Type: string
qui2_docker_volume_driver:
qui_role_docker_volumes_fromqui2_docker_volumes_from
# Type: list
qui_role_docker_volumes_from:
# Type: list
qui2_docker_volumes_from:
qui_role_docker_volumes_globalqui2_docker_volumes_global
# Type: bool (true/false)
qui_role_docker_volumes_global:
# Type: bool (true/false)
qui2_docker_volumes_global:
qui_role_docker_working_dirqui2_docker_working_dir
# Type: string
qui_role_docker_working_dir:
# Type: string
qui2_docker_working_dir:
Monitoring & Lifecycle
qui_role_docker_auto_removequi2_docker_auto_remove
# Type: bool (true/false)
qui_role_docker_auto_remove:
# Type: bool (true/false)
qui2_docker_auto_remove:
qui_role_docker_cleanupqui2_docker_cleanup
# Type: bool (true/false)
qui_role_docker_cleanup:
# Type: bool (true/false)
qui2_docker_cleanup:
qui_role_docker_force_killqui2_docker_force_kill
# Type: string
qui_role_docker_force_kill:
# Type: string
qui2_docker_force_kill:
qui_role_docker_healthcheckqui2_docker_healthcheck
# Type: dict
qui_role_docker_healthcheck:
# Type: dict
qui2_docker_healthcheck:
qui_role_docker_healthy_wait_timeoutqui2_docker_healthy_wait_timeout
# Type: int
qui_role_docker_healthy_wait_timeout:
# Type: int
qui2_docker_healthy_wait_timeout:
qui_role_docker_initqui2_docker_init
# Type: bool (true/false)
qui_role_docker_init:
# Type: bool (true/false)
qui2_docker_init:
qui_role_docker_kill_signalqui2_docker_kill_signal
# Type: string
qui_role_docker_kill_signal:
# Type: string
qui2_docker_kill_signal:
qui_role_docker_log_driverqui2_docker_log_driver
# Type: string
qui_role_docker_log_driver:
# Type: string
qui2_docker_log_driver:
qui_role_docker_log_optionsqui2_docker_log_options
# Type: dict
qui_role_docker_log_options:
# Type: dict
qui2_docker_log_options:
qui_role_docker_oom_killerqui2_docker_oom_killer
# Type: bool (true/false)
qui_role_docker_oom_killer:
# Type: bool (true/false)
qui2_docker_oom_killer:
qui_role_docker_oom_score_adjqui2_docker_oom_score_adj
# Type: int
qui_role_docker_oom_score_adj:
# Type: int
qui2_docker_oom_score_adj:
qui_role_docker_output_logsqui2_docker_output_logs
# Type: bool (true/false)
qui_role_docker_output_logs:
# Type: bool (true/false)
qui2_docker_output_logs:
qui_role_docker_pausedqui2_docker_paused
# Type: bool (true/false)
qui_role_docker_paused:
# Type: bool (true/false)
qui2_docker_paused:
qui_role_docker_recreatequi2_docker_recreate
# Type: bool (true/false)
qui_role_docker_recreate:
# Type: bool (true/false)
qui2_docker_recreate:
qui_role_docker_restart_retriesqui2_docker_restart_retries
# Type: int
qui_role_docker_restart_retries:
# Type: int
qui2_docker_restart_retries:
qui_role_docker_stop_timeoutqui2_docker_stop_timeout
# Type: int
qui_role_docker_stop_timeout:
# Type: int
qui2_docker_stop_timeout:
Other Options
qui_role_docker_capabilitiesqui2_docker_capabilities
# Type: list
qui_role_docker_capabilities:
# Type: list
qui2_docker_capabilities:
qui_role_docker_cgroup_parentqui2_docker_cgroup_parent
# Type: string
qui_role_docker_cgroup_parent:
# Type: string
qui2_docker_cgroup_parent:
qui_role_docker_commandsqui2_docker_commands
# Type: list
qui_role_docker_commands:
# Type: list
qui2_docker_commands:
qui_role_docker_create_timeoutqui2_docker_create_timeout
# Type: int
qui_role_docker_create_timeout:
# Type: int
qui2_docker_create_timeout:
qui_role_docker_entrypointqui2_docker_entrypoint
# Type: string
qui_role_docker_entrypoint:
# Type: string
qui2_docker_entrypoint:
qui_role_docker_env_filequi2_docker_env_file
# Type: string
qui_role_docker_env_file:
# Type: string
qui2_docker_env_file:
qui_role_docker_labelsqui2_docker_labels
# Type: dict
qui_role_docker_labels:
# Type: dict
qui2_docker_labels:
qui_role_docker_labels_use_commonqui2_docker_labels_use_common
# Type: bool (true/false)
qui_role_docker_labels_use_common:
# Type: bool (true/false)
qui2_docker_labels_use_common:
qui_role_docker_read_onlyqui2_docker_read_only
# Type: bool (true/false)
qui_role_docker_read_only:
# Type: bool (true/false)
qui2_docker_read_only:
qui_role_docker_runtimequi2_docker_runtime
# Type: string
qui_role_docker_runtime:
# Type: string
qui2_docker_runtime:
qui_role_docker_sysctlsqui2_docker_sysctls
# Type: list
qui_role_docker_sysctls:
# Type: list
qui2_docker_sysctls:
qui_role_docker_ulimitsqui2_docker_ulimits
# Type: list
qui_role_docker_ulimits:
# Type: list
qui2_docker_ulimits:
qui_role_autoheal_enabledqui2_autoheal_enabled
# Enable or disable Autoheal monitoring for containers created when deploying
# Type: bool (true/false)
qui_role_autoheal_enabled: true
# Enable or disable Autoheal monitoring for containers created when deploying
# Type: bool (true/false)
qui2_autoheal_enabled: true
qui_role_depends_onqui2_depends_on
# List of container dependencies that must be running before containers start
# Type: string
qui_role_depends_on: ""
# List of container dependencies that must be running before containers start
# Type: string
qui2_depends_on: ""
qui_role_depends_on_delayqui2_depends_on_delay
# Delay in seconds before starting containers after dependencies are ready
# Type: string (quoted number)
qui_role_depends_on_delay: "0"
# Delay in seconds before starting containers after dependencies are ready
# Type: string (quoted number)
qui2_depends_on_delay: "0"
qui_role_depends_on_healthchecksqui2_depends_on_healthchecks
# Enable healthcheck waiting for container dependencies
# Type: string ("true"/"false")
qui_role_depends_on_healthchecks:
# Enable healthcheck waiting for container dependencies
# Type: string ("true"/"false")
qui2_depends_on_healthchecks:
qui_role_diun_enabledqui2_diun_enabled
# Enable or disable Diun update notifications for containers created when deploying
# Type: bool (true/false)
qui_role_diun_enabled: true
# Enable or disable Diun update notifications for containers created when deploying
# Type: bool (true/false)
qui2_diun_enabled: true
qui_role_dns_enabledqui2_dns_enabled
# Enable or disable automatic DNS record creation for containers
# Type: bool (true/false)
qui_role_dns_enabled: true
# Enable or disable automatic DNS record creation for containers
# Type: bool (true/false)
qui2_dns_enabled: true
qui_role_docker_controllerqui2_docker_controller
# Enable or disable Saltbox Docker Controller management for containers
# Type: bool (true/false)
qui_role_docker_controller: true
# Enable or disable Saltbox Docker Controller management for containers
# Type: bool (true/false)
qui2_docker_controller: true
qui_role_docker_image_repoqui2_docker_image_repo
# Type: string
qui_role_docker_image_repo:
# Type: string
qui2_docker_image_repo:
qui_role_docker_image_tagqui2_docker_image_tag
# Type: string
qui_role_docker_image_tag:
# Type: string
qui2_docker_image_tag:
qui_role_docker_volumes_downloadqui2_docker_volumes_download
# Type: bool (true/false)
qui_role_docker_volumes_download:
# Type: bool (true/false)
qui2_docker_volumes_download:
qui_role_paths_locationqui2_paths_location
# Type: string
qui_role_paths_location:
# Type: string
qui2_paths_location:
qui_role_themepark_addonsqui2_themepark_addons
# Type: string
qui_role_themepark_addons:
# Type: string
qui2_themepark_addons:
qui_role_themepark_appqui2_themepark_app
# Type: string
qui_role_themepark_app:
# Type: string
qui2_themepark_app:
qui_role_themepark_themequi2_themepark_theme
# Type: string
qui_role_themepark_theme:
# Type: string
qui2_themepark_theme:
qui_role_traefik_api_endpointqui2_traefik_api_endpoint
# Type: dict/omit
qui_role_traefik_api_endpoint:
# Type: dict/omit
qui2_traefik_api_endpoint:
qui_role_traefik_api_middlewarequi2_traefik_api_middleware
# Type: string
qui_role_traefik_api_middleware:
# Type: string
qui2_traefik_api_middleware:
qui_role_traefik_api_middleware_httpqui2_traefik_api_middleware_http
# Type: string
qui_role_traefik_api_middleware_http:
# Type: string
qui2_traefik_api_middleware_http:
qui_role_traefik_autodetect_enabledqui2_traefik_autodetect_enabled
# Enable Traefik autodetect middleware for containers
# Type: bool (true/false)
qui_role_traefik_autodetect_enabled: false
# Enable Traefik autodetect middleware for containers
# Type: bool (true/false)
qui2_traefik_autodetect_enabled: false
qui_role_traefik_certresolverqui2_traefik_certresolver
# Type: string
qui_role_traefik_certresolver:
# Type: string
qui2_traefik_certresolver:
qui_role_traefik_crowdsec_enabledqui2_traefik_crowdsec_enabled
# Enable CrowdSec middleware for containers
# Type: bool (true/false)
qui_role_traefik_crowdsec_enabled: false
# Enable CrowdSec middleware for containers
# Type: bool (true/false)
qui2_traefik_crowdsec_enabled: false
qui_role_traefik_error_pages_enabledqui2_traefik_error_pages_enabled
# Enable custom error pages middleware for containers
# Type: bool (true/false)
qui_role_traefik_error_pages_enabled: false
# Enable custom error pages middleware for containers
# Type: bool (true/false)
qui2_traefik_error_pages_enabled: false
qui_role_traefik_gzip_enabledqui2_traefik_gzip_enabled
# Enable gzip compression middleware for containers
# Type: bool (true/false)
qui_role_traefik_gzip_enabled: false
# Enable gzip compression middleware for containers
# Type: bool (true/false)
qui2_traefik_gzip_enabled: false
qui_role_traefik_middleware_httpqui2_traefik_middleware_http
# Type: string
qui_role_traefik_middleware_http:
# Type: string
qui2_traefik_middleware_http:
qui_role_traefik_middleware_http_api_insecurequi2_traefik_middleware_http_api_insecure
# Type: bool (true/false)
qui_role_traefik_middleware_http_api_insecure:
# Type: bool (true/false)
qui2_traefik_middleware_http_api_insecure:
qui_role_traefik_middleware_http_insecurequi2_traefik_middleware_http_insecure
# Type: bool (true/false)
qui_role_traefik_middleware_http_insecure:
# Type: bool (true/false)
qui2_traefik_middleware_http_insecure:
qui_role_traefik_priorityqui2_traefik_priority
# Type: string
qui_role_traefik_priority:
# Type: string
qui2_traefik_priority:
qui_role_traefik_robot_enabledqui2_traefik_robot_enabled
# Enable robots.txt middleware for containers
# Type: bool (true/false)
qui_role_traefik_robot_enabled: true
# Enable robots.txt middleware for containers
# Type: bool (true/false)
qui2_traefik_robot_enabled: true
qui_role_traefik_tailscale_enabledqui2_traefik_tailscale_enabled
# Enable Tailscale-specific Traefik configuration for containers
# Type: bool (true/false)
qui_role_traefik_tailscale_enabled: false
# Enable Tailscale-specific Traefik configuration for containers
# Type: bool (true/false)
qui2_traefik_tailscale_enabled: false
qui_role_traefik_wildcard_enabledqui2_traefik_wildcard_enabled
# Enable wildcard certificate for containers
# Type: bool (true/false)
qui_role_traefik_wildcard_enabled: true
# Enable wildcard certificate for containers
# Type: bool (true/false)
qui2_traefik_wildcard_enabled: true
qui_role_web_domainqui2_web_domain
# Type: string
qui_role_web_domain:
# Type: string
qui2_web_domain:
qui_role_web_fqdn_overridequi2_web_fqdn_override
# Override the Traefik fully qualified domain name (FQDN) for containers
# Type: list
qui_role_web_fqdn_override:
# Override the Traefik fully qualified domain name (FQDN) for containers
# Type: list
qui2_web_fqdn_override:
Example Override
qui_role_web_fqdn_override:
- "{{ traefik_host }}"
- "qui2.{{ user.domain }}"
- "qui.otherdomain.tld"
Note: Include {{ traefik_host }} to preserve the default FQDN alongside your custom entries
Example Override
qui2_web_fqdn_override:
- "{{ traefik_host }}"
- "qui2.{{ user.domain }}"
- "qui.otherdomain.tld"
Note: Include {{ traefik_host }} to preserve the default FQDN alongside your custom entries
qui_role_web_host_overridequi2_web_host_override
# Override the Traefik web host configuration for containers
# Type: string
qui_role_web_host_override:
# Override the Traefik web host configuration for containers
# Type: string
qui2_web_host_override:
Example Override
qui_role_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'qui2.' + user.domain }}`)"
Note: Use {{ traefik_host }} to include the default host configuration in your custom rule
Example Override
qui2_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'qui2.' + user.domain }}`)"
Note: Use {{ traefik_host }} to include the default host configuration in your custom rule
qui_role_web_http_portqui2_web_http_port
# Type: string (quoted number)
qui_role_web_http_port:
# Type: string (quoted number)
qui2_web_http_port:
qui_role_web_http_schemequi2_web_http_scheme
# Type: string ("http"/"https")
qui_role_web_http_scheme:
# Type: string ("http"/"https")
qui2_web_http_scheme:
qui_role_web_http_serverstransportqui2_web_http_serverstransport
# Type: dict/omit
qui_role_web_http_serverstransport:
# Type: dict/omit
qui2_web_http_serverstransport:
qui_role_web_schemequi2_web_scheme
# URL scheme to use for web access to containers
# Type: string ("http"/"https")
qui_role_web_scheme:
# URL scheme to use for web access to containers
# Type: string ("http"/"https")
qui2_web_scheme:
qui_role_web_serverstransportqui2_web_serverstransport
# Type: dict/omit
qui_role_web_serverstransport:
# Type: dict/omit
qui2_web_serverstransport:
qui_role_web_subdomainqui2_web_subdomain
# Type: string
qui_role_web_subdomain:
# Type: string
qui2_web_subdomain: