Dockwatch

Description / name	Input element
Your domain name

Overview

Dockwatch is a web-based tool developed by Notifiarr that provides a user-friendly interface for managing Docker container updates and notifications.

Manual

Releases

Community

---

Warning

Dockwatch is likely unable to take action on containers due to the security posture of the Docker socket proxy. You can override this behavior to allow Dockwatch to take actions by adding dockwatch_post_enable: true to your inventory entries.

Deployment

sb install sandbox-dockwatch

Usage

Visit https://dockwatch.iYOUR_DOMAIN_NAMEi.

Role Defaults

Use the Inventory to customize variables. (1)

1. Example override

   dockwatch_name: "custom_value"
   

   Avoid overriding variables ending in _default

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

BasicsSettingsDocker Socket ProxyWebDNSTraefikDockerDocker+Global Override Options

dockwatch_name

# Type: string
dockwatch_name: dockwatch

dockwatch_role_post_enable

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

dockwatch_role_docker_socket_proxy_envs

# Type: dict
dockwatch_role_docker_socket_proxy_envs:
  ALLOW_START: "1"
  ALLOW_STOP: "1"
  ALLOW_RESTARTS: "1"
  CONTAINERS: "1"
  IMAGES: "1"
  NETWORKS: "1"
  PORTS: "1"
  POST: "{{ '1'
         if lookup('role_var', '_post_enable', role='dockwatch')
         else omit }}"
  VOLUMES: "1"

dockwatch_role_web_subdomain

# Type: string
dockwatch_role_web_subdomain: "{{ dockwatch_name }}"

dockwatch_role_web_domain

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

dockwatch_role_web_port

# Type: string
dockwatch_role_web_port: "80"

dockwatch_role_web_url

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

dockwatch_role_dns_record

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

dockwatch_role_dns_zone

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

dockwatch_role_dns_proxy

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

dockwatch_role_traefik_sso_middleware

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

dockwatch_role_traefik_middleware_default

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

dockwatch_role_traefik_middleware_custom

# Type: string
dockwatch_role_traefik_middleware_custom: ""

dockwatch_role_traefik_certresolver

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

dockwatch_role_traefik_enabled

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

dockwatch_role_traefik_api_enabled

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

dockwatch_role_traefik_api_endpoint

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

Container

dockwatch_role_docker_container

# Type: string
dockwatch_role_docker_container: "{{ dockwatch_name }}"

Image

dockwatch_role_docker_image_pull

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

dockwatch_role_docker_image_repo

# Type: string
dockwatch_role_docker_image_repo: "ghcr.io/notifiarr/dockwatch"

dockwatch_role_docker_image_tag

# Type: string
dockwatch_role_docker_image_tag: "main"

dockwatch_role_docker_image

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

Envs

dockwatch_role_docker_envs_default

# Type: dict
dockwatch_role_docker_envs_default:
  PUID: "{{ uid }}"
  PGID: "{{ gid }}"
  TZ: "{{ tz }}"
  DOCKER_HOST: "{{ dockwatch_name }}-docker-socket-proxy:2375"

dockwatch_role_docker_envs_custom

# Type: dict
dockwatch_role_docker_envs_custom: {}

Volumes

dockwatch_role_docker_volumes_default

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

dockwatch_role_docker_volumes_custom

# Type: list
dockwatch_role_docker_volumes_custom: []

Hostname

dockwatch_role_docker_hostname

# Type: string
dockwatch_role_docker_hostname: "{{ dockwatch_name }}"

Networks

dockwatch_role_docker_networks_alias

# Type: string
dockwatch_role_docker_networks_alias: "{{ dockwatch_name }}"

dockwatch_role_docker_networks_default

# Type: list
dockwatch_role_docker_networks_default: []

dockwatch_role_docker_networks_custom

# Type: list
dockwatch_role_docker_networks_custom: []

Restart Policy

dockwatch_role_docker_restart_policy

# Type: string
dockwatch_role_docker_restart_policy: unless-stopped

State

dockwatch_role_docker_state

# Type: string
dockwatch_role_docker_state: started

Dependencies

dockwatch_role_depends_on

# Type: string
dockwatch_role_depends_on: "{{ dockwatch_name }}-docker-socket-proxy"

dockwatch_role_depends_on_delay

# Type: string (quoted number)
dockwatch_role_depends_on_delay: "0"

dockwatch_role_depends_on_healthchecks

# Type: string ("true"/"false")
dockwatch_role_depends_on_healthchecks: "false"

The following advanced options are available via create_docker_container but are not defined in the role. See: docker_container module

Resource Limits

dockwatch_role_docker_blkio_weight

# Type: int
dockwatch_role_docker_blkio_weight:

dockwatch_role_docker_cpu_period

# Type: int
dockwatch_role_docker_cpu_period:

dockwatch_role_docker_cpu_quota

# Type: int
dockwatch_role_docker_cpu_quota:

dockwatch_role_docker_cpu_shares

# Type: int
dockwatch_role_docker_cpu_shares:

dockwatch_role_docker_cpus

# Type: string
dockwatch_role_docker_cpus:

dockwatch_role_docker_cpuset_cpus

# Type: string
dockwatch_role_docker_cpuset_cpus:

dockwatch_role_docker_cpuset_mems

# Type: string
dockwatch_role_docker_cpuset_mems:

dockwatch_role_docker_kernel_memory

# Type: string
dockwatch_role_docker_kernel_memory:

dockwatch_role_docker_memory

# Type: string
dockwatch_role_docker_memory:

dockwatch_role_docker_memory_reservation

# Type: string
dockwatch_role_docker_memory_reservation:

dockwatch_role_docker_memory_swap

# Type: string
dockwatch_role_docker_memory_swap:

dockwatch_role_docker_memory_swappiness

# Type: int
dockwatch_role_docker_memory_swappiness:

dockwatch_role_docker_shm_size

# Type: string
dockwatch_role_docker_shm_size:

Security & Devices

dockwatch_role_docker_cap_drop

# Type: list
dockwatch_role_docker_cap_drop:

dockwatch_role_docker_cgroupns_mode

# Type: string
dockwatch_role_docker_cgroupns_mode:

dockwatch_role_docker_device_cgroup_rules

# Type: list
dockwatch_role_docker_device_cgroup_rules:

dockwatch_role_docker_device_read_bps

# Type: list
dockwatch_role_docker_device_read_bps:

dockwatch_role_docker_device_read_iops

# Type: list
dockwatch_role_docker_device_read_iops:

dockwatch_role_docker_device_requests

# Type: list
dockwatch_role_docker_device_requests:

dockwatch_role_docker_device_write_bps

# Type: list
dockwatch_role_docker_device_write_bps:

dockwatch_role_docker_device_write_iops

# Type: list
dockwatch_role_docker_device_write_iops:

dockwatch_role_docker_devices

# Type: list
dockwatch_role_docker_devices:

dockwatch_role_docker_devices_default

# Type: string
dockwatch_role_docker_devices_default:

dockwatch_role_docker_groups

# Type: list
dockwatch_role_docker_groups:

dockwatch_role_docker_privileged

# Type: bool (true/false)
dockwatch_role_docker_privileged:

dockwatch_role_docker_security_opts

# Type: list
dockwatch_role_docker_security_opts:

dockwatch_role_docker_user

# Type: string
dockwatch_role_docker_user:

dockwatch_role_docker_userns_mode

# Type: string
dockwatch_role_docker_userns_mode:

Networking

dockwatch_role_docker_dns_opts

# Type: list
dockwatch_role_docker_dns_opts:

dockwatch_role_docker_dns_search_domains

# Type: list
dockwatch_role_docker_dns_search_domains:

dockwatch_role_docker_dns_servers

# Type: list
dockwatch_role_docker_dns_servers:

dockwatch_role_docker_domainname

# Type: string
dockwatch_role_docker_domainname:

dockwatch_role_docker_exposed_ports

# Type: list
dockwatch_role_docker_exposed_ports:

dockwatch_role_docker_hosts

# Type: dict
dockwatch_role_docker_hosts:

dockwatch_role_docker_hosts_use_common

# Type: bool (true/false)
dockwatch_role_docker_hosts_use_common:

dockwatch_role_docker_ipc_mode

# Type: string
dockwatch_role_docker_ipc_mode:

dockwatch_role_docker_links

# Type: list
dockwatch_role_docker_links:

dockwatch_role_docker_network_mode

# Type: string
dockwatch_role_docker_network_mode:

dockwatch_role_docker_pid_mode

# Type: string
dockwatch_role_docker_pid_mode:

dockwatch_role_docker_ports

# Type: list
dockwatch_role_docker_ports:

dockwatch_role_docker_uts

# Type: string
dockwatch_role_docker_uts:

Storage

dockwatch_role_docker_keep_volumes

# Type: bool (true/false)
dockwatch_role_docker_keep_volumes:

dockwatch_role_docker_mounts

# Type: list
dockwatch_role_docker_mounts:

dockwatch_role_docker_storage_opts

# Type: dict
dockwatch_role_docker_storage_opts:

dockwatch_role_docker_tmpfs

# Type: list
dockwatch_role_docker_tmpfs:

dockwatch_role_docker_volume_driver

# Type: string
dockwatch_role_docker_volume_driver:

dockwatch_role_docker_volumes_from

# Type: list
dockwatch_role_docker_volumes_from:

dockwatch_role_docker_volumes_global

# Type: bool (true/false)
dockwatch_role_docker_volumes_global:

dockwatch_role_docker_working_dir

# Type: string
dockwatch_role_docker_working_dir:

Monitoring & Lifecycle

dockwatch_role_docker_auto_remove

# Type: bool (true/false)
dockwatch_role_docker_auto_remove:

dockwatch_role_docker_cleanup

# Type: bool (true/false)
dockwatch_role_docker_cleanup:

dockwatch_role_docker_force_kill

# Type: string
dockwatch_role_docker_force_kill:

dockwatch_role_docker_healthcheck

# Type: dict
dockwatch_role_docker_healthcheck:

dockwatch_role_docker_healthy_wait_timeout

# Type: int
dockwatch_role_docker_healthy_wait_timeout:

dockwatch_role_docker_init

# Type: bool (true/false)
dockwatch_role_docker_init:

dockwatch_role_docker_kill_signal

# Type: string
dockwatch_role_docker_kill_signal:

dockwatch_role_docker_log_driver

# Type: string
dockwatch_role_docker_log_driver:

dockwatch_role_docker_log_options

# Type: dict
dockwatch_role_docker_log_options:

dockwatch_role_docker_oom_killer

# Type: bool (true/false)
dockwatch_role_docker_oom_killer:

dockwatch_role_docker_oom_score_adj

# Type: int
dockwatch_role_docker_oom_score_adj:

dockwatch_role_docker_output_logs

# Type: bool (true/false)
dockwatch_role_docker_output_logs:

dockwatch_role_docker_paused

# Type: bool (true/false)
dockwatch_role_docker_paused:

dockwatch_role_docker_recreate

# Type: bool (true/false)
dockwatch_role_docker_recreate:

dockwatch_role_docker_restart_retries

# Type: int
dockwatch_role_docker_restart_retries:

dockwatch_role_docker_stop_timeout

# Type: int
dockwatch_role_docker_stop_timeout:

Other Options

dockwatch_role_docker_capabilities

# Type: list
dockwatch_role_docker_capabilities:

dockwatch_role_docker_cgroup_parent

# Type: string
dockwatch_role_docker_cgroup_parent:

dockwatch_role_docker_commands

# Type: list
dockwatch_role_docker_commands:

dockwatch_role_docker_create_timeout

# Type: int
dockwatch_role_docker_create_timeout:

dockwatch_role_docker_entrypoint

# Type: string
dockwatch_role_docker_entrypoint:

dockwatch_role_docker_env_file

# Type: string
dockwatch_role_docker_env_file:

dockwatch_role_docker_labels

# Type: dict
dockwatch_role_docker_labels:

dockwatch_role_docker_labels_use_common

# Type: bool (true/false)
dockwatch_role_docker_labels_use_common:

dockwatch_role_docker_read_only

# Type: bool (true/false)
dockwatch_role_docker_read_only:

dockwatch_role_docker_runtime

# Type: string
dockwatch_role_docker_runtime:

dockwatch_role_docker_sysctls

# Type: list
dockwatch_role_docker_sysctls:

dockwatch_role_docker_ulimits

# Type: list
dockwatch_role_docker_ulimits:

dockwatch_role_autoheal_enabled

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

dockwatch_role_depends_on

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

dockwatch_role_depends_on_delay

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

dockwatch_role_depends_on_healthchecks

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

dockwatch_role_diun_enabled

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

dockwatch_role_dns_enabled

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

dockwatch_role_docker_controller

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

dockwatch_role_docker_image_repo

# Type: string
dockwatch_role_docker_image_repo:

dockwatch_role_docker_image_tag

# Type: string
dockwatch_role_docker_image_tag:

dockwatch_role_docker_volumes_download

# Type: bool (true/false)
dockwatch_role_docker_volumes_download:

dockwatch_role_paths_location

# Type: string
dockwatch_role_paths_location:

dockwatch_role_post_enable

# Type: string
dockwatch_role_post_enable:

dockwatch_role_themepark_addons

# Type: string
dockwatch_role_themepark_addons:

dockwatch_role_themepark_app

# Type: string
dockwatch_role_themepark_app:

dockwatch_role_themepark_theme

# Type: string
dockwatch_role_themepark_theme:

dockwatch_role_traefik_api_endpoint

# Type: dict/omit
dockwatch_role_traefik_api_endpoint:

dockwatch_role_traefik_api_middleware

# Type: string
dockwatch_role_traefik_api_middleware:

dockwatch_role_traefik_api_middleware_http

# Type: string
dockwatch_role_traefik_api_middleware_http:

dockwatch_role_traefik_autodetect_enabled

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

dockwatch_role_traefik_certresolver

# Type: string
dockwatch_role_traefik_certresolver:

dockwatch_role_traefik_crowdsec_enabled

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

dockwatch_role_traefik_error_pages_enabled

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

dockwatch_role_traefik_gzip_enabled

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

dockwatch_role_traefik_middleware_http

# Type: string
dockwatch_role_traefik_middleware_http:

dockwatch_role_traefik_middleware_http_api_insecure

# Type: bool (true/false)
dockwatch_role_traefik_middleware_http_api_insecure:

dockwatch_role_traefik_middleware_http_insecure

# Type: bool (true/false)
dockwatch_role_traefik_middleware_http_insecure:

dockwatch_role_traefik_priority

# Type: string
dockwatch_role_traefik_priority:

dockwatch_role_traefik_robot_enabled

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

dockwatch_role_traefik_tailscale_enabled

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

dockwatch_role_traefik_wildcard_enabled

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

dockwatch_role_web_domain

# Type: string
dockwatch_role_web_domain:

dockwatch_role_web_fqdn_override

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

Example Override

dockwatch_role_web_fqdn_override:
  - "{{ traefik_host }}"
  - "dockwatch2.{{ user.domain }}"
  - "dockwatch.otherdomain.tld"

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

dockwatch_role_web_host_override

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

Example Override

dockwatch_role_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'dockwatch2.' + user.domain }}`)"

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

dockwatch_role_web_http_port

# Type: string (quoted number)
dockwatch_role_web_http_port:

dockwatch_role_web_http_scheme

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

dockwatch_role_web_http_serverstransport

# Type: dict/omit
dockwatch_role_web_http_serverstransport:

dockwatch_role_web_scheme

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

dockwatch_role_web_serverstransport

# Type: dict/omit
dockwatch_role_web_serverstransport:

dockwatch_role_web_subdomain

# Type: string
dockwatch_role_web_subdomain: