Dozzle

Description / name	Input element
Your domain name

Overview

Dozzle is a small lightweight application with a web based interface to monitor Docker logs. It doesn’t store any log files. It is for live monitoring of your container logs only. Dozzle can only access logs written to stdout or stderr which is the same functionality as the docker logs command. See below for more info on that.

Manual

Releases

Community

---

Deployment

sb install dozzle

Usage

Visit https://dozzle.iYOUR_DOMAIN_NAMEi.

Basics

To view log files that are NOT written to stdout or stderr, use the following to setup a basic Alpine Linux container via Docker Compose that just tails a mounted log file (in this case, Cloudplow) which then exposes it to Dozzle. Adjust as needed for your circumstances.

  tail-cloudplow: # (1)!
    container_name: tail-cloudplow # (2)!
    image: alpine
    volumes:
      - /opt/cloudplow/cloudplow.log:/opt/cloudplow/cloudplow.log:ro # (3)!
    command:
      - tail
      - -F
      - /opt/cloudplow/cloudplow.log # (4)!
    network_mode: none
    restart: unless-stopped
    user: 1000:1000 # (5)!

1. You can pick any name for the container, but it is recommended to pick a memorable name that you will recognize in the Dozzle menu.
2. You can pick any name for the container, but it is recommended to pick a memorable name that you will recognize in the Dozzle menu.
3. The volume mount for the log file. This takes the format of /host/path/to.log:/container/path/to.log:ro. The :ro suffix is optional but recommended to give this container only read-only access to the log file.
4. The path inside of the container where the log file is accessible. This must be the same in the volumes section above and this command section. Matching the annotation example, this would be /container/path/to.log.
5. Provide your uid:gid if they are different. You can check these values by running the id command.

Note

To get the container running, follow our docs on starting a docker container here; Your Own Containers.

Adding Additional Hosts

You can add additional hosts to Dozzle using the dozzle_additional_hosts inventory variable. This will append the additional host(s) to the default entry. You can review the upstream documentation here for the proper syntax. The initiai , will be added after the default entry, you must comma separate the hosts if you are adding multiple entries such as:

dozzle_additional_hosts: "tcp://otherserver:2375|otherserver,tcp://thirdserver:2375|thirdserver"

Role Defaults

Use the Inventory to customize variables. (1)

1. Example override

   dozzle_name: "custom_value"
   

   Avoid overriding variables ending in _default

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

BasicsDocker Socket ProxySettingsWebDNSTraefikThemeDockerDocker+Global Override Options

dozzle_name

# Type: string
dozzle_name: dozzle

dozzle_docker_socket_proxy_envs

# Type: dict
dozzle_docker_socket_proxy_envs:
  CONTAINERS: "1"
  INFO: "1"

dozzle_role_additional_hosts

# Type: string
dozzle_role_additional_hosts: ""

dozzle_role_agent_hosts

# Type: string
dozzle_role_agent_hosts: ""

dozzle_role_agent_mode

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

dozzle_role_web_subdomain

# Type: string
dozzle_role_web_subdomain: "{{ dozzle_name }}"

dozzle_role_web_domain

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

dozzle_role_web_port

# Type: string
dozzle_role_web_port: "8080"

dozzle_role_web_url

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

dozzle_role_dns_record

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

dozzle_role_dns_zone

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

dozzle_role_dns_proxy

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

dozzle_role_traefik_sso_middleware

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

dozzle_role_traefik_middleware_default

# Type: string
dozzle_role_traefik_middleware_default: "{{ traefik_default_middleware
                                            + (',dropsecurityheaders@file,themepark-' + dozzle_name
                                              if (lookup('role_var', '_themepark_enabled', role='dozzle') and global_themepark_plugin_enabled)
                                              else '') }}"

dozzle_role_traefik_middleware_custom

# Type: string
dozzle_role_traefik_middleware_custom: ""

dozzle_role_traefik_certresolver

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

dozzle_role_traefik_enabled

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

dozzle_role_traefik_api_enabled

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

dozzle_role_traefik_api_endpoint

# Type: string
dozzle_role_traefik_api_endpoint: ""

dozzle_role_themepark_enabled

# Options can be found at https://github.com/themepark-dev/theme.park
# Type: bool (true/false)
dozzle_role_themepark_enabled: false

dozzle_role_themepark_app

# Type: string
dozzle_role_themepark_app: "dozzle"

dozzle_role_themepark_theme

# Type: string
dozzle_role_themepark_theme: "{{ global_themepark_theme }}"

dozzle_role_themepark_domain

# Type: string
dozzle_role_themepark_domain: "{{ global_themepark_domain }}"

dozzle_role_themepark_addons

# Type: list
dozzle_role_themepark_addons: []

Container

dozzle_role_docker_container

# Type: string
dozzle_role_docker_container: "{{ dozzle_name }}"

Image

dozzle_role_docker_image_pull

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

dozzle_role_docker_image_repo

# Type: string
dozzle_role_docker_image_repo: "amir20/dozzle"

dozzle_role_docker_image_tag

# Type: string
dozzle_role_docker_image_tag: "latest"

dozzle_role_docker_image

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

Envs

dozzle_role_docker_envs_default

# Type: dict
dozzle_role_docker_envs_default:
  DOZZLE_AUTH_PROVIDER: "{{ 'forward-proxy' if (lookup('role_var', '_traefik_sso_middleware', role='dozzle') | length > 0) else omit }}"
  DOZZLE_REMOTE_AGENT: "{{ lookup('role_var', '_agent_hosts', role='dozzle') if (lookup('role_var', '_additional_hosts', role='dozzle') | length > 0) else omit }}"
  DOZZLE_REMOTE_HOST: "{{ 'tcp://' + dozzle_name + '-docker-socket-proxy:2375|' + traefik_host + ',' + lookup('role_var', '_additional_hosts', role='dozzle')
                       if (lookup('role_var', '_additional_hosts', role='dozzle') | length > 0)
                       else 'tcp://' + dozzle_name + '-docker-socket-proxy:2375|' + traefik_host }}"
  DOZZLE_AUTH_HEADER_USER: "{{ 'X-authentik-username' if 'authentik' in lookup('role_var', '_traefik_sso_middleware', role='dozzle') else omit }}"
  DOZZLE_AUTH_HEADER_EMAIL: "{{ 'X-authentik-email' if 'authentik' in lookup('role_var', '_traefik_sso_middleware', role='dozzle') else omit }}"
  DOZZLE_AUTH_HEADER_NAME: "{{ 'X-authentik-name' if 'authentik' in lookup('role_var', '_traefik_sso_middleware', role='dozzle') else omit }}"

dozzle_role_docker_envs_custom

# Type: dict
dozzle_role_docker_envs_custom: {}

Commands

dozzle_role_docker_commands_agent

# Type: string
dozzle_role_docker_commands_agent: "agent"

dozzle_role_docker_commands_default

# Type: list
dozzle_role_docker_commands_default: []

dozzle_role_docker_commands_custom

# Type: list
dozzle_role_docker_commands_custom: []

Labels

dozzle_role_docker_labels_default

# Type: dict
dozzle_role_docker_labels_default: {}

dozzle_role_docker_labels_custom

# Type: dict
dozzle_role_docker_labels_custom: {}

Hostname

dozzle_role_docker_hostname

# Type: string
dozzle_role_docker_hostname: "{{ dozzle_name }}"

Networks

dozzle_role_docker_networks_alias

# Type: string
dozzle_role_docker_networks_alias: "{{ dozzle_name }}"

dozzle_role_docker_networks_default

# Type: list
dozzle_role_docker_networks_default: []

dozzle_role_docker_networks_custom

# Type: list
dozzle_role_docker_networks_custom: []

Restart Policy

dozzle_role_docker_restart_policy

# Type: string
dozzle_role_docker_restart_policy: unless-stopped

State

dozzle_role_docker_state

# Type: string
dozzle_role_docker_state: started

Dependencies

dozzle_role_depends_on

# Type: string
dozzle_role_depends_on: "{{ dozzle_name }}-docker-socket-proxy"

dozzle_role_depends_on_delay

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

dozzle_role_depends_on_healthchecks

# Type: string ("true"/"false")
dozzle_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

dozzle_role_docker_blkio_weight

# Type: int
dozzle_role_docker_blkio_weight:

dozzle_role_docker_cpu_period

# Type: int
dozzle_role_docker_cpu_period:

dozzle_role_docker_cpu_quota

# Type: int
dozzle_role_docker_cpu_quota:

dozzle_role_docker_cpu_shares

# Type: int
dozzle_role_docker_cpu_shares:

dozzle_role_docker_cpus

# Type: string
dozzle_role_docker_cpus:

dozzle_role_docker_cpuset_cpus

# Type: string
dozzle_role_docker_cpuset_cpus:

dozzle_role_docker_cpuset_mems

# Type: string
dozzle_role_docker_cpuset_mems:

dozzle_role_docker_kernel_memory

# Type: string
dozzle_role_docker_kernel_memory:

dozzle_role_docker_memory

# Type: string
dozzle_role_docker_memory:

dozzle_role_docker_memory_reservation

# Type: string
dozzle_role_docker_memory_reservation:

dozzle_role_docker_memory_swap

# Type: string
dozzle_role_docker_memory_swap:

dozzle_role_docker_memory_swappiness

# Type: int
dozzle_role_docker_memory_swappiness:

dozzle_role_docker_shm_size

# Type: string
dozzle_role_docker_shm_size:

Security & Devices

dozzle_role_docker_cap_drop

# Type: list
dozzle_role_docker_cap_drop:

dozzle_role_docker_cgroupns_mode

# Type: string
dozzle_role_docker_cgroupns_mode:

dozzle_role_docker_device_cgroup_rules

# Type: list
dozzle_role_docker_device_cgroup_rules:

dozzle_role_docker_device_read_bps

# Type: list
dozzle_role_docker_device_read_bps:

dozzle_role_docker_device_read_iops

# Type: list
dozzle_role_docker_device_read_iops:

dozzle_role_docker_device_requests

# Type: list
dozzle_role_docker_device_requests:

dozzle_role_docker_device_write_bps

# Type: list
dozzle_role_docker_device_write_bps:

dozzle_role_docker_device_write_iops

# Type: list
dozzle_role_docker_device_write_iops:

dozzle_role_docker_devices

# Type: list
dozzle_role_docker_devices:

dozzle_role_docker_devices_default

# Type: string
dozzle_role_docker_devices_default:

dozzle_role_docker_groups

# Type: list
dozzle_role_docker_groups:

dozzle_role_docker_privileged

# Type: bool (true/false)
dozzle_role_docker_privileged:

dozzle_role_docker_security_opts

# Type: list
dozzle_role_docker_security_opts:

dozzle_role_docker_user

# Type: string
dozzle_role_docker_user:

dozzle_role_docker_userns_mode

# Type: string
dozzle_role_docker_userns_mode:

Networking

dozzle_role_docker_dns_opts

# Type: list
dozzle_role_docker_dns_opts:

dozzle_role_docker_dns_search_domains

# Type: list
dozzle_role_docker_dns_search_domains:

dozzle_role_docker_dns_servers

# Type: list
dozzle_role_docker_dns_servers:

dozzle_role_docker_domainname

# Type: string
dozzle_role_docker_domainname:

dozzle_role_docker_exposed_ports

# Type: list
dozzle_role_docker_exposed_ports:

dozzle_role_docker_hosts

# Type: dict
dozzle_role_docker_hosts:

dozzle_role_docker_hosts_use_common

# Type: bool (true/false)
dozzle_role_docker_hosts_use_common:

dozzle_role_docker_ipc_mode

# Type: string
dozzle_role_docker_ipc_mode:

dozzle_role_docker_links

# Type: list
dozzle_role_docker_links:

dozzle_role_docker_network_mode

# Type: string
dozzle_role_docker_network_mode:

dozzle_role_docker_pid_mode

# Type: string
dozzle_role_docker_pid_mode:

dozzle_role_docker_ports

# Type: list
dozzle_role_docker_ports:

dozzle_role_docker_uts

# Type: string
dozzle_role_docker_uts:

Storage

dozzle_role_docker_keep_volumes

# Type: bool (true/false)
dozzle_role_docker_keep_volumes:

dozzle_role_docker_mounts

# Type: list
dozzle_role_docker_mounts:

dozzle_role_docker_storage_opts

# Type: dict
dozzle_role_docker_storage_opts:

dozzle_role_docker_tmpfs

# Type: list
dozzle_role_docker_tmpfs:

dozzle_role_docker_volume_driver

# Type: string
dozzle_role_docker_volume_driver:

dozzle_role_docker_volumes

# Type: list
dozzle_role_docker_volumes:

dozzle_role_docker_volumes_from

# Type: list
dozzle_role_docker_volumes_from:

dozzle_role_docker_volumes_global

# Type: bool (true/false)
dozzle_role_docker_volumes_global:

dozzle_role_docker_working_dir

# Type: string
dozzle_role_docker_working_dir:

Monitoring & Lifecycle

dozzle_role_docker_auto_remove

# Type: bool (true/false)
dozzle_role_docker_auto_remove:

dozzle_role_docker_cleanup

# Type: bool (true/false)
dozzle_role_docker_cleanup:

dozzle_role_docker_force_kill

# Type: string
dozzle_role_docker_force_kill:

dozzle_role_docker_healthcheck

# Type: dict
dozzle_role_docker_healthcheck:

dozzle_role_docker_healthy_wait_timeout

# Type: int
dozzle_role_docker_healthy_wait_timeout:

dozzle_role_docker_init

# Type: bool (true/false)
dozzle_role_docker_init:

dozzle_role_docker_kill_signal

# Type: string
dozzle_role_docker_kill_signal:

dozzle_role_docker_log_driver

# Type: string
dozzle_role_docker_log_driver:

dozzle_role_docker_log_options

# Type: dict
dozzle_role_docker_log_options:

dozzle_role_docker_oom_killer

# Type: bool (true/false)
dozzle_role_docker_oom_killer:

dozzle_role_docker_oom_score_adj

# Type: int
dozzle_role_docker_oom_score_adj:

dozzle_role_docker_output_logs

# Type: bool (true/false)
dozzle_role_docker_output_logs:

dozzle_role_docker_paused

# Type: bool (true/false)
dozzle_role_docker_paused:

dozzle_role_docker_recreate

# Type: bool (true/false)
dozzle_role_docker_recreate:

dozzle_role_docker_restart_retries

# Type: int
dozzle_role_docker_restart_retries:

dozzle_role_docker_stop_timeout

# Type: int
dozzle_role_docker_stop_timeout:

Other Options

dozzle_role_docker_capabilities

# Type: list
dozzle_role_docker_capabilities:

dozzle_role_docker_cgroup_parent

# Type: string
dozzle_role_docker_cgroup_parent:

dozzle_role_docker_create_timeout

# Type: int
dozzle_role_docker_create_timeout:

dozzle_role_docker_entrypoint

# Type: string
dozzle_role_docker_entrypoint:

dozzle_role_docker_env_file

# Type: string
dozzle_role_docker_env_file:

dozzle_role_docker_labels_use_common

# Type: bool (true/false)
dozzle_role_docker_labels_use_common:

dozzle_role_docker_read_only

# Type: bool (true/false)
dozzle_role_docker_read_only:

dozzle_role_docker_runtime

# Type: string
dozzle_role_docker_runtime:

dozzle_role_docker_sysctls

# Type: list
dozzle_role_docker_sysctls:

dozzle_role_docker_ulimits

# Type: list
dozzle_role_docker_ulimits:

dozzle_role_additional_hosts

# Type: string
dozzle_role_additional_hosts:

dozzle_role_agent_hosts

# Type: string
dozzle_role_agent_hosts:

dozzle_role_autoheal_enabled

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

dozzle_role_depends_on

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

dozzle_role_depends_on_delay

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

dozzle_role_depends_on_healthchecks

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

dozzle_role_diun_enabled

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

dozzle_role_dns_enabled

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

dozzle_role_docker_controller

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

dozzle_role_docker_image_repo

# Type: string
dozzle_role_docker_image_repo:

dozzle_role_docker_image_tag

# Type: string
dozzle_role_docker_image_tag:

dozzle_role_docker_volumes_download

# Type: bool (true/false)
dozzle_role_docker_volumes_download:

dozzle_role_themepark_addons

# Type: string
dozzle_role_themepark_addons:

dozzle_role_themepark_app

# Type: string
dozzle_role_themepark_app:

dozzle_role_themepark_enabled

# Type: bool (true/false)
dozzle_role_themepark_enabled:

dozzle_role_themepark_theme

# Type: string
dozzle_role_themepark_theme:

dozzle_role_traefik_api_endpoint

# Type: dict/omit
dozzle_role_traefik_api_endpoint:

dozzle_role_traefik_api_middleware

# Type: string
dozzle_role_traefik_api_middleware:

dozzle_role_traefik_api_middleware_http

# Type: string
dozzle_role_traefik_api_middleware_http:

dozzle_role_traefik_autodetect_enabled

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

dozzle_role_traefik_certresolver

# Type: string
dozzle_role_traefik_certresolver:

dozzle_role_traefik_crowdsec_enabled

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

dozzle_role_traefik_error_pages_enabled

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

dozzle_role_traefik_gzip_enabled

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

dozzle_role_traefik_middleware_http

# Type: string
dozzle_role_traefik_middleware_http:

dozzle_role_traefik_middleware_http_api_insecure

# Type: bool (true/false)
dozzle_role_traefik_middleware_http_api_insecure:

dozzle_role_traefik_middleware_http_insecure

# Type: bool (true/false)
dozzle_role_traefik_middleware_http_insecure:

dozzle_role_traefik_priority

# Type: string
dozzle_role_traefik_priority:

dozzle_role_traefik_robot_enabled

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

dozzle_role_traefik_sso_middleware

# Type: string
dozzle_role_traefik_sso_middleware:

dozzle_role_traefik_tailscale_enabled

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

dozzle_role_traefik_wildcard_enabled

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

dozzle_role_web_domain

# Type: string
dozzle_role_web_domain:

dozzle_role_web_fqdn_override

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

Example Override

dozzle_role_web_fqdn_override:
  - "{{ traefik_host }}"
  - "dozzle2.{{ user.domain }}"
  - "dozzle.otherdomain.tld"

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

dozzle_role_web_host_override

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

Example Override

dozzle_role_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'dozzle2.' + user.domain }}`)"

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

dozzle_role_web_http_port

# Type: string (quoted number)
dozzle_role_web_http_port:

dozzle_role_web_http_scheme

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

dozzle_role_web_http_serverstransport

# Type: dict/omit
dozzle_role_web_http_serverstransport:

dozzle_role_web_scheme

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

dozzle_role_web_serverstransport

# Type: dict/omit
dozzle_role_web_serverstransport:

dozzle_role_web_subdomain

# Type: string
dozzle_role_web_subdomain: