Skip to content

Umgebungsvariablen ​

Jede Option lässt sich über eine Option oder eine Umgebungsvariable setzen. Optionen und Umgebungsvariablen haben immer Vorrang vor Einstellungen, die der Einrichtungsassistent in dozzle.yml gespeichert hat.

Optionen, die eine Liste annehmen (DOZZLE_FILTER, DOZZLE_REMOTE_HOST, DOZZLE_REMOTE_AGENT, DOZZLE_NAMESPACE), akzeptieren in der Umgebungsvariable einen kommagetrennten Wert oder die Option einmal pro Eintrag wiederholt:

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 ​

VariableBeschreibungWerteStandard
DOZZLE_ADDR
--addr
Adresse und Port, auf denen der Webserver lauscht. In einem Container selten nötig.host:port, z. B. :9090:8080
DOZZLE_BASE
--base
Pfadpräfix, unter dem Dozzle ausgeliefert wird. Siehe Basis-Pfad ändern.ein Pfad, z. B. /logs/
DOZZLE_HOSTNAME
--hostname
Name dieser Instanz in der Oberfläche. Siehe Hostname.beliebiger Textkeiner
DOZZLE_HOST_ID
--host-id
Überschreibt die ID, die Dozzle für diesen Host ableitet. Nur nötig, wenn sie mit einem anderen Host kollidiert.Buchstaben, Ziffern, _, ., -abgeleitet
DOZZLE_LEVEL
--level
Log-Level von Dozzle selbst. Siehe Debugging.trace, debug, info, warn, errorinfo
DOZZLE_MODE
--mode
Betriebsmodus.server, swarm, k8sserver
DOZZLE_TIMEOUT
--timeout
Timeout für Aufrufe der Docker- oder Kubernetes-API.eine Dauer, z. B. 30s10s
DOZZLE_NO_ANALYTICS
--no-analytics
Schaltet die anonyme Analyse ab.true, falsefalse

Container und Hosts ​

VariableBeschreibungWerteStandard
DOZZLE_FILTER
--filter
Zeigt nur Container, die zu einem Docker-Filter passen. Siehe Filter.key=value, z. B. label=app=webkeiner
DOZZLE_REMOTE_AGENT
--remote-agent
Agents, mit denen verbunden wird, optional mit Anzeigename und Gruppe.host:port[|name[|group]]keiner
DOZZLE_REMOTE_HOST
--remote-host
Docker-Hosts, mit denen über TCP verbunden wird. Siehe Remote-Hosts.tcp://host:port[|label]keiner
DOZZLE_NAMESPACE
--namespace
Kubernetes-Namespaces, die beobachtet werden. Nur mit DOZZLE_MODE=k8s verwendet.Namespace-Namenalle
DOZZLE_CERT
--cert
TLS-Zertifikat für die Kommunikation mit Agents. Siehe eigene Zertifikate.ein Dateipfaddozzle_cert.pem
DOZZLE_KEY
--key
Privater TLS-Schlüssel für die Kommunikation mit Agents.ein Dateipfaddozzle_key.pem

Funktionen ​

VariableBeschreibungWerteStandard
DOZZLE_ENABLE_ACTIONS
--enable-actions
Erlaubt Starten, Stoppen, Neustarten, Entfernen und Aktualisieren von Containern aus der Oberfläche. Siehe Aktionen.true, falsefalse
DOZZLE_ENABLE_SHELL
--enable-shell
Erlaubt, sich aus der Oberfläche an Container anzuhängen und darin eine Shell zu starten. Siehe Shell.true, falsefalse
DOZZLE_ENABLE_MCP
--enable-mcp
Stellt den MCP-Endpunkt für LLM-Clients bereit.true, falsefalse
DOZZLE_DISABLE_AVATARS
--disable-avatars
Blendet Benutzeravatare aus, wenn die Authentifizierung aktiv ist.true, falsefalse
DOZZLE_RELEASE_CHECK_MODE
--release-check-mode
Ob Dozzle nach neuen eigenen Releases sucht. manual prüft nur, wenn du danach fragst.automatic, manualautomatic
DOZZLE_IMAGE_CHECK_MODE
--image-check-mode
Ob Dozzle in Registries nach neueren Container-Images sucht. Siehe Update-Prüfung.automatic, manual, offwie DOZZLE_RELEASE_CHECK_MODE
DOZZLE_AUTO_UPDATE
--auto-update
Aktualisiert den eigenen Container von Dozzle nach Zeitplan. weekly läuft am Sonntag. Setzt DOZZLE_ENABLE_ACTIONS voraus.off, daily, weeklyoff
DOZZLE_AUTO_UPDATE_TIME
--auto-update-time
Uhrzeit, zu der das automatische Update läuft, in der lokalen Zeit des Servers.HH:MM, z. B. 04:3003:00

Authentifizierung ​

Wie die Anbieter funktionieren, steht unter Authentifizierung.

VariableBeschreibungWerteStandard
DOZZLE_AUTH_PROVIDER
--auth-provider
Welcher Authentifizierungsanbieter verwendet wird. github und google sind Aliase für simple.none, simple, oidc, forward-proxynone
DOZZLE_AUTH_TTL
--auth-ttl
Wie lange eine Anmeldung gilt. session meldet ab, wenn der Browser geschlossen wird.session oder eine Dauer, z. B. 48h (Einheiten s, m, h)session
DOZZLE_AUTH_LOGOUT_URL
--auth-logout-url
Wohin der Benutzer beim Abmelden mit forward-proxy geschickt wird. Mit oidc überschreibt sie den Logout-Endpunkt des Issuers.eine URLkeiner

GitHub OAuth ​

Fügt simple-Authentifizierung ein „Mit GitHub anmelden" hinzu. Siehe OAuth.

VariableBeschreibungWerteStandard
DOZZLE_AUTH_GITHUB_CLIENT_ID
--auth-github-client-id
Client-ID der GitHub-OAuth-App.ein Stringkeiner
DOZZLE_AUTH_GITHUB_CLIENT_SECRET
--auth-github-client-secret
Client Secret der GitHub-OAuth-App.ein Stringkeiner

OpenID Connect ​

Wird mit DOZZLE_AUTH_PROVIDER=oidc verwendet. Siehe OIDC.

VariableBeschreibungWerteStandard
DOZZLE_AUTH_OIDC_ISSUER
--auth-oidc-issuer
Issuer-URL des Identitätsanbieters.eine URLkeiner
DOZZLE_AUTH_OIDC_CLIENT_ID
--auth-oidc-client-id
Beim Anbieter registrierte Client-ID.ein Stringkeiner
DOZZLE_AUTH_OIDC_CLIENT_SECRET
--auth-oidc-client-secret
Beim Anbieter registriertes Client Secret.ein Stringkeiner
DOZZLE_AUTH_OIDC_NAME
--auth-oidc-name
Beschriftung des Anmeldebuttons.beliebiger TextSSO
DOZZLE_AUTH_OIDC_ROLES_CLAIM
--auth-oidc-roles-claim
Claim, aus dem die Rollen gelesen werden. Nur nötig, wenn die Standardsuche (dozzle_roles, resource_access.<client-id>.roles, roles) ihn nicht findet.ein punktgetrennter Claim-Pfadkeiner
DOZZLE_AUTH_OIDC_FILTERS_CLAIM
--auth-oidc-filters-claim
Claim, aus dem die Container-Filter gelesen werden. Nur nötig, wenn die Standardsuche (dozzle_filters, resource_access.<client-id>.filters, filters) ihn nicht findet.ein punktgetrennter Claim-Pfadkeiner
DOZZLE_AUTH_OIDC_SCOPES
--auth-oidc-scopes
Zusätzliche Scopes, die neben openid, profile und email angefordert werden, für Anbieter, die einen Claim nur herausgeben, wenn sein Scope angefordert wird.kommagetrennte Scopeskeiner

TIP

DOZZLE_AUTH_GITHUB_CLIENT_SECRET und DOZZLE_AUTH_OIDC_CLIENT_SECRET akzeptieren auch ein Gegenstück mit _FILE, das eine Datei benennt, aus der der Wert gelesen wird, zur Nutzung mit Docker Secrets.

Forward Proxy ​

Wird mit DOZZLE_AUTH_PROVIDER=forward-proxy verwendet. Jede Variable benennt den HTTP-Header, den der Proxy setzt. Siehe Forward Proxy.

VariableBeschreibungWerteStandard
DOZZLE_AUTH_HEADER_USER
--auth-header-user
Header mit dem Benutzernamen.ein Header-NameRemote-User
DOZZLE_AUTH_HEADER_EMAIL
--auth-header-email
Header mit der E-Mail.ein Header-NameRemote-Email
DOZZLE_AUTH_HEADER_NAME
--auth-header-name
Header mit dem Anzeigenamen.ein Header-NameRemote-Name
DOZZLE_AUTH_HEADER_FILTER
--auth-header-filter
Header mit dem Container-Filter des Benutzers.ein Header-NameRemote-Filter
DOZZLE_AUTH_HEADER_ROLES
--auth-header-roles
Header mit den Rollen des Benutzers.ein Header-NameRemote-Roles

Unterbefehle ​

generate ​

Erzeugt einen users.yml-Eintrag für die einfache Authentifizierung. Der Benutzername ist das erste 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
OptionBeschreibungWerte
--password, -pPasswort des Benutzers.ein String
--email, -eE-Mail des Benutzers, wird für den Avatar verwendet.eine E-Mail-Adresse
--name, -nAnzeigename des Benutzers.ein String
--user-filterContainer, die der Benutzer sehen darf.kommagetrennte key=value-Filter
--user-rolesWas der Benutzer darf. Ein vorangestelltes ^ entfernt eine Rolle, z. B. all,^shell.all, none, shell, actions, download, notifications, cloud

agent ​

Startet Dozzle als Agent, mit dem sich eine andere Dozzle-Instanz verbindet.

sh
docker run -v /var/run/docker.sock:/var/run/docker.sock -p 7007:7007 amir20/dozzle agent
VariableBeschreibungWerteStandard
DOZZLE_AGENT_ADDR
--agent-addr
Adresse und Port, auf denen der Agent lauscht.host:port:7007

generate-certs ​

Erzeugt ein eigenes Zertifikat samt Schlüssel für Agent-Verbindungen, anstelle des gemeinsamen, das Dozzle mitbringt. Siehe eigene Zertifikate.

OptionBeschreibungStandard
--cert-outWohin das Zertifikat geschrieben wird.dozzle_cert.pem
--key-outWohin der private Schlüssel geschrieben wird.dozzle_key.pem
--forceÜberschreibt vorhandene Dateien.false

healthcheck ​

Prüft, ob Server oder Agent laufen. Er ist im Image standardmäßig nicht eingebunden, weil er etwas zusätzliche CPU-Last erzeugt. Siehe Healthcheck.

Veröffentlicht unter der MIT-Lizenz. Quelloffen und gesponsert von Docker OSS.