Skip to content

Environment Variables ​

Every option can be set with a flag or with an environment variable. Flags and environment variables always win over settings saved by the setup wizard in dozzle.yml.

Options that take a list (DOZZLE_FILTER, DOZZLE_REMOTE_HOST, DOZZLE_REMOTE_AGENT, DOZZLE_NAMESPACE) accept a comma-separated value in the environment variable, or the flag repeated once per item:

sh
--remote-agent 167.99.1.1:7007 --remote-agent 167.99.1.2:7007
DOZZLE_REMOTE_AGENT=167.99.1.1:7007,167.99.1.2:7007

Server ​

VariableDescriptionValuesDefault
DOZZLE_ADDR
--addr
Address and port the web server listens on. Rarely needed inside a container.host:port, e.g. :9090:8080
DOZZLE_BASE
--base
Path prefix to serve Dozzle under. See changing base.a path, e.g. /logs/
DOZZLE_HOSTNAME
--hostname
Name shown in the UI for this instance. See hostname.any stringnone
DOZZLE_HOST_ID
--host-id
Overrides the id Dozzle derives for this host. Only needed when it collides with another host.letters, digits, _, ., -derived
DOZZLE_LEVEL
--level
Dozzle's own log level. See debugging.trace, debug, info, warn, errorinfo
DOZZLE_MODE
--mode
Deployment mode.server, swarm, k8sserver
DOZZLE_TIMEOUT
--timeout
Timeout for calls to the Docker or Kubernetes API.a duration, e.g. 30s10s
DOZZLE_NO_ANALYTICS
--no-analytics
Turns off anonymous analytics.true, falsefalse

Containers and Hosts ​

VariableDescriptionValuesDefault
DOZZLE_FILTER
--filter
Only shows containers matching a Docker filter. See filters.key=value, e.g. label=app=webnone
DOZZLE_REMOTE_AGENT
--remote-agent
Agents to connect to, with an optional display name and group.host:port[|name[|group]]none
DOZZLE_REMOTE_HOST
--remote-host
Docker hosts to connect to over TCP. See remote hosts.tcp://host:port[|label]none
DOZZLE_NAMESPACE
--namespace
Kubernetes namespaces to watch. Only used with DOZZLE_MODE=k8s.namespace namesall
DOZZLE_CERT
--cert
TLS certificate used to talk to agents. See custom certificates.a file pathdozzle_cert.pem
DOZZLE_KEY
--key
TLS private key used to talk to agents.a file pathdozzle_key.pem

Features ​

VariableDescriptionValuesDefault
DOZZLE_ENABLE_ACTIONS
--enable-actions
Allows starting, stopping, restarting, removing and updating containers from the UI. See actions.true, falsefalse
DOZZLE_ENABLE_SHELL
--enable-shell
Allows attaching to and running a shell in containers from the UI. See shell.true, falsefalse
DOZZLE_ENABLE_MCP
--enable-mcp
Exposes the MCP endpoint for LLM clients.true, falsefalse
DOZZLE_DISABLE_AVATARS
--disable-avatars
Hides user avatars when authentication is on.true, falsefalse
DOZZLE_RELEASE_CHECK_MODE
--release-check-mode
Whether Dozzle checks for its own new releases. manual only checks when you ask.automatic, manualautomatic
DOZZLE_IMAGE_CHECK_MODE
--image-check-mode
Whether Dozzle checks registries for newer container images. See update checking.automatic, manual, offsame as DOZZLE_RELEASE_CHECK_MODE
DOZZLE_AUTO_UPDATE
--auto-update
Updates Dozzle's own container on a schedule. weekly runs on Sunday. Requires DOZZLE_ENABLE_ACTIONS.off, daily, weeklyoff
DOZZLE_AUTO_UPDATE_TIME
--auto-update-time
Time of day the auto update runs, in the server's local time.HH:MM, e.g. 04:3003:00

Authentication ​

See authentication for how the providers work.

VariableDescriptionValuesDefault
DOZZLE_AUTH_PROVIDER
--auth-provider
Which authentication provider to use. github and google are aliases for simple.none, simple, oidc, forward-proxynone
DOZZLE_AUTH_TTL
--auth-ttl
How long a login lasts. session logs out when the browser closes.session or a duration, e.g. 48h (units s, m, h)session
DOZZLE_AUTH_LOGOUT_URL
--auth-logout-url
Where to send the user on logout with forward-proxy. With oidc it overrides the issuer's logout endpoint.a URLnone

GitHub OAuth ​

Adds "Sign in with GitHub" to simple auth. See OAuth.

VariableDescriptionValuesDefault
DOZZLE_AUTH_GITHUB_CLIENT_ID
--auth-github-client-id
Client id of the GitHub OAuth app.a stringnone
DOZZLE_AUTH_GITHUB_CLIENT_SECRET
--auth-github-client-secret
Client secret of the GitHub OAuth app.a stringnone

OpenID Connect ​

Used with DOZZLE_AUTH_PROVIDER=oidc. See OIDC.

VariableDescriptionValuesDefault
DOZZLE_AUTH_OIDC_ISSUER
--auth-oidc-issuer
Issuer URL of the identity provider.a URLnone
DOZZLE_AUTH_OIDC_CLIENT_ID
--auth-oidc-client-id
Client id registered with the provider.a stringnone
DOZZLE_AUTH_OIDC_CLIENT_SECRET
--auth-oidc-client-secret
Client secret registered with the provider.a stringnone
DOZZLE_AUTH_OIDC_NAME
--auth-oidc-name
Label on the login button.any stringSSO
DOZZLE_AUTH_OIDC_ROLES_CLAIM
--auth-oidc-roles-claim
Claim to read roles from. Only needed when the default search (dozzle_roles, resource_access.<client-id>.roles, roles) misses it.a dot-separated claim pathnone
DOZZLE_AUTH_OIDC_FILTERS_CLAIM
--auth-oidc-filters-claim
Claim to read container filters from. Only needed when the default search (dozzle_filters, resource_access.<client-id>.filters, filters) misses it.a dot-separated claim pathnone
DOZZLE_AUTH_OIDC_SCOPES
--auth-oidc-scopes
Extra scopes to request on top of openid, profile and email, for providers that only release a claim when its scope is asked for.comma-separated scopesnone

TIP

DOZZLE_AUTH_GITHUB_CLIENT_SECRET and DOZZLE_AUTH_OIDC_CLIENT_SECRET also accept a _FILE counterpart naming a file to read the value from, for use with Docker secrets.

Forward Proxy ​

Used with DOZZLE_AUTH_PROVIDER=forward-proxy. Each variable names the HTTP header the proxy sets. See forward proxy.

VariableDescriptionValuesDefault
DOZZLE_AUTH_HEADER_USER
--auth-header-user
Header carrying the username.a header nameRemote-User
DOZZLE_AUTH_HEADER_EMAIL
--auth-header-email
Header carrying the email.a header nameRemote-Email
DOZZLE_AUTH_HEADER_NAME
--auth-header-name
Header carrying the display name.a header nameRemote-Name
DOZZLE_AUTH_HEADER_FILTER
--auth-header-filter
Header carrying the user's container filter.a header nameRemote-Filter
DOZZLE_AUTH_HEADER_ROLES
--auth-header-roles
Header carrying the user's roles.a header nameRemote-Roles

Subcommands ​

generate ​

Generates a users.yml entry for simple authentication. The username is the first argument.

sh
docker run -it --rm amir20/dozzle generate admin --password password --email test@email.net --name "John Doe" --user-filter name=foo --user-roles shell > users.yml
FlagDescriptionValues
--password, -pThe user's password.a string
--email, -eThe user's email, used for the avatar.an email
--name, -nThe user's display name.a string
--user-filterContainers the user can see.comma-separated key=value filters
--user-rolesWhat the user can do. Prefix a role with ^ to remove it, e.g. all,^shell.all, none, shell, actions, download, notifications, cloud

agent ​

Runs Dozzle as an agent that another Dozzle instance connects to.

sh
docker run -v /var/run/docker.sock:/var/run/docker.sock -p 7007:7007 amir20/dozzle agent
VariableDescriptionValuesDefault
DOZZLE_AGENT_ADDR
--agent-addr
Address and port the agent listens on.host:port:7007

generate-certs ​

Generates a unique certificate and key for agent connections, in place of the shared one bundled with Dozzle. See custom certificates.

FlagDescriptionDefault
--cert-outWhere to write the certificate.dozzle_cert.pem
--key-outWhere to write the private key.dozzle_key.pem
--forceOverwrites existing files.false

healthcheck ​

Checks that the server or agent is up. It is not wired into the image by default because it adds a little CPU overhead. See healthcheck.

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