/usr/bin/dozzle

11.4.2
Usage: dozzle [--addr ADDR] [--base BASE] [--hostname HOSTNAME] [--host-id HOST-ID] [--level LEVEL] [--auth-provider AUTH-PROVIDER] [--auth-ttl AUTH-TTL] [--auth-header-user AUTH-HEADER-USER] [--auth-header-email AUTH-HEADER-EMAIL] [--auth-header-name AUTH-HEADER-NAME] [--auth-header-filter AUTH-HEADER-FILTER] [--auth-header-roles AUTH-HEADER-ROLES] [--auth-logout-url AUTH-LOGOUT-URL] [--auth-github-client-id AUTH-GITHUB-CLIENT-ID] [--auth-github-client-secret AUTH-GITHUB-CLIENT-SECRET] [--auth-oidc-issuer AUTH-OIDC-ISSUER] [--auth-oidc-client-id AUTH-OIDC-CLIENT-ID] [--auth-oidc-client-secret AUTH-OIDC-CLIENT-SECRET] [--auth-oidc-name AUTH-OIDC-NAME] [--auth-oidc-roles-claim AUTH-OIDC-ROLES-CLAIM] [--auth-oidc-filters-claim AUTH-OIDC-FILTERS-CLAIM] [--auth-oidc-scopes AUTH-OIDC-SCOPES] [--enable-actions] [--enable-shell] [--auto-update AUTO-UPDATE] [--auto-update-time AUTO-UPDATE-TIME] [--auto-cleanup AUTO-CLEANUP] [--auto-cleanup-time AUTO-CLEANUP-TIME] [--update-containers UPDATE-CONTAINERS] [--enable-mcp] [--mcp-token MCP-TOKEN] [--disable-avatars] [--disable-setup-wizard] [--filter FILTER] [--release-check-mode RELEASE-CHECK-MODE] [--image-check-mode IMAGE-CHECK-MODE] [--remote-host REMOTE-HOST] [--remote-agent REMOTE-AGENT] [--no-analytics] [--mode MODE] [--timeout TIMEOUT] [--namespace NAMESPACE] [--cert CERT] [--key KEY] <command> [<args>]

Options:
  --addr ADDR            sets host:port to bind for server. This is rarely needed inside a docker container. [default: :8080, env: DOZZLE_ADDR]
  --base BASE            sets the base for http router. [default: /, env: DOZZLE_BASE]
  --hostname HOSTNAME    sets the hostname for display. This is useful with multiple Dozzle instances. [env: DOZZLE_HOSTNAME]
  --host-id HOST-ID      overrides the id Dozzle derives for this host. Only needed when the derived id collides with another host. [env: DOZZLE_HOST_ID]
  --level LEVEL          set Dozzle log level. Use debug for more logging. [default: info, env: DOZZLE_LEVEL]
  --auth-provider AUTH-PROVIDER
                         sets the auth provider to use: none, simple, oidc or forward-proxy. github and google are aliases for simple. [default: none, env: DOZZLE_AUTH_PROVIDER]
  --auth-ttl AUTH-TTL    sets the TTL for the auth token. Accepts duration values like 12h. Valid time units are s, m, h [default: session, env: DOZZLE_AUTH_TTL]
  --auth-header-user AUTH-HEADER-USER
                         sets the HTTP Header to use for username in Forward Proxy configuration. [default: Remote-User, env: DOZZLE_AUTH_HEADER_USER]
  --auth-header-email AUTH-HEADER-EMAIL
                         sets the HTTP Header to use for email in Forward Proxy configuration. [default: Remote-Email, env: DOZZLE_AUTH_HEADER_EMAIL]
  --auth-header-name AUTH-HEADER-NAME
                         sets the HTTP Header to use for name in Forward Proxy configuration. [default: Remote-Name, env: DOZZLE_AUTH_HEADER_NAME]
  --auth-header-filter AUTH-HEADER-FILTER
                         sets the HTTP Header to use for filtering in Forward Proxy configuration. [default: Remote-Filter, env: DOZZLE_AUTH_HEADER_FILTER]
  --auth-header-roles AUTH-HEADER-ROLES
                         sets the HTTP Header to use for roles in Forward Proxy configuration. [default: Remote-Roles, env: DOZZLE_AUTH_HEADER_ROLES]
  --auth-logout-url AUTH-LOGOUT-URL
                         sets the Logout URL used with Forward Proxy. With the oidc auth provider it overrides the issuer's end_session_endpoint and is rarely needed. [env: DOZZLE_AUTH_LOGOUT_URL]
  --auth-github-client-id AUTH-GITHUB-CLIENT-ID
                         sets the GitHub OAuth app client id, enabling Sign in with GitHub for simple auth. [env: DOZZLE_AUTH_GITHUB_CLIENT_ID]
  --auth-github-client-secret AUTH-GITHUB-CLIENT-SECRET
                         sets the GitHub OAuth app client secret. [env: DOZZLE_AUTH_GITHUB_CLIENT_SECRET]
  --auth-oidc-issuer AUTH-OIDC-ISSUER
                         sets the OpenID Connect issuer URL, enabling SSO for simple auth. Works with Google, Keycloak, Pocket ID, Zitadel and Authentik. [env: DOZZLE_AUTH_OIDC_ISSUER]
  --auth-oidc-client-id AUTH-OIDC-CLIENT-ID
                         sets the OpenID Connect client id. [env: DOZZLE_AUTH_OIDC_CLIENT_ID]
  --auth-oidc-client-secret AUTH-OIDC-CLIENT-SECRET
                         sets the OpenID Connect client secret. [env: DOZZLE_AUTH_OIDC_CLIENT_SECRET]
  --auth-oidc-name AUTH-OIDC-NAME
                         sets the label shown on the OpenID Connect login button. [default: SSO, env: DOZZLE_AUTH_OIDC_NAME]
  --auth-oidc-roles-claim AUTH-OIDC-ROLES-CLAIM
                         sets the dot-separated claim path roles are read from with the oidc auth provider, replacing the default search of dozzle_roles, resource_access.<client-id>.roles and roles. [env: DOZZLE_AUTH_OIDC_ROLES_CLAIM]
  --auth-oidc-filters-claim AUTH-OIDC-FILTERS-CLAIM
                         sets the dot-separated claim path container filters are read from with the oidc auth provider, replacing the default search of dozzle_filters, resource_access.<client-id>.filters and filters. [env: DOZZLE_AUTH_OIDC_FILTERS_CLAIM]
  --auth-oidc-scopes AUTH-OIDC-SCOPES
                         sets extra OpenID Connect scopes to request on top of openid, profile and email, separated by commas. Needed when the issuer only releases the roles claim for a custom scope, as Authelia does. [env: DOZZLE_AUTH_OIDC_SCOPES]
  --enable-actions       enables essential actions on containers from the web interface. [default: false, env: DOZZLE_ENABLE_ACTIONS]
  --enable-shell         enables shell access to containers from the web interface. [default: false, env: DOZZLE_ENABLE_SHELL]
  --auto-update AUTO-UPDATE
                         updates Dozzle, and the containers set to update automatically, on a schedule: off, daily or weekly (Sunday). Requires --enable-actions. [env: DOZZLE_AUTO_UPDATE]
  --auto-update-time AUTO-UPDATE-TIME
                         sets the HH:MM, in server local time, that --auto-update runs at. Defaults to 03:00. [env: DOZZLE_AUTO_UPDATE_TIME]
  --auto-cleanup AUTO-CLEANUP
                         deletes unused images, stopped containers and build cache on every host on a schedule: off, daily or weekly (Sunday). Never volumes. Requires --enable-actions. [env: DOZZLE_AUTO_CLEANUP]
  --auto-cleanup-time AUTO-CLEANUP-TIME
                         sets the HH:MM, in server local time, that --auto-cleanup runs at. Defaults to 04:00. [env: DOZZLE_AUTO_CLEANUP_TIME]
  --update-containers UPDATE-CONTAINERS
                         sets which containers --auto-update updates besides Dozzle: off (Dozzle only), labelled (dev.dozzle.update=auto) or all (everything not labelled dev.dozzle.update=off). Defaults to labelled. [env: DOZZLE_UPDATE_CONTAINERS]
  --enable-mcp           enables the MCP (Model Context Protocol) endpoint for LLM integration. [default: false, env: DOZZLE_ENABLE_MCP]
  --mcp-token MCP-TOKEN
                         sets a static Bearer token /api/mcp accepts, for headless clients such as an MCP gateway. At least 32 characters. Works with --auth-provider simple or oidc; the token sees what --filter allows. [env: DOZZLE_MCP_TOKEN]
  --disable-avatars      disables avatars for authenticated users. [default: false, env: DOZZLE_DISABLE_AVATARS]
  --disable-setup-wizard
                         stops the setup wizard from opening by itself on a fresh install. [default: false, env: DOZZLE_DISABLE_SETUP_WIZARD]
  --filter FILTER        filters docker containers using Docker syntax. [env: DOZZLE_FILTER]
  --release-check-mode RELEASE-CHECK-MODE
                         sets the release check mode. When manual, releases will not be automatically fetched. [default: automatic, env: DOZZLE_RELEASE_CHECK_MODE]
  --image-check-mode IMAGE-CHECK-MODE
                         controls checking container registries for newer images (automatic, manual, off). Defaults to --release-check-mode. [env: DOZZLE_IMAGE_CHECK_MODE]
  --remote-host REMOTE-HOST
                         list of hosts to connect remotely [env: DOZZLE_REMOTE_HOST]
  --remote-agent REMOTE-AGENT
                         list of agents to connect remotely [env: DOZZLE_REMOTE_AGENT]
  --no-analytics         disables anonymous analytics [env: DOZZLE_NO_ANALYTICS]
  --mode MODE            sets the mode to run in (server, swarm) [default: server, env: DOZZLE_MODE]
  --timeout TIMEOUT      sets the timeout for docker client [default: 10s, env: DOZZLE_TIMEOUT]
  --namespace NAMESPACE
                         sets the namespace to use in k8s [env: DOZZLE_NAMESPACE]
  --cert CERT            path to custom TLS certificate [default: dozzle_cert.pem, env: DOZZLE_CERT]
  --key KEY              path to custom TLS key [default: dozzle_key.pem, env: DOZZLE_KEY]
  --help, -h             display this help and exit
  --version              display version and exit

Commands:
  healthcheck            checks if the server is running
  generate               generates a configuration file for simple auth
  generate-certs         generates a unique certificate and key for agent connections
  agent                  starts the agent
  agent-test             tests an agent
  self-update            replaces a Dozzle container with one on its newer image (used internally by self-update)