Skip to content

Global Environment Variables

Configurations can be done with flags or environment variables. The table below outlines all supported options and their respective env vars.

FlagEnv VariableDefault
--addrDOZZLE_ADDR:8080
--baseDOZZLE_BASE/
--hostnameDOZZLE_HOSTNAME""
--levelDOZZLE_LEVELinfo
--auth-providerDOZZLE_AUTH_PROVIDERnone
--auth-header-userDOZZLE_AUTH_HEADER_USERRemote-User
--auth-header-emailDOZZLE_AUTH_HEADER_EMAILRemote-Email
--auth-header-nameDOZZLE_AUTH_HEADER_NAMERemote-Name
--enable-actionsDOZZLE_ENABLE_ACTIONSfalse
--filterDOZZLE_FILTER""
--no-analyticsDOZZLE_NO_ANALYTICSfalse
--modeDOZZLE_MODEserver
--remote-hostDOZZLE_REMOTE_HOST
--remote-agentDOZZLE_REMOTE_AGENT
--timeoutDOZZLE_TIMEOUT3s

Repeated Flags

Some flags like --remote-host or --remote-agent can be used multiple times. For example, --remote-agent tcp://167.99.1.1:7007 --remote-agent tcp://167.99.1.2:7007 or comma separated DOZZLE_REMOTE_AGENT=tcp://167.99.1.1:7007,tcp://167.99.1.2:7007.

Generate users.yml

Dozzle supports generating users.yml file. This file is used to authenticate users. Here is an example:

sh
docker run amir20/dozzle generate admin --password password --email test@email.net --name "John Doe" > users.yml

In this example, admin is the username. Email and name are optional but recommended to display accurate avatars. docker run amir20/dozzle generate --help displays all options.

FlagDescriptionDefault
--passwordUser's password
--emailUser's email
--nameUser's full name

See authentication for more information.

Agent Mode

Dozzle supports running in agent mode. Agent mode is useful when running Dozzle on a remote host and you want to monitor a different Docker host. Agent mode is enabled by setting the --remote-agent flag. Here is an example:

sh
docker run --volume=/var/run/docker.sock:/var/run/docker.sock -p 8080:8080 amir20/dozzle --remote-agent remote-ip:7007
FlagEnv VariableDefault
--addrDOZZLE_AGENT_ADDR:7007

See agent for more information.

Healthcheck

Dozzle supports healthcheck using dozzle healthcheck command. It is not enabled by default as it adds extra CPU usage. To use healthcheck you need to configure it.

See healthcheck for more information.

Released under the MIT License. Open sourced and sponsored by Docker OSS.