Wizarr¶
| Description / name | Input element |
|---|---|
| Your domain name |
Overview¶
Wizarr is a automatic user invitation system for Plex, Jellyfin and Emby. Create a unique link and share it to a user and they will automatically be invited to your media Server! They will even be guided to download the client and instructions on how to use your requests software!.
Deployment¶
sb install sandbox-wizarr
Usage¶
Visit https://wizarr.iYOUR_DOMAIN_NAMEi.
Role Defaults¶
Use the Inventory to customize variables. (1)
-
This role supports multiple instances via
wizarr_instances.Example override
wizarr_role_web_subdomain: "custom"Applies to all instances of wizarr
wizarr2_web_subdomain: "custom2"Applies to the instance named wizarr2
Avoid overriding variables ending in
_defaultWhen overriding variables that end in
_default(likewizarr_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 (likewizarr_docker_envs_custom) to add your changes. Custom values are merged with defaults, ensuring you receive updates.
wizarr_instances
# Type: list
wizarr_instances: ["wizarr"]
Example Override
# Type: list
wizarr_instances: ["wizarr", "wizarr2"]
wizarr_role_web_subdomainwizarr2_web_subdomain
# Type: string
wizarr_role_web_subdomain: "{{ wizarr_name }}"
# Type: string
wizarr2_web_subdomain: "{{ wizarr_name }}"
wizarr_role_web_domainwizarr2_web_domain
# Type: string
wizarr_role_web_domain: "{{ user.domain }}"
# Type: string
wizarr2_web_domain: "{{ user.domain }}"
wizarr_role_web_portwizarr2_web_port
# Type: string
wizarr_role_web_port: "5690"
# Type: string
wizarr2_web_port: "5690"
wizarr_role_web_urlwizarr2_web_url
# Type: string
wizarr_role_web_url: "{{ 'https://' + (lookup('role_var', '_web_subdomain', role='wizarr') + '.' + lookup('role_var', '_web_domain', role='wizarr')
if (lookup('role_var', '_web_subdomain', role='wizarr') | length > 0)
else lookup('role_var', '_web_domain', role='wizarr')) }}"
# Type: string
wizarr2_web_url: "{{ 'https://' + (lookup('role_var', '_web_subdomain', role='wizarr') + '.' + lookup('role_var', '_web_domain', role='wizarr')
if (lookup('role_var', '_web_subdomain', role='wizarr') | length > 0)
else lookup('role_var', '_web_domain', role='wizarr')) }}"
wizarr_role_dns_recordwizarr2_dns_record
# Type: string
wizarr_role_dns_record: "{{ lookup('role_var', '_web_subdomain', role='wizarr') }}"
# Type: string
wizarr2_dns_record: "{{ lookup('role_var', '_web_subdomain', role='wizarr') }}"
wizarr_role_dns_zonewizarr2_dns_zone
# Type: string
wizarr_role_dns_zone: "{{ lookup('role_var', '_web_domain', role='wizarr') }}"
# Type: string
wizarr2_dns_zone: "{{ lookup('role_var', '_web_domain', role='wizarr') }}"
wizarr_role_dns_proxywizarr2_dns_proxy
# Type: bool (true/false)
wizarr_role_dns_proxy: "{{ dns_proxied }}"
# Type: bool (true/false)
wizarr2_dns_proxy: "{{ dns_proxied }}"
wizarr_role_traefik_sso_middlewarewizarr2_traefik_sso_middleware
# Type: string
wizarr_role_traefik_sso_middleware: "{{ traefik_default_sso_middleware }}"
# Type: string
wizarr2_traefik_sso_middleware: "{{ traefik_default_sso_middleware }}"
wizarr_role_traefik_middleware_defaultwizarr2_traefik_middleware_default
# Type: string
wizarr_role_traefik_middleware_default: "{{ traefik_default_middleware }}"
# Type: string
wizarr2_traefik_middleware_default: "{{ traefik_default_middleware }}"
wizarr_role_traefik_middleware_customwizarr2_traefik_middleware_custom
# Type: string
wizarr_role_traefik_middleware_custom: ""
# Type: string
wizarr2_traefik_middleware_custom: ""
wizarr_role_traefik_certresolverwizarr2_traefik_certresolver
# Type: string
wizarr_role_traefik_certresolver: "{{ traefik_default_certresolver }}"
# Type: string
wizarr2_traefik_certresolver: "{{ traefik_default_certresolver }}"
wizarr_role_traefik_enabledwizarr2_traefik_enabled
# Type: bool (true/false)
wizarr_role_traefik_enabled: true
# Type: bool (true/false)
wizarr2_traefik_enabled: true
wizarr_role_traefik_api_enabledwizarr2_traefik_api_enabled
# Type: bool (true/false)
wizarr_role_traefik_api_enabled: true
# Type: bool (true/false)
wizarr2_traefik_api_enabled: true
wizarr_role_traefik_api_endpointwizarr2_traefik_api_endpoint
# Type: string
wizarr_role_traefik_api_endpoint: "PathPrefix(`/join`) || PathPrefix(`/j`) || PathPrefix(`/static`) || PathPrefix(`/setup`) || PathPrefix(`/wizard`) || PathPrefix(`/image-proxy`) || PathPrefix(`/cinema-posters`) || PathPrefix(`/invitation`)"
# Type: string
wizarr2_traefik_api_endpoint: "PathPrefix(`/join`) || PathPrefix(`/j`) || PathPrefix(`/static`) || PathPrefix(`/setup`) || PathPrefix(`/wizard`) || PathPrefix(`/image-proxy`) || PathPrefix(`/cinema-posters`) || PathPrefix(`/invitation`)"
Container
wizarr_role_docker_containerwizarr2_docker_container
# Type: string
wizarr_role_docker_container: "{{ wizarr_name }}"
# Type: string
wizarr2_docker_container: "{{ wizarr_name }}"
Image
wizarr_role_docker_image_pullwizarr2_docker_image_pull
# Type: bool (true/false)
wizarr_role_docker_image_pull: true
# Type: bool (true/false)
wizarr2_docker_image_pull: true
wizarr_role_docker_image_repowizarr2_docker_image_repo
# Type: string
wizarr_role_docker_image_repo: "ghcr.io/wizarrrr/wizarr"
# Type: string
wizarr2_docker_image_repo: "ghcr.io/wizarrrr/wizarr"
wizarr_role_docker_image_tagwizarr2_docker_image_tag
# Type: string
wizarr_role_docker_image_tag: "latest"
# Type: string
wizarr2_docker_image_tag: "latest"
wizarr_role_docker_imagewizarr2_docker_image
# Type: string
wizarr_role_docker_image: "{{ lookup('role_var', '_docker_image_repo', role='wizarr') }}:{{ lookup('role_var', '_docker_image_tag', role='wizarr') }}"
# Type: string
wizarr2_docker_image: "{{ lookup('role_var', '_docker_image_repo', role='wizarr') }}:{{ lookup('role_var', '_docker_image_tag', role='wizarr') }}"
Envs
wizarr_role_docker_envs_defaultwizarr2_docker_envs_default
# Type: dict
wizarr_role_docker_envs_default:
TZ: "{{ tz }}"
PUID: "{{ uid }}"
PGID: "{{ gid }}"
DISABLE_BUILTIN_AUTH: "{{ 'true' if (lookup('role_var', '_traefik_sso_middleware', role='wizarr') | length > 0) else 'false' }}"
# Type: dict
wizarr2_docker_envs_default:
TZ: "{{ tz }}"
PUID: "{{ uid }}"
PGID: "{{ gid }}"
DISABLE_BUILTIN_AUTH: "{{ 'true' if (lookup('role_var', '_traefik_sso_middleware', role='wizarr') | length > 0) else 'false' }}"
wizarr_role_docker_envs_customwizarr2_docker_envs_custom
# Type: dict
wizarr_role_docker_envs_custom: {}
# Type: dict
wizarr2_docker_envs_custom: {}
Volumes
wizarr_role_docker_volumes_defaultwizarr2_docker_volumes_default
# Type: list
wizarr_role_docker_volumes_default:
- "{{ lookup('role_var', '_paths_location', role='wizarr') }}:/data"
# Type: list
wizarr2_docker_volumes_default:
- "{{ lookup('role_var', '_paths_location', role='wizarr') }}:/data"
wizarr_role_docker_volumes_customwizarr2_docker_volumes_custom
# Type: list
wizarr_role_docker_volumes_custom: []
# Type: list
wizarr2_docker_volumes_custom: []
Hostname
wizarr_role_docker_hostnamewizarr2_docker_hostname
# Type: string
wizarr_role_docker_hostname: "{{ wizarr_name }}"
# Type: string
wizarr2_docker_hostname: "{{ wizarr_name }}"
Networks
wizarr_role_docker_networks_aliaswizarr2_docker_networks_alias
# Type: string
wizarr_role_docker_networks_alias: "{{ wizarr_name }}"
# Type: string
wizarr2_docker_networks_alias: "{{ wizarr_name }}"
wizarr_role_docker_networks_defaultwizarr2_docker_networks_default
# Type: list
wizarr_role_docker_networks_default: []
# Type: list
wizarr2_docker_networks_default: []
wizarr_role_docker_networks_customwizarr2_docker_networks_custom
# Type: list
wizarr_role_docker_networks_custom: []
# Type: list
wizarr2_docker_networks_custom: []
Restart Policy
wizarr_role_docker_restart_policywizarr2_docker_restart_policy
# Type: string
wizarr_role_docker_restart_policy: unless-stopped
# Type: string
wizarr2_docker_restart_policy: unless-stopped
State
wizarr_role_docker_statewizarr2_docker_state
# Type: string
wizarr_role_docker_state: started
# Type: string
wizarr2_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
wizarr_role_docker_blkio_weightwizarr2_docker_blkio_weight
# Type: int
wizarr_role_docker_blkio_weight:
# Type: int
wizarr2_docker_blkio_weight:
wizarr_role_docker_cpu_periodwizarr2_docker_cpu_period
# Type: int
wizarr_role_docker_cpu_period:
# Type: int
wizarr2_docker_cpu_period:
wizarr_role_docker_cpu_quotawizarr2_docker_cpu_quota
# Type: int
wizarr_role_docker_cpu_quota:
# Type: int
wizarr2_docker_cpu_quota:
wizarr_role_docker_cpu_shareswizarr2_docker_cpu_shares
# Type: int
wizarr_role_docker_cpu_shares:
# Type: int
wizarr2_docker_cpu_shares:
wizarr_role_docker_cpuswizarr2_docker_cpus
# Type: string
wizarr_role_docker_cpus:
# Type: string
wizarr2_docker_cpus:
wizarr_role_docker_cpuset_cpuswizarr2_docker_cpuset_cpus
# Type: string
wizarr_role_docker_cpuset_cpus:
# Type: string
wizarr2_docker_cpuset_cpus:
wizarr_role_docker_cpuset_memswizarr2_docker_cpuset_mems
# Type: string
wizarr_role_docker_cpuset_mems:
# Type: string
wizarr2_docker_cpuset_mems:
wizarr_role_docker_kernel_memorywizarr2_docker_kernel_memory
# Type: string
wizarr_role_docker_kernel_memory:
# Type: string
wizarr2_docker_kernel_memory:
wizarr_role_docker_memorywizarr2_docker_memory
# Type: string
wizarr_role_docker_memory:
# Type: string
wizarr2_docker_memory:
wizarr_role_docker_memory_reservationwizarr2_docker_memory_reservation
# Type: string
wizarr_role_docker_memory_reservation:
# Type: string
wizarr2_docker_memory_reservation:
wizarr_role_docker_memory_swapwizarr2_docker_memory_swap
# Type: string
wizarr_role_docker_memory_swap:
# Type: string
wizarr2_docker_memory_swap:
wizarr_role_docker_memory_swappinesswizarr2_docker_memory_swappiness
# Type: int
wizarr_role_docker_memory_swappiness:
# Type: int
wizarr2_docker_memory_swappiness:
wizarr_role_docker_shm_sizewizarr2_docker_shm_size
# Type: string
wizarr_role_docker_shm_size:
# Type: string
wizarr2_docker_shm_size:
Security & Devices
wizarr_role_docker_cap_dropwizarr2_docker_cap_drop
# Type: list
wizarr_role_docker_cap_drop:
# Type: list
wizarr2_docker_cap_drop:
wizarr_role_docker_cgroupns_modewizarr2_docker_cgroupns_mode
# Type: string
wizarr_role_docker_cgroupns_mode:
# Type: string
wizarr2_docker_cgroupns_mode:
wizarr_role_docker_device_cgroup_ruleswizarr2_docker_device_cgroup_rules
# Type: list
wizarr_role_docker_device_cgroup_rules:
# Type: list
wizarr2_docker_device_cgroup_rules:
wizarr_role_docker_device_read_bpswizarr2_docker_device_read_bps
# Type: list
wizarr_role_docker_device_read_bps:
# Type: list
wizarr2_docker_device_read_bps:
wizarr_role_docker_device_read_iopswizarr2_docker_device_read_iops
# Type: list
wizarr_role_docker_device_read_iops:
# Type: list
wizarr2_docker_device_read_iops:
wizarr_role_docker_device_requestswizarr2_docker_device_requests
# Type: list
wizarr_role_docker_device_requests:
# Type: list
wizarr2_docker_device_requests:
wizarr_role_docker_device_write_bpswizarr2_docker_device_write_bps
# Type: list
wizarr_role_docker_device_write_bps:
# Type: list
wizarr2_docker_device_write_bps:
wizarr_role_docker_device_write_iopswizarr2_docker_device_write_iops
# Type: list
wizarr_role_docker_device_write_iops:
# Type: list
wizarr2_docker_device_write_iops:
wizarr_role_docker_deviceswizarr2_docker_devices
# Type: list
wizarr_role_docker_devices:
# Type: list
wizarr2_docker_devices:
wizarr_role_docker_devices_defaultwizarr2_docker_devices_default
# Type: string
wizarr_role_docker_devices_default:
# Type: string
wizarr2_docker_devices_default:
wizarr_role_docker_groupswizarr2_docker_groups
# Type: list
wizarr_role_docker_groups:
# Type: list
wizarr2_docker_groups:
wizarr_role_docker_privilegedwizarr2_docker_privileged
# Type: bool (true/false)
wizarr_role_docker_privileged:
# Type: bool (true/false)
wizarr2_docker_privileged:
wizarr_role_docker_security_optswizarr2_docker_security_opts
# Type: list
wizarr_role_docker_security_opts:
# Type: list
wizarr2_docker_security_opts:
wizarr_role_docker_userwizarr2_docker_user
# Type: string
wizarr_role_docker_user:
# Type: string
wizarr2_docker_user:
wizarr_role_docker_userns_modewizarr2_docker_userns_mode
# Type: string
wizarr_role_docker_userns_mode:
# Type: string
wizarr2_docker_userns_mode:
Networking
wizarr_role_docker_dns_optswizarr2_docker_dns_opts
# Type: list
wizarr_role_docker_dns_opts:
# Type: list
wizarr2_docker_dns_opts:
wizarr_role_docker_dns_search_domainswizarr2_docker_dns_search_domains
# Type: list
wizarr_role_docker_dns_search_domains:
# Type: list
wizarr2_docker_dns_search_domains:
wizarr_role_docker_dns_serverswizarr2_docker_dns_servers
# Type: list
wizarr_role_docker_dns_servers:
# Type: list
wizarr2_docker_dns_servers:
wizarr_role_docker_domainnamewizarr2_docker_domainname
# Type: string
wizarr_role_docker_domainname:
# Type: string
wizarr2_docker_domainname:
wizarr_role_docker_exposed_portswizarr2_docker_exposed_ports
# Type: list
wizarr_role_docker_exposed_ports:
# Type: list
wizarr2_docker_exposed_ports:
wizarr_role_docker_hostswizarr2_docker_hosts
# Type: dict
wizarr_role_docker_hosts:
# Type: dict
wizarr2_docker_hosts:
wizarr_role_docker_hosts_use_commonwizarr2_docker_hosts_use_common
# Type: bool (true/false)
wizarr_role_docker_hosts_use_common:
# Type: bool (true/false)
wizarr2_docker_hosts_use_common:
wizarr_role_docker_ipc_modewizarr2_docker_ipc_mode
# Type: string
wizarr_role_docker_ipc_mode:
# Type: string
wizarr2_docker_ipc_mode:
wizarr_role_docker_linkswizarr2_docker_links
# Type: list
wizarr_role_docker_links:
# Type: list
wizarr2_docker_links:
wizarr_role_docker_network_modewizarr2_docker_network_mode
# Type: string
wizarr_role_docker_network_mode:
# Type: string
wizarr2_docker_network_mode:
wizarr_role_docker_pid_modewizarr2_docker_pid_mode
# Type: string
wizarr_role_docker_pid_mode:
# Type: string
wizarr2_docker_pid_mode:
wizarr_role_docker_portswizarr2_docker_ports
# Type: list
wizarr_role_docker_ports:
# Type: list
wizarr2_docker_ports:
wizarr_role_docker_utswizarr2_docker_uts
# Type: string
wizarr_role_docker_uts:
# Type: string
wizarr2_docker_uts:
Storage
wizarr_role_docker_keep_volumeswizarr2_docker_keep_volumes
# Type: bool (true/false)
wizarr_role_docker_keep_volumes:
# Type: bool (true/false)
wizarr2_docker_keep_volumes:
wizarr_role_docker_mountswizarr2_docker_mounts
# Type: list
wizarr_role_docker_mounts:
# Type: list
wizarr2_docker_mounts:
wizarr_role_docker_storage_optswizarr2_docker_storage_opts
# Type: dict
wizarr_role_docker_storage_opts:
# Type: dict
wizarr2_docker_storage_opts:
wizarr_role_docker_tmpfswizarr2_docker_tmpfs
# Type: list
wizarr_role_docker_tmpfs:
# Type: list
wizarr2_docker_tmpfs:
wizarr_role_docker_volume_driverwizarr2_docker_volume_driver
# Type: string
wizarr_role_docker_volume_driver:
# Type: string
wizarr2_docker_volume_driver:
wizarr_role_docker_volumes_fromwizarr2_docker_volumes_from
# Type: list
wizarr_role_docker_volumes_from:
# Type: list
wizarr2_docker_volumes_from:
wizarr_role_docker_volumes_globalwizarr2_docker_volumes_global
# Type: bool (true/false)
wizarr_role_docker_volumes_global:
# Type: bool (true/false)
wizarr2_docker_volumes_global:
wizarr_role_docker_working_dirwizarr2_docker_working_dir
# Type: string
wizarr_role_docker_working_dir:
# Type: string
wizarr2_docker_working_dir:
Monitoring & Lifecycle
wizarr_role_docker_auto_removewizarr2_docker_auto_remove
# Type: bool (true/false)
wizarr_role_docker_auto_remove:
# Type: bool (true/false)
wizarr2_docker_auto_remove:
wizarr_role_docker_cleanupwizarr2_docker_cleanup
# Type: bool (true/false)
wizarr_role_docker_cleanup:
# Type: bool (true/false)
wizarr2_docker_cleanup:
wizarr_role_docker_force_killwizarr2_docker_force_kill
# Type: string
wizarr_role_docker_force_kill:
# Type: string
wizarr2_docker_force_kill:
wizarr_role_docker_healthcheckwizarr2_docker_healthcheck
# Type: dict
wizarr_role_docker_healthcheck:
# Type: dict
wizarr2_docker_healthcheck:
wizarr_role_docker_healthy_wait_timeoutwizarr2_docker_healthy_wait_timeout
# Type: int
wizarr_role_docker_healthy_wait_timeout:
# Type: int
wizarr2_docker_healthy_wait_timeout:
wizarr_role_docker_initwizarr2_docker_init
# Type: bool (true/false)
wizarr_role_docker_init:
# Type: bool (true/false)
wizarr2_docker_init:
wizarr_role_docker_kill_signalwizarr2_docker_kill_signal
# Type: string
wizarr_role_docker_kill_signal:
# Type: string
wizarr2_docker_kill_signal:
wizarr_role_docker_log_driverwizarr2_docker_log_driver
# Type: string
wizarr_role_docker_log_driver:
# Type: string
wizarr2_docker_log_driver:
wizarr_role_docker_log_optionswizarr2_docker_log_options
# Type: dict
wizarr_role_docker_log_options:
# Type: dict
wizarr2_docker_log_options:
wizarr_role_docker_oom_killerwizarr2_docker_oom_killer
# Type: bool (true/false)
wizarr_role_docker_oom_killer:
# Type: bool (true/false)
wizarr2_docker_oom_killer:
wizarr_role_docker_oom_score_adjwizarr2_docker_oom_score_adj
# Type: int
wizarr_role_docker_oom_score_adj:
# Type: int
wizarr2_docker_oom_score_adj:
wizarr_role_docker_output_logswizarr2_docker_output_logs
# Type: bool (true/false)
wizarr_role_docker_output_logs:
# Type: bool (true/false)
wizarr2_docker_output_logs:
wizarr_role_docker_pausedwizarr2_docker_paused
# Type: bool (true/false)
wizarr_role_docker_paused:
# Type: bool (true/false)
wizarr2_docker_paused:
wizarr_role_docker_recreatewizarr2_docker_recreate
# Type: bool (true/false)
wizarr_role_docker_recreate:
# Type: bool (true/false)
wizarr2_docker_recreate:
wizarr_role_docker_restart_retrieswizarr2_docker_restart_retries
# Type: int
wizarr_role_docker_restart_retries:
# Type: int
wizarr2_docker_restart_retries:
wizarr_role_docker_stop_timeoutwizarr2_docker_stop_timeout
# Type: int
wizarr_role_docker_stop_timeout:
# Type: int
wizarr2_docker_stop_timeout:
Other Options
wizarr_role_docker_capabilitieswizarr2_docker_capabilities
# Type: list
wizarr_role_docker_capabilities:
# Type: list
wizarr2_docker_capabilities:
wizarr_role_docker_cgroup_parentwizarr2_docker_cgroup_parent
# Type: string
wizarr_role_docker_cgroup_parent:
# Type: string
wizarr2_docker_cgroup_parent:
wizarr_role_docker_commandswizarr2_docker_commands
# Type: list
wizarr_role_docker_commands:
# Type: list
wizarr2_docker_commands:
wizarr_role_docker_create_timeoutwizarr2_docker_create_timeout
# Type: int
wizarr_role_docker_create_timeout:
# Type: int
wizarr2_docker_create_timeout:
wizarr_role_docker_entrypointwizarr2_docker_entrypoint
# Type: string
wizarr_role_docker_entrypoint:
# Type: string
wizarr2_docker_entrypoint:
wizarr_role_docker_env_filewizarr2_docker_env_file
# Type: string
wizarr_role_docker_env_file:
# Type: string
wizarr2_docker_env_file:
wizarr_role_docker_labelswizarr2_docker_labels
# Type: dict
wizarr_role_docker_labels:
# Type: dict
wizarr2_docker_labels:
wizarr_role_docker_labels_use_commonwizarr2_docker_labels_use_common
# Type: bool (true/false)
wizarr_role_docker_labels_use_common:
# Type: bool (true/false)
wizarr2_docker_labels_use_common:
wizarr_role_docker_read_onlywizarr2_docker_read_only
# Type: bool (true/false)
wizarr_role_docker_read_only:
# Type: bool (true/false)
wizarr2_docker_read_only:
wizarr_role_docker_runtimewizarr2_docker_runtime
# Type: string
wizarr_role_docker_runtime:
# Type: string
wizarr2_docker_runtime:
wizarr_role_docker_sysctlswizarr2_docker_sysctls
# Type: list
wizarr_role_docker_sysctls:
# Type: list
wizarr2_docker_sysctls:
wizarr_role_docker_ulimitswizarr2_docker_ulimits
# Type: list
wizarr_role_docker_ulimits:
# Type: list
wizarr2_docker_ulimits:
wizarr_role_autoheal_enabledwizarr2_autoheal_enabled
# Enable or disable Autoheal monitoring for containers created when deploying
# Type: bool (true/false)
wizarr_role_autoheal_enabled: true
# Enable or disable Autoheal monitoring for containers created when deploying
# Type: bool (true/false)
wizarr2_autoheal_enabled: true
wizarr_role_depends_onwizarr2_depends_on
# List of container dependencies that must be running before containers start
# Type: string
wizarr_role_depends_on: ""
# List of container dependencies that must be running before containers start
# Type: string
wizarr2_depends_on: ""
wizarr_role_depends_on_delaywizarr2_depends_on_delay
# Delay in seconds before starting containers after dependencies are ready
# Type: string (quoted number)
wizarr_role_depends_on_delay: "0"
# Delay in seconds before starting containers after dependencies are ready
# Type: string (quoted number)
wizarr2_depends_on_delay: "0"
wizarr_role_depends_on_healthcheckswizarr2_depends_on_healthchecks
# Enable healthcheck waiting for container dependencies
# Type: string ("true"/"false")
wizarr_role_depends_on_healthchecks:
# Enable healthcheck waiting for container dependencies
# Type: string ("true"/"false")
wizarr2_depends_on_healthchecks:
wizarr_role_diun_enabledwizarr2_diun_enabled
# Enable or disable Diun update notifications for containers created when deploying
# Type: bool (true/false)
wizarr_role_diun_enabled: true
# Enable or disable Diun update notifications for containers created when deploying
# Type: bool (true/false)
wizarr2_diun_enabled: true
wizarr_role_dns_enabledwizarr2_dns_enabled
# Enable or disable automatic DNS record creation for containers
# Type: bool (true/false)
wizarr_role_dns_enabled: true
# Enable or disable automatic DNS record creation for containers
# Type: bool (true/false)
wizarr2_dns_enabled: true
wizarr_role_docker_controllerwizarr2_docker_controller
# Enable or disable Saltbox Docker Controller management for containers
# Type: bool (true/false)
wizarr_role_docker_controller: true
# Enable or disable Saltbox Docker Controller management for containers
# Type: bool (true/false)
wizarr2_docker_controller: true
wizarr_role_docker_image_repowizarr2_docker_image_repo
# Type: string
wizarr_role_docker_image_repo:
# Type: string
wizarr2_docker_image_repo:
wizarr_role_docker_image_tagwizarr2_docker_image_tag
# Type: string
wizarr_role_docker_image_tag:
# Type: string
wizarr2_docker_image_tag:
wizarr_role_docker_volumes_downloadwizarr2_docker_volumes_download
# Type: bool (true/false)
wizarr_role_docker_volumes_download:
# Type: bool (true/false)
wizarr2_docker_volumes_download:
wizarr_role_paths_locationwizarr2_paths_location
# Type: string
wizarr_role_paths_location:
# Type: string
wizarr2_paths_location:
wizarr_role_themepark_addonswizarr2_themepark_addons
# Type: string
wizarr_role_themepark_addons:
# Type: string
wizarr2_themepark_addons:
wizarr_role_themepark_appwizarr2_themepark_app
# Type: string
wizarr_role_themepark_app:
# Type: string
wizarr2_themepark_app:
wizarr_role_themepark_themewizarr2_themepark_theme
# Type: string
wizarr_role_themepark_theme:
# Type: string
wizarr2_themepark_theme:
wizarr_role_traefik_api_endpointwizarr2_traefik_api_endpoint
# Type: dict/omit
wizarr_role_traefik_api_endpoint:
# Type: dict/omit
wizarr2_traefik_api_endpoint:
wizarr_role_traefik_api_middlewarewizarr2_traefik_api_middleware
# Type: string
wizarr_role_traefik_api_middleware:
# Type: string
wizarr2_traefik_api_middleware:
wizarr_role_traefik_api_middleware_httpwizarr2_traefik_api_middleware_http
# Type: string
wizarr_role_traefik_api_middleware_http:
# Type: string
wizarr2_traefik_api_middleware_http:
wizarr_role_traefik_autodetect_enabledwizarr2_traefik_autodetect_enabled
# Enable Traefik autodetect middleware for containers
# Type: bool (true/false)
wizarr_role_traefik_autodetect_enabled: false
# Enable Traefik autodetect middleware for containers
# Type: bool (true/false)
wizarr2_traefik_autodetect_enabled: false
wizarr_role_traefik_certresolverwizarr2_traefik_certresolver
# Type: string
wizarr_role_traefik_certresolver:
# Type: string
wizarr2_traefik_certresolver:
wizarr_role_traefik_crowdsec_enabledwizarr2_traefik_crowdsec_enabled
# Enable CrowdSec middleware for containers
# Type: bool (true/false)
wizarr_role_traefik_crowdsec_enabled: false
# Enable CrowdSec middleware for containers
# Type: bool (true/false)
wizarr2_traefik_crowdsec_enabled: false
wizarr_role_traefik_error_pages_enabledwizarr2_traefik_error_pages_enabled
# Enable custom error pages middleware for containers
# Type: bool (true/false)
wizarr_role_traefik_error_pages_enabled: false
# Enable custom error pages middleware for containers
# Type: bool (true/false)
wizarr2_traefik_error_pages_enabled: false
wizarr_role_traefik_gzip_enabledwizarr2_traefik_gzip_enabled
# Enable gzip compression middleware for containers
# Type: bool (true/false)
wizarr_role_traefik_gzip_enabled: false
# Enable gzip compression middleware for containers
# Type: bool (true/false)
wizarr2_traefik_gzip_enabled: false
wizarr_role_traefik_middleware_httpwizarr2_traefik_middleware_http
# Type: string
wizarr_role_traefik_middleware_http:
# Type: string
wizarr2_traefik_middleware_http:
wizarr_role_traefik_middleware_http_api_insecurewizarr2_traefik_middleware_http_api_insecure
# Type: bool (true/false)
wizarr_role_traefik_middleware_http_api_insecure:
# Type: bool (true/false)
wizarr2_traefik_middleware_http_api_insecure:
wizarr_role_traefik_middleware_http_insecurewizarr2_traefik_middleware_http_insecure
# Type: bool (true/false)
wizarr_role_traefik_middleware_http_insecure:
# Type: bool (true/false)
wizarr2_traefik_middleware_http_insecure:
wizarr_role_traefik_prioritywizarr2_traefik_priority
# Type: string
wizarr_role_traefik_priority:
# Type: string
wizarr2_traefik_priority:
wizarr_role_traefik_robot_enabledwizarr2_traefik_robot_enabled
# Enable robots.txt middleware for containers
# Type: bool (true/false)
wizarr_role_traefik_robot_enabled: true
# Enable robots.txt middleware for containers
# Type: bool (true/false)
wizarr2_traefik_robot_enabled: true
wizarr_role_traefik_sso_middlewarewizarr2_traefik_sso_middleware
# Type: string
wizarr_role_traefik_sso_middleware:
# Type: string
wizarr2_traefik_sso_middleware:
wizarr_role_traefik_tailscale_enabledwizarr2_traefik_tailscale_enabled
# Enable Tailscale-specific Traefik configuration for containers
# Type: bool (true/false)
wizarr_role_traefik_tailscale_enabled: false
# Enable Tailscale-specific Traefik configuration for containers
# Type: bool (true/false)
wizarr2_traefik_tailscale_enabled: false
wizarr_role_traefik_wildcard_enabledwizarr2_traefik_wildcard_enabled
# Enable wildcard certificate for containers
# Type: bool (true/false)
wizarr_role_traefik_wildcard_enabled: true
# Enable wildcard certificate for containers
# Type: bool (true/false)
wizarr2_traefik_wildcard_enabled: true
wizarr_role_web_domainwizarr2_web_domain
# Type: string
wizarr_role_web_domain:
# Type: string
wizarr2_web_domain:
wizarr_role_web_fqdn_overridewizarr2_web_fqdn_override
# Override the Traefik fully qualified domain name (FQDN) for containers
# Type: list
wizarr_role_web_fqdn_override:
# Override the Traefik fully qualified domain name (FQDN) for containers
# Type: list
wizarr2_web_fqdn_override:
Example Override
wizarr_role_web_fqdn_override:
- "{{ traefik_host }}"
- "wizarr2.{{ user.domain }}"
- "wizarr.otherdomain.tld"
Note: Include {{ traefik_host }} to preserve the default FQDN alongside your custom entries
Example Override
wizarr2_web_fqdn_override:
- "{{ traefik_host }}"
- "wizarr2.{{ user.domain }}"
- "wizarr.otherdomain.tld"
Note: Include {{ traefik_host }} to preserve the default FQDN alongside your custom entries
wizarr_role_web_host_overridewizarr2_web_host_override
# Override the Traefik web host configuration for containers
# Type: string
wizarr_role_web_host_override:
# Override the Traefik web host configuration for containers
# Type: string
wizarr2_web_host_override:
Example Override
wizarr_role_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'wizarr2.' + user.domain }}`)"
Note: Use {{ traefik_host }} to include the default host configuration in your custom rule
Example Override
wizarr2_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'wizarr2.' + user.domain }}`)"
Note: Use {{ traefik_host }} to include the default host configuration in your custom rule
wizarr_role_web_http_portwizarr2_web_http_port
# Type: string (quoted number)
wizarr_role_web_http_port:
# Type: string (quoted number)
wizarr2_web_http_port:
wizarr_role_web_http_schemewizarr2_web_http_scheme
# Type: string ("http"/"https")
wizarr_role_web_http_scheme:
# Type: string ("http"/"https")
wizarr2_web_http_scheme:
wizarr_role_web_http_serverstransportwizarr2_web_http_serverstransport
# Type: dict/omit
wizarr_role_web_http_serverstransport:
# Type: dict/omit
wizarr2_web_http_serverstransport:
wizarr_role_web_schemewizarr2_web_scheme
# URL scheme to use for web access to containers
# Type: string ("http"/"https")
wizarr_role_web_scheme:
# URL scheme to use for web access to containers
# Type: string ("http"/"https")
wizarr2_web_scheme:
wizarr_role_web_serverstransportwizarr2_web_serverstransport
# Type: dict/omit
wizarr_role_web_serverstransport:
# Type: dict/omit
wizarr2_web_serverstransport:
wizarr_role_web_subdomainwizarr2_web_subdomain
# Type: string
wizarr_role_web_subdomain:
# Type: string
wizarr2_web_subdomain: