Skip to content

环境变量 ​

每个选项都可以通过标志或环境变量设置。标志和环境变量的优先级始终高于设置向导保存在 dozzle.yml 中的设置。

接受列表的选项(DOZZLE_FILTER、DOZZLE_REMOTE_HOST、DOZZLE_REMOTE_AGENT、DOZZLE_NAMESPACE)在环境变量中使用逗号分隔的值,或者每一项重复一次标志:

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

服务器 ​

变量说明取值默认值
DOZZLE_ADDR
--addr
Web 服务器监听的地址和端口。在容器内很少需要设置。host:port,例如 :9090:8080
DOZZLE_BASE
--base
提供 Dozzle 服务的路径前缀。参见修改基础路径。路径,例如 /logs/
DOZZLE_HOSTNAME
--hostname
此实例在界面中显示的名称。参见主机名。任意字符串无
DOZZLE_HOST_ID
--host-id
覆盖 Dozzle 为此主机推导出的 id。只有在与其他主机冲突时才需要设置。字母、数字、_、.、-自动推导
DOZZLE_LEVEL
--level
Dozzle 自身的日志级别。参见调试。trace、debug、info、warn、errorinfo
DOZZLE_MODE
--mode
部署模式。server、swarm、k8sserver
DOZZLE_TIMEOUT
--timeout
调用 Docker 或 Kubernetes API 的超时时间。时长,例如 30s10s
DOZZLE_NO_ANALYTICS
--no-analytics
关闭匿名数据分析。true、falsefalse

容器与主机 ​

变量说明取值默认值
DOZZLE_FILTER
--filter
只显示匹配 Docker 过滤条件的容器。参见过滤器。key=value,例如 label=app=web无
DOZZLE_REMOTE_AGENT
--remote-agent
要连接的代理,可选附带显示名称和分组。host:port[|name[|group]]无
DOZZLE_REMOTE_HOST
--remote-host
通过 TCP 连接的 Docker 主机。参见远程主机。tcp://host:port[|label]无
DOZZLE_NAMESPACE
--namespace
要监听的 Kubernetes 命名空间。仅在 DOZZLE_MODE=k8s 时使用。命名空间名称全部
DOZZLE_CERT
--cert
与代理通信时使用的 TLS 证书。参见自定义证书。文件路径dozzle_cert.pem
DOZZLE_KEY
--key
与代理通信时使用的 TLS 私钥。文件路径dozzle_key.pem

功能 ​

变量说明取值默认值
DOZZLE_ENABLE_ACTIONS
--enable-actions
允许在界面中启动、停止、重启、删除和更新容器。参见容器操作。true、falsefalse
DOZZLE_ENABLE_SHELL
--enable-shell
允许在界面中附加到容器或在容器内运行 shell。参见 shell。true、falsefalse
DOZZLE_ENABLE_MCP
--enable-mcp
为 LLM 客户端开放 MCP 端点。true、falsefalse
DOZZLE_DISABLE_AVATARS
--disable-avatars
启用身份验证时隐藏用户头像。true、falsefalse
DOZZLE_RELEASE_CHECK_MODE
--release-check-mode
Dozzle 是否检查自身的新版本。manual 只在你主动要求时检查。automatic、manualautomatic
DOZZLE_IMAGE_CHECK_MODE
--image-check-mode
Dozzle 是否到镜像仓库检查更新的容器镜像。参见更新检查。automatic、manual、off与 DOZZLE_RELEASE_CHECK_MODE 相同
DOZZLE_AUTO_UPDATE
--auto-update
按计划更新 Dozzle 自身的容器。weekly 在周日运行。需要开启 DOZZLE_ENABLE_ACTIONS。off、daily、weeklyoff
DOZZLE_AUTO_UPDATE_TIME
--auto-update-time
每天运行自动更新的时间,按服务器本地时间计算。HH:MM,例如 04:3003:00

身份验证 ​

各个提供方的工作方式请参见身份验证。

变量说明取值默认值
DOZZLE_AUTH_PROVIDER
--auth-provider
使用哪个身份验证提供方。github 和 google 是 simple 的别名。none、simple、oidc、forward-proxynone
DOZZLE_AUTH_TTL
--auth-ttl
登录的有效时长。session 表示关闭浏览器时登出。session 或时长,例如 48h(单位 s、m、h)session
DOZZLE_AUTH_LOGOUT_URL
--auth-logout-url
使用 forward-proxy 时,登出后将用户跳转到的地址。使用 oidc 时,它会覆盖 issuer 的登出端点。URL无

GitHub OAuth ​

为 simple 身份验证加上“使用 GitHub 登录”。参见 OAuth。

变量说明取值默认值
DOZZLE_AUTH_GITHUB_CLIENT_ID
--auth-github-client-id
GitHub OAuth 应用的 client id。字符串无
DOZZLE_AUTH_GITHUB_CLIENT_SECRET
--auth-github-client-secret
GitHub OAuth 应用的 client secret。字符串无

OpenID Connect ​

与 DOZZLE_AUTH_PROVIDER=oidc 一起使用。参见 OIDC。

变量说明取值默认值
DOZZLE_AUTH_OIDC_ISSUER
--auth-oidc-issuer
身份提供方的 issuer URL。URL无
DOZZLE_AUTH_OIDC_CLIENT_ID
--auth-oidc-client-id
在提供方处注册的 client id。字符串无
DOZZLE_AUTH_OIDC_CLIENT_SECRET
--auth-oidc-client-secret
在提供方处注册的 client secret。字符串无
DOZZLE_AUTH_OIDC_NAME
--auth-oidc-name
登录按钮上的文字。任意字符串SSO
DOZZLE_AUTH_OIDC_ROLES_CLAIM
--auth-oidc-roles-claim
读取角色的 claim。只有当默认搜索(dozzle_roles、resource_access.<client-id>.roles、roles)找不到时才需要设置。以点分隔的 claim 路径无
DOZZLE_AUTH_OIDC_FILTERS_CLAIM
--auth-oidc-filters-claim
读取容器过滤条件的 claim。只有当默认搜索(dozzle_filters、resource_access.<client-id>.filters、filters)找不到时才需要设置。以点分隔的 claim 路径无
DOZZLE_AUTH_OIDC_SCOPES
--auth-oidc-scopes
在 openid、profile 和 email 之外额外请求的 scope,用于那些只有在请求了对应 scope 时才会给出 claim 的提供方。以逗号分隔的 scope无

TIP

DOZZLE_AUTH_GITHUB_CLIENT_SECRET 和 DOZZLE_AUTH_OIDC_CLIENT_SECRET 还接受一个 _FILE 形式的对应变量,用来指明从哪个文件读取这个值,方便配合 Docker secrets 使用。

Forward Proxy ​

与 DOZZLE_AUTH_PROVIDER=forward-proxy 一起使用。每个变量指定代理设置的 HTTP 头名称。参见 Forward Proxy。

变量说明取值默认值
DOZZLE_AUTH_HEADER_USER
--auth-header-user
携带用户名的请求头。请求头名称Remote-User
DOZZLE_AUTH_HEADER_EMAIL
--auth-header-email
携带邮箱的请求头。请求头名称Remote-Email
DOZZLE_AUTH_HEADER_NAME
--auth-header-name
携带显示名称的请求头。请求头名称Remote-Name
DOZZLE_AUTH_HEADER_FILTER
--auth-header-filter
携带用户容器过滤条件的请求头。请求头名称Remote-Filter
DOZZLE_AUTH_HEADER_ROLES
--auth-header-roles
携带用户角色的请求头。请求头名称Remote-Roles

子命令 ​

generate ​

为 simple 身份验证生成一条 users.yml 条目。第一个参数是用户名。

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
标志说明取值
--password, -p用户的密码。字符串
--email, -e用户的邮箱,用于显示头像。邮箱地址
--name, -n用户的显示名称。字符串
--user-filter用户可以看到的容器。以逗号分隔的 key=value 过滤条件
--user-roles用户可以执行的操作。在角色前加 ^ 表示移除该角色,例如 all,^shell。all、none、shell、actions、download、notifications、cloud

agent ​

将 Dozzle 作为代理运行,供另一个 Dozzle 实例连接。

sh
docker run -v /var/run/docker.sock:/var/run/docker.sock -p 7007:7007 amir20/dozzle agent
变量说明取值默认值
DOZZLE_AGENT_ADDR
--agent-addr
代理监听的地址和端口。host:port:7007

generate-certs ​

为代理连接生成唯一的证书和私钥,替代 Dozzle 自带的共享证书。参见自定义证书。

标志说明默认值
--cert-out证书的写入位置。dozzle_cert.pem
--key-out私钥的写入位置。dozzle_key.pem
--force覆盖已有文件。false

healthcheck ​

检查服务器或代理是否正常运行。由于会带来少量额外的 CPU 开销,镜像默认没有配置它。参见健康检查。

基于 MIT 许可证发布。开源项目,由 Docker OSS 赞助。