WatchState

Description / name	Input element
Your domain name

Overview

WatchState is a self-hosted, open-source service designed to sync play states, including watch progress and history, across media servers such as Plex, Jellyfin, and Emby without relying on third-party servers or cloud services.

Manual

Releases

Community

---

Deployment

sb install sandbox-watchstate

Usage

Visit https://watchstate.iYOUR_DOMAIN_NAMEi.

Role Defaults

Use the Inventory to customize variables. (1)

1. This role supports multiple instances via watchstate_instances.

   Example override

   Role-levelInstance-level

   watchstate_role_web_subdomain: "custom"
   

   Applies to all instances of watchstate

   watchstate2_web_subdomain: "custom2"
   

   Applies to the instance named watchstate2

   Avoid overriding variables ending in _default

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

BasicsSettingsWebDNSTraefikDockerDocker+Global Override Options

watchstate_instances

# Type: list
watchstate_instances: ["watchstate"]

Example Override

# Type: list
watchstate_instances: ["watchstate", "watchstate2"]

watchstate_role_api_autowatchstate2_api_auto

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

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

watchstate_role_trust_proxywatchstate2_trust_proxy

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

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

watchstate_role_secure_api_endpointswatchstate2_secure_api_endpoints

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

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

watchstate_role_web_subdomainwatchstate2_web_subdomain

# Type: string
watchstate_role_web_subdomain: "{{ watchstate_name }}"

# Type: string
watchstate2_web_subdomain: "{{ watchstate_name }}"

watchstate_role_web_domainwatchstate2_web_domain

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

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

watchstate_role_web_portwatchstate2_web_port

# Type: string
watchstate_role_web_port: "8080"

# Type: string
watchstate2_web_port: "8080"

watchstate_role_web_urlwatchstate2_web_url

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

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

watchstate_role_dns_recordwatchstate2_dns_record

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

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

watchstate_role_dns_zonewatchstate2_dns_zone

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

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

watchstate_role_dns_proxywatchstate2_dns_proxy

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

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

watchstate_role_traefik_sso_middlewarewatchstate2_traefik_sso_middleware

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

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

watchstate_role_traefik_middleware_defaultwatchstate2_traefik_middleware_default

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

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

watchstate_role_traefik_middleware_customwatchstate2_traefik_middleware_custom

# Type: string
watchstate_role_traefik_middleware_custom: ""

# Type: string
watchstate2_traefik_middleware_custom: ""

watchstate_role_traefik_certresolverwatchstate2_traefik_certresolver

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

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

watchstate_role_traefik_enabledwatchstate2_traefik_enabled

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

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

watchstate_role_traefik_api_enabledwatchstate2_traefik_api_enabled

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

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

watchstate_role_traefik_api_endpointwatchstate2_traefik_api_endpoint

# Type: string
watchstate_role_traefik_api_endpoint: "PathRegexp(`backend/[^/]+/webhook`)"

# Type: string
watchstate2_traefik_api_endpoint: "PathRegexp(`backend/[^/]+/webhook`)"

Container

watchstate_role_docker_containerwatchstate2_docker_container

# Type: string
watchstate_role_docker_container: "{{ watchstate_name }}"

# Type: string
watchstate2_docker_container: "{{ watchstate_name }}"

Image

watchstate_role_docker_image_pullwatchstate2_docker_image_pull

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

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

watchstate_role_docker_image_repowatchstate2_docker_image_repo

# Type: string
watchstate_role_docker_image_repo: "ghcr.io/arabcoders/watchstate"

# Type: string
watchstate2_docker_image_repo: "ghcr.io/arabcoders/watchstate"

watchstate_role_docker_image_tagwatchstate2_docker_image_tag

# Type: string
watchstate_role_docker_image_tag: "latest"

# Type: string
watchstate2_docker_image_tag: "latest"

watchstate_role_docker_imagewatchstate2_docker_image

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

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

Envs

watchstate_role_docker_envs_defaultwatchstate2_docker_envs_default

# Type: dict
watchstate_role_docker_envs_default:
  WS_TZ: "{{ tz }}"
  WS_API_AUTO: "{{ 'true'
                if lookup('role_var', '_api_auto', role='watchstate')
                else omit }}"
  WS_TRUST_PROXY: "{{ 'true'
                   if lookup('role_var', '_trust_proxy', role='watchstate')
                   else omit }}"
  WS_SECURE_API_ENDPOINTS: "{{ 'true'
                            if lookup('role_var', '_secure_api_endpoints', role='watchstate')
                            else omit }}"

# Type: dict
watchstate2_docker_envs_default:
  WS_TZ: "{{ tz }}"
  WS_API_AUTO: "{{ 'true'
                if lookup('role_var', '_api_auto', role='watchstate')
                else omit }}"
  WS_TRUST_PROXY: "{{ 'true'
                   if lookup('role_var', '_trust_proxy', role='watchstate')
                   else omit }}"
  WS_SECURE_API_ENDPOINTS: "{{ 'true'
                            if lookup('role_var', '_secure_api_endpoints', role='watchstate')
                            else omit }}"

watchstate_role_docker_envs_customwatchstate2_docker_envs_custom

# Type: dict
watchstate_role_docker_envs_custom: {}

# Type: dict
watchstate2_docker_envs_custom: {}

Volumes

watchstate_role_docker_volumes_defaultwatchstate2_docker_volumes_default

# Type: list
watchstate_role_docker_volumes_default:
  - "{{ lookup('role_var', '_paths_location', role='watchstate') }}:/config"

# Type: list
watchstate2_docker_volumes_default:
  - "{{ lookup('role_var', '_paths_location', role='watchstate') }}:/config"

watchstate_role_docker_volumes_customwatchstate2_docker_volumes_custom

# Type: list
watchstate_role_docker_volumes_custom: []

# Type: list
watchstate2_docker_volumes_custom: []

Hostname

watchstate_role_docker_hostnamewatchstate2_docker_hostname

# Type: string
watchstate_role_docker_hostname: "{{ watchstate_name }}"

# Type: string
watchstate2_docker_hostname: "{{ watchstate_name }}"

Networks

watchstate_role_docker_networks_aliaswatchstate2_docker_networks_alias

# Type: string
watchstate_role_docker_networks_alias: "{{ watchstate_name }}"

# Type: string
watchstate2_docker_networks_alias: "{{ watchstate_name }}"

watchstate_role_docker_networks_defaultwatchstate2_docker_networks_default

# Type: list
watchstate_role_docker_networks_default: []

# Type: list
watchstate2_docker_networks_default: []

watchstate_role_docker_networks_customwatchstate2_docker_networks_custom

# Type: list
watchstate_role_docker_networks_custom: []

# Type: list
watchstate2_docker_networks_custom: []

Restart Policy

watchstate_role_docker_restart_policywatchstate2_docker_restart_policy

# Type: string
watchstate_role_docker_restart_policy: unless-stopped

# Type: string
watchstate2_docker_restart_policy: unless-stopped

State

watchstate_role_docker_statewatchstate2_docker_state

# Type: string
watchstate_role_docker_state: started

# Type: string
watchstate2_docker_state: started

User

watchstate_role_docker_userwatchstate2_docker_user

# Type: string
watchstate_role_docker_user: "{{ uid }}:{{ gid }}"

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

watchstate_role_docker_blkio_weightwatchstate2_docker_blkio_weight

# Type: int
watchstate_role_docker_blkio_weight:

# Type: int
watchstate2_docker_blkio_weight:

watchstate_role_docker_cpu_periodwatchstate2_docker_cpu_period

# Type: int
watchstate_role_docker_cpu_period:

# Type: int
watchstate2_docker_cpu_period:

watchstate_role_docker_cpu_quotawatchstate2_docker_cpu_quota

# Type: int
watchstate_role_docker_cpu_quota:

# Type: int
watchstate2_docker_cpu_quota:

watchstate_role_docker_cpu_shareswatchstate2_docker_cpu_shares

# Type: int
watchstate_role_docker_cpu_shares:

# Type: int
watchstate2_docker_cpu_shares:

watchstate_role_docker_cpuswatchstate2_docker_cpus

# Type: string
watchstate_role_docker_cpus:

# Type: string
watchstate2_docker_cpus:

watchstate_role_docker_cpuset_cpuswatchstate2_docker_cpuset_cpus

# Type: string
watchstate_role_docker_cpuset_cpus:

# Type: string
watchstate2_docker_cpuset_cpus:

watchstate_role_docker_cpuset_memswatchstate2_docker_cpuset_mems

# Type: string
watchstate_role_docker_cpuset_mems:

# Type: string
watchstate2_docker_cpuset_mems:

watchstate_role_docker_kernel_memorywatchstate2_docker_kernel_memory

# Type: string
watchstate_role_docker_kernel_memory:

# Type: string
watchstate2_docker_kernel_memory:

watchstate_role_docker_memorywatchstate2_docker_memory

# Type: string
watchstate_role_docker_memory:

# Type: string
watchstate2_docker_memory:

watchstate_role_docker_memory_reservationwatchstate2_docker_memory_reservation

# Type: string
watchstate_role_docker_memory_reservation:

# Type: string
watchstate2_docker_memory_reservation:

watchstate_role_docker_memory_swapwatchstate2_docker_memory_swap

# Type: string
watchstate_role_docker_memory_swap:

# Type: string
watchstate2_docker_memory_swap:

watchstate_role_docker_memory_swappinesswatchstate2_docker_memory_swappiness

# Type: int
watchstate_role_docker_memory_swappiness:

# Type: int
watchstate2_docker_memory_swappiness:

watchstate_role_docker_shm_sizewatchstate2_docker_shm_size

# Type: string
watchstate_role_docker_shm_size:

# Type: string
watchstate2_docker_shm_size:

Security & Devices

watchstate_role_docker_cap_dropwatchstate2_docker_cap_drop

# Type: list
watchstate_role_docker_cap_drop:

# Type: list
watchstate2_docker_cap_drop:

watchstate_role_docker_cgroupns_modewatchstate2_docker_cgroupns_mode

# Type: string
watchstate_role_docker_cgroupns_mode:

# Type: string
watchstate2_docker_cgroupns_mode:

watchstate_role_docker_device_cgroup_ruleswatchstate2_docker_device_cgroup_rules

# Type: list
watchstate_role_docker_device_cgroup_rules:

# Type: list
watchstate2_docker_device_cgroup_rules:

watchstate_role_docker_device_read_bpswatchstate2_docker_device_read_bps

# Type: list
watchstate_role_docker_device_read_bps:

# Type: list
watchstate2_docker_device_read_bps:

watchstate_role_docker_device_read_iopswatchstate2_docker_device_read_iops

# Type: list
watchstate_role_docker_device_read_iops:

# Type: list
watchstate2_docker_device_read_iops:

watchstate_role_docker_device_requestswatchstate2_docker_device_requests

# Type: list
watchstate_role_docker_device_requests:

# Type: list
watchstate2_docker_device_requests:

watchstate_role_docker_device_write_bpswatchstate2_docker_device_write_bps

# Type: list
watchstate_role_docker_device_write_bps:

# Type: list
watchstate2_docker_device_write_bps:

watchstate_role_docker_device_write_iopswatchstate2_docker_device_write_iops

# Type: list
watchstate_role_docker_device_write_iops:

# Type: list
watchstate2_docker_device_write_iops:

watchstate_role_docker_deviceswatchstate2_docker_devices

# Type: list
watchstate_role_docker_devices:

# Type: list
watchstate2_docker_devices:

watchstate_role_docker_devices_defaultwatchstate2_docker_devices_default

# Type: string
watchstate_role_docker_devices_default:

# Type: string
watchstate2_docker_devices_default:

watchstate_role_docker_groupswatchstate2_docker_groups

# Type: list
watchstate_role_docker_groups:

# Type: list
watchstate2_docker_groups:

watchstate_role_docker_privilegedwatchstate2_docker_privileged

# Type: bool (true/false)
watchstate_role_docker_privileged:

# Type: bool (true/false)
watchstate2_docker_privileged:

watchstate_role_docker_security_optswatchstate2_docker_security_opts

# Type: list
watchstate_role_docker_security_opts:

# Type: list
watchstate2_docker_security_opts:

watchstate_role_docker_userns_modewatchstate2_docker_userns_mode

# Type: string
watchstate_role_docker_userns_mode:

# Type: string
watchstate2_docker_userns_mode:

Networking

watchstate_role_docker_dns_optswatchstate2_docker_dns_opts

# Type: list
watchstate_role_docker_dns_opts:

# Type: list
watchstate2_docker_dns_opts:

watchstate_role_docker_dns_search_domainswatchstate2_docker_dns_search_domains

# Type: list
watchstate_role_docker_dns_search_domains:

# Type: list
watchstate2_docker_dns_search_domains:

watchstate_role_docker_dns_serverswatchstate2_docker_dns_servers

# Type: list
watchstate_role_docker_dns_servers:

# Type: list
watchstate2_docker_dns_servers:

watchstate_role_docker_domainnamewatchstate2_docker_domainname

# Type: string
watchstate_role_docker_domainname:

# Type: string
watchstate2_docker_domainname:

watchstate_role_docker_exposed_portswatchstate2_docker_exposed_ports

# Type: list
watchstate_role_docker_exposed_ports:

# Type: list
watchstate2_docker_exposed_ports:

watchstate_role_docker_hostswatchstate2_docker_hosts

# Type: dict
watchstate_role_docker_hosts:

# Type: dict
watchstate2_docker_hosts:

watchstate_role_docker_hosts_use_commonwatchstate2_docker_hosts_use_common

# Type: bool (true/false)
watchstate_role_docker_hosts_use_common:

# Type: bool (true/false)
watchstate2_docker_hosts_use_common:

watchstate_role_docker_ipc_modewatchstate2_docker_ipc_mode

# Type: string
watchstate_role_docker_ipc_mode:

# Type: string
watchstate2_docker_ipc_mode:

watchstate_role_docker_linkswatchstate2_docker_links

# Type: list
watchstate_role_docker_links:

# Type: list
watchstate2_docker_links:

watchstate_role_docker_network_modewatchstate2_docker_network_mode

# Type: string
watchstate_role_docker_network_mode:

# Type: string
watchstate2_docker_network_mode:

watchstate_role_docker_pid_modewatchstate2_docker_pid_mode

# Type: string
watchstate_role_docker_pid_mode:

# Type: string
watchstate2_docker_pid_mode:

watchstate_role_docker_portswatchstate2_docker_ports

# Type: list
watchstate_role_docker_ports:

# Type: list
watchstate2_docker_ports:

watchstate_role_docker_utswatchstate2_docker_uts

# Type: string
watchstate_role_docker_uts:

# Type: string
watchstate2_docker_uts:

Storage

watchstate_role_docker_keep_volumeswatchstate2_docker_keep_volumes

# Type: bool (true/false)
watchstate_role_docker_keep_volumes:

# Type: bool (true/false)
watchstate2_docker_keep_volumes:

watchstate_role_docker_mountswatchstate2_docker_mounts

# Type: list
watchstate_role_docker_mounts:

# Type: list
watchstate2_docker_mounts:

watchstate_role_docker_storage_optswatchstate2_docker_storage_opts

# Type: dict
watchstate_role_docker_storage_opts:

# Type: dict
watchstate2_docker_storage_opts:

watchstate_role_docker_tmpfswatchstate2_docker_tmpfs

# Type: list
watchstate_role_docker_tmpfs:

# Type: list
watchstate2_docker_tmpfs:

watchstate_role_docker_volume_driverwatchstate2_docker_volume_driver

# Type: string
watchstate_role_docker_volume_driver:

# Type: string
watchstate2_docker_volume_driver:

watchstate_role_docker_volumes_fromwatchstate2_docker_volumes_from

# Type: list
watchstate_role_docker_volumes_from:

# Type: list
watchstate2_docker_volumes_from:

watchstate_role_docker_volumes_globalwatchstate2_docker_volumes_global

# Type: bool (true/false)
watchstate_role_docker_volumes_global:

# Type: bool (true/false)
watchstate2_docker_volumes_global:

watchstate_role_docker_working_dirwatchstate2_docker_working_dir

# Type: string
watchstate_role_docker_working_dir:

# Type: string
watchstate2_docker_working_dir:

Monitoring & Lifecycle

watchstate_role_docker_auto_removewatchstate2_docker_auto_remove

# Type: bool (true/false)
watchstate_role_docker_auto_remove:

# Type: bool (true/false)
watchstate2_docker_auto_remove:

watchstate_role_docker_cleanupwatchstate2_docker_cleanup

# Type: bool (true/false)
watchstate_role_docker_cleanup:

# Type: bool (true/false)
watchstate2_docker_cleanup:

watchstate_role_docker_force_killwatchstate2_docker_force_kill

# Type: string
watchstate_role_docker_force_kill:

# Type: string
watchstate2_docker_force_kill:

watchstate_role_docker_healthcheckwatchstate2_docker_healthcheck

# Type: dict
watchstate_role_docker_healthcheck:

# Type: dict
watchstate2_docker_healthcheck:

watchstate_role_docker_healthy_wait_timeoutwatchstate2_docker_healthy_wait_timeout

# Type: int
watchstate_role_docker_healthy_wait_timeout:

# Type: int
watchstate2_docker_healthy_wait_timeout:

watchstate_role_docker_initwatchstate2_docker_init

# Type: bool (true/false)
watchstate_role_docker_init:

# Type: bool (true/false)
watchstate2_docker_init:

watchstate_role_docker_kill_signalwatchstate2_docker_kill_signal

# Type: string
watchstate_role_docker_kill_signal:

# Type: string
watchstate2_docker_kill_signal:

watchstate_role_docker_log_driverwatchstate2_docker_log_driver

# Type: string
watchstate_role_docker_log_driver:

# Type: string
watchstate2_docker_log_driver:

watchstate_role_docker_log_optionswatchstate2_docker_log_options

# Type: dict
watchstate_role_docker_log_options:

# Type: dict
watchstate2_docker_log_options:

watchstate_role_docker_oom_killerwatchstate2_docker_oom_killer

# Type: bool (true/false)
watchstate_role_docker_oom_killer:

# Type: bool (true/false)
watchstate2_docker_oom_killer:

watchstate_role_docker_oom_score_adjwatchstate2_docker_oom_score_adj

# Type: int
watchstate_role_docker_oom_score_adj:

# Type: int
watchstate2_docker_oom_score_adj:

watchstate_role_docker_output_logswatchstate2_docker_output_logs

# Type: bool (true/false)
watchstate_role_docker_output_logs:

# Type: bool (true/false)
watchstate2_docker_output_logs:

watchstate_role_docker_pausedwatchstate2_docker_paused

# Type: bool (true/false)
watchstate_role_docker_paused:

# Type: bool (true/false)
watchstate2_docker_paused:

watchstate_role_docker_recreatewatchstate2_docker_recreate

# Type: bool (true/false)
watchstate_role_docker_recreate:

# Type: bool (true/false)
watchstate2_docker_recreate:

watchstate_role_docker_restart_retrieswatchstate2_docker_restart_retries

# Type: int
watchstate_role_docker_restart_retries:

# Type: int
watchstate2_docker_restart_retries:

watchstate_role_docker_stop_timeoutwatchstate2_docker_stop_timeout

# Type: int
watchstate_role_docker_stop_timeout:

# Type: int
watchstate2_docker_stop_timeout:

Other Options

watchstate_role_docker_capabilitieswatchstate2_docker_capabilities

# Type: list
watchstate_role_docker_capabilities:

# Type: list
watchstate2_docker_capabilities:

watchstate_role_docker_cgroup_parentwatchstate2_docker_cgroup_parent

# Type: string
watchstate_role_docker_cgroup_parent:

# Type: string
watchstate2_docker_cgroup_parent:

watchstate_role_docker_commandswatchstate2_docker_commands

# Type: list
watchstate_role_docker_commands:

# Type: list
watchstate2_docker_commands:

watchstate_role_docker_create_timeoutwatchstate2_docker_create_timeout

# Type: int
watchstate_role_docker_create_timeout:

# Type: int
watchstate2_docker_create_timeout:

watchstate_role_docker_entrypointwatchstate2_docker_entrypoint

# Type: string
watchstate_role_docker_entrypoint:

# Type: string
watchstate2_docker_entrypoint:

watchstate_role_docker_env_filewatchstate2_docker_env_file

# Type: string
watchstate_role_docker_env_file:

# Type: string
watchstate2_docker_env_file:

watchstate_role_docker_labelswatchstate2_docker_labels

# Type: dict
watchstate_role_docker_labels:

# Type: dict
watchstate2_docker_labels:

watchstate_role_docker_labels_use_commonwatchstate2_docker_labels_use_common

# Type: bool (true/false)
watchstate_role_docker_labels_use_common:

# Type: bool (true/false)
watchstate2_docker_labels_use_common:

watchstate_role_docker_read_onlywatchstate2_docker_read_only

# Type: bool (true/false)
watchstate_role_docker_read_only:

# Type: bool (true/false)
watchstate2_docker_read_only:

watchstate_role_docker_runtimewatchstate2_docker_runtime

# Type: string
watchstate_role_docker_runtime:

# Type: string
watchstate2_docker_runtime:

watchstate_role_docker_sysctlswatchstate2_docker_sysctls

# Type: list
watchstate_role_docker_sysctls:

# Type: list
watchstate2_docker_sysctls:

watchstate_role_docker_ulimitswatchstate2_docker_ulimits

# Type: list
watchstate_role_docker_ulimits:

# Type: list
watchstate2_docker_ulimits:

watchstate_role_api_autowatchstate2_api_auto

# Type: string
watchstate_role_api_auto:

# Type: string
watchstate2_api_auto:

watchstate_role_autoheal_enabledwatchstate2_autoheal_enabled

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

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

watchstate_role_depends_onwatchstate2_depends_on

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

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

watchstate_role_depends_on_delaywatchstate2_depends_on_delay

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

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

watchstate_role_depends_on_healthcheckswatchstate2_depends_on_healthchecks

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

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

watchstate_role_diun_enabledwatchstate2_diun_enabled

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

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

watchstate_role_dns_enabledwatchstate2_dns_enabled

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

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

watchstate_role_docker_controllerwatchstate2_docker_controller

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

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

watchstate_role_docker_image_repowatchstate2_docker_image_repo

# Type: string
watchstate_role_docker_image_repo:

# Type: string
watchstate2_docker_image_repo:

watchstate_role_docker_image_tagwatchstate2_docker_image_tag

# Type: string
watchstate_role_docker_image_tag:

# Type: string
watchstate2_docker_image_tag:

watchstate_role_docker_volumes_downloadwatchstate2_docker_volumes_download

# Type: bool (true/false)
watchstate_role_docker_volumes_download:

# Type: bool (true/false)
watchstate2_docker_volumes_download:

watchstate_role_paths_locationwatchstate2_paths_location

# Type: string
watchstate_role_paths_location:

# Type: string
watchstate2_paths_location:

watchstate_role_secure_api_endpointswatchstate2_secure_api_endpoints

# Type: string
watchstate_role_secure_api_endpoints:

# Type: string
watchstate2_secure_api_endpoints:

watchstate_role_themepark_addonswatchstate2_themepark_addons

# Type: string
watchstate_role_themepark_addons:

# Type: string
watchstate2_themepark_addons:

watchstate_role_themepark_appwatchstate2_themepark_app

# Type: string
watchstate_role_themepark_app:

# Type: string
watchstate2_themepark_app:

watchstate_role_themepark_themewatchstate2_themepark_theme

# Type: string
watchstate_role_themepark_theme:

# Type: string
watchstate2_themepark_theme:

watchstate_role_traefik_api_endpointwatchstate2_traefik_api_endpoint

# Type: dict/omit
watchstate_role_traefik_api_endpoint:

# Type: dict/omit
watchstate2_traefik_api_endpoint:

watchstate_role_traefik_api_middlewarewatchstate2_traefik_api_middleware

# Type: string
watchstate_role_traefik_api_middleware:

# Type: string
watchstate2_traefik_api_middleware:

watchstate_role_traefik_api_middleware_httpwatchstate2_traefik_api_middleware_http

# Type: string
watchstate_role_traefik_api_middleware_http:

# Type: string
watchstate2_traefik_api_middleware_http:

watchstate_role_traefik_autodetect_enabledwatchstate2_traefik_autodetect_enabled

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

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

watchstate_role_traefik_certresolverwatchstate2_traefik_certresolver

# Type: string
watchstate_role_traefik_certresolver:

# Type: string
watchstate2_traefik_certresolver:

watchstate_role_traefik_crowdsec_enabledwatchstate2_traefik_crowdsec_enabled

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

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

watchstate_role_traefik_error_pages_enabledwatchstate2_traefik_error_pages_enabled

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

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

watchstate_role_traefik_gzip_enabledwatchstate2_traefik_gzip_enabled

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

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

watchstate_role_traefik_middleware_httpwatchstate2_traefik_middleware_http

# Type: string
watchstate_role_traefik_middleware_http:

# Type: string
watchstate2_traefik_middleware_http:

watchstate_role_traefik_middleware_http_api_insecurewatchstate2_traefik_middleware_http_api_insecure

# Type: bool (true/false)
watchstate_role_traefik_middleware_http_api_insecure:

# Type: bool (true/false)
watchstate2_traefik_middleware_http_api_insecure:

watchstate_role_traefik_middleware_http_insecurewatchstate2_traefik_middleware_http_insecure

# Type: bool (true/false)
watchstate_role_traefik_middleware_http_insecure:

# Type: bool (true/false)
watchstate2_traefik_middleware_http_insecure:

watchstate_role_traefik_prioritywatchstate2_traefik_priority

# Type: string
watchstate_role_traefik_priority:

# Type: string
watchstate2_traefik_priority:

watchstate_role_traefik_robot_enabledwatchstate2_traefik_robot_enabled

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

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

watchstate_role_traefik_tailscale_enabledwatchstate2_traefik_tailscale_enabled

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

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

watchstate_role_traefik_wildcard_enabledwatchstate2_traefik_wildcard_enabled

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

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

watchstate_role_trust_proxywatchstate2_trust_proxy

# Type: bool (true/false)
watchstate_role_trust_proxy:

# Type: bool (true/false)
watchstate2_trust_proxy:

watchstate_role_web_domainwatchstate2_web_domain

# Type: string
watchstate_role_web_domain:

# Type: string
watchstate2_web_domain:

watchstate_role_web_fqdn_overridewatchstate2_web_fqdn_override

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

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

Example Override

watchstate_role_web_fqdn_override:
  - "{{ traefik_host }}"
  - "watchstate2.{{ user.domain }}"
  - "watchstate.otherdomain.tld"

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

Example Override

watchstate2_web_fqdn_override:
  - "{{ traefik_host }}"
  - "watchstate2.{{ user.domain }}"
  - "watchstate.otherdomain.tld"

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

watchstate_role_web_host_overridewatchstate2_web_host_override

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

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

Example Override

watchstate_role_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'watchstate2.' + user.domain }}`)"

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

Example Override

watchstate2_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'watchstate2.' + user.domain }}`)"

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

watchstate_role_web_http_portwatchstate2_web_http_port

# Type: string (quoted number)
watchstate_role_web_http_port:

# Type: string (quoted number)
watchstate2_web_http_port:

watchstate_role_web_http_schemewatchstate2_web_http_scheme

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

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

watchstate_role_web_http_serverstransportwatchstate2_web_http_serverstransport

# Type: dict/omit
watchstate_role_web_http_serverstransport:

# Type: dict/omit
watchstate2_web_http_serverstransport:

watchstate_role_web_schemewatchstate2_web_scheme

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

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

watchstate_role_web_serverstransportwatchstate2_web_serverstransport

# Type: dict/omit
watchstate_role_web_serverstransport:

# Type: dict/omit
watchstate2_web_serverstransport:

watchstate_role_web_subdomainwatchstate2_web_subdomain

# Type: string
watchstate_role_web_subdomain:

# Type: string
watchstate2_web_subdomain: