Einrichtungsassistent

Docker Only

Eine frische Dozzle-Installation startet mit einem kurzen Einrichtungsassistenten. Er führt dich durch die wenigen Dinge, die die meisten direkt nach der Installation ändern: Login einschalten, Container-Aktionen und Shell-Zugriff erlauben und Dozzle Cloud verbinden. Alles, was er speichert, lässt sich auch über Flags oder Umgebungsvariablen setzen, der Assistent ist also optional.

Der Assistent erscheint nur bei einer frischen Installation im Server-Modus. Swarm- und Kubernetes-Deployments zeigen ihn nie. Du kannst ihn später in den Einstellungen erneut öffnen.

Schritte

1. Login

Der Login kommt zuerst, damit auf einer Instanz, die jeder erreichen kann, sonst nichts geändert werden kann.

Zuerst prüft der Assistent, ob /data auf einem Volume liegt. Einstellungen und Benutzer werden dort gespeichert, und ohne Volume wären sie beim nächsten Neuerstellen des Containers weg. Ist /data nicht persistent, zeigt der Assistent, wie du es einbindest, und wartet, bis du auf Erneut prüfen klickst.

services:
  dozzle:
    image: amir20/dozzle:latest
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock
      - dozzle_data:/data
    ports:
      - 8080:8080
volumes:
  dozzle_data:

Sobald /data persistent ist, wählst du eine von drei Optionen:

• Dozzle-Konto legt einen einzelnen Benutzer mit Benutzername, optionaler E-Mail und Passwort an. Dozzle schreibt /data/users.yml und setzt authProvider: simple. Unter Einfache Authentifizierung erfährst du, wie du später weitere Benutzer oder Rollen hinzufügst.
• Mein Proxy ist für Authelia, Authentik, Cloudflare Access und Ähnliches. Dozzle vertraut dem Header Remote-User, veröffentliche also nur den Proxy und nie den Port von Dozzle selbst. Das setzt authProvider: forward-proxy. Siehe Forward Proxy.
• OIDC zeigt einen Link zur Anleitung für OpenID Connect und die Umgebungsvariablen, die du ergänzen musst. OIDC braucht ein Client-Secret, deshalb wird hier nichts geschrieben und du richtest es selbst ein.

Ist Dozzle nur in deinem eigenen Netzwerk erreichbar, überspringt Ohne Anmeldung fortfahren diesen Schritt.

Nachdem ein Konto oder Proxy gespeichert wurde, startet Dozzle sofort neu, damit der Login aktiv ist, bevor irgendetwas anderes geändert wird. Du landest auf der Login-Seite, und nach der Anmeldung macht der Assistent mit dem nächsten Schritt weiter.

2. Aktionen und Shell

Zwei Schalter legen fest, was Dozzle mit deinen Containern tun darf:

• Starten, Stoppen und Neustarten schaltet Container-Aktionen ein (enableActions).
• Shell schaltet das Anhängen und Ausführen von Befehlen in Containern ein (enableShell). Standardmäßig ist es aus. Shell-Zugriff auf einen Container ist oft so viel wert wie Zugriff auf den Host, schalte ihn also nur ein, wenn du ihn brauchst.

Ist eine Einstellung bereits über ein Flag oder eine Umgebungsvariable festgelegt, ist ihr Schalter schreibgeschützt und weist darauf hin. Wie der Login brauchen diese Schalter /data auf einem Volume und bleiben schreibgeschützt, bis es eingebunden ist.

3. Dozzle Cloud

Dozzle Cloud schickt Alerts, sobald etwas kaputtgeht, eine morgendliche Zusammenfassung dessen, was zu beheben ist, und bewahrt einen Verlauf, der Neustarts übersteht. Dozzle Cloud verbinden verknüpft diese Instanz, Nicht jetzt geht weiter. Dieser Schritt entfällt, wenn die Instanz bereits verknüpft ist oder du sie nicht verknüpfen darfst.

4. Automatische Updates

Dozzle kann sich selbst aktuell halten. Wähle Aus, Täglich oder Wöchentlich (wöchentlich läuft am Sonntag) und eine Uhrzeit. Die Uhrzeit gilt in der lokalen Zeit des Servers, Standard ist 03:00. Zu dieser Zeit prüft Dozzle seine Registry auf ein neueres Image und aktualisiert sich nur, wenn es eines gibt.

Diese Einstellung gilt sofort und braucht keinen Neustart.

Sich selbst zu aktualisieren ist eine Aktion. Solange Aktionen aus sind, bleibt dieser Schritt deshalb in der Liste, ist aber ausgegraut und mit Benötigt Aktionen markiert. Schaltest du Aktionen in Schritt 2 ein, ist er sofort verfügbar. Kann sich diese Instanz aus einem anderen Grund nicht selbst aktualisieren (zum Beispiel, weil ein fester Versions-Tag läuft), nennt der Schritt stattdessen den Grund.

5. Neustart

Der letzte Schritt listet die Änderungen auf, die gespeichert, aber noch nicht aktiv sind. Dozzle neu starten startet den Container neu, wartet, bis er wieder da ist, und lädt die Seite neu. Steht nichts aus, meldet der Schritt nur, dass du fertig bist.

Kann sich Dozzle nicht selbst neu starten (zum Beispiel, wenn es seinen eigenen Container nicht findet), zeigt der Assistent stattdessen die Umgebungsvariablen, die du in deine Compose-Datei eintragen kannst.

Wo Einstellungen gespeichert werden

Der Assistent speichert deine Auswahl in /data/dozzle.yml. Dozzle liest diese Datei einmal beim Start, deshalb brauchen Änderungen einen Neustart. Dozzle startet sich aus dem Assistenten heraus selbst neu, du musst das also nicht von Hand erledigen. Die Schlüssel für automatische Updates sind die Ausnahme: Dozzle liest sie jede Minute neu, deshalb gelten sie ohne Neustart.

authProvider: simple
enableActions: true
enableShell: false
autoUpdate: weekly
autoUpdateTime: "03:00"

Schlüssel	Werte	Entspricht
authProvider	none, simple, forward-proxy	DOZZLE_AUTH_PROVIDER
enableActions	true, false	DOZZLE_ENABLE_ACTIONS
enableShell	true, false	DOZZLE_ENABLE_SHELL
autoUpdate	off, daily, weekly	DOZZLE_AUTO_UPDATE
autoUpdateTime	HH:MM, lokale Zeit des Servers	DOZZLE_AUTO_UPDATE_TIME

Flags und Umgebungsvariablen haben immer Vorrang vor der Datei. Ist DOZZLE_ENABLE_ACTIONS gesetzt, wird der Wert in dozzle.yml ignoriert und der Assistent zeigt den Schalter als gesperrt an. Um eine Einstellung wieder über den Assistenten zu verwalten, entferne die Variable aus deiner Compose-Datei.

So funktioniert das Selbst-Update

Dozzle aktualisiert sich über die Update-Aktion am eigenen Container oder nach dem Zeitplan für automatische Updates. Beides läuft gleich ab:

1. Dozzle zieht den Image-Tag, den es gerade ausführt. Zeigt der Tag noch auf das laufende Image, hört es hier auf und meldet, dass es aktuell ist.
2. Dozzle startet aus dem neuen Image einen kurzlebigen Hilfscontainer mit Zugriff auf denselben Docker-Socket. Wenige Sekunden später ist Dozzle weg.
3. Der Hilfscontainer benennt den alten Container um und legt unter dem ursprünglichen Namen einen Ersatz mit derselben Konfiguration, denselben Netzwerken und Volumes an. Erst dann stoppt er den alten Container und startet den Ersatz. Auch anonyme Volumes bleiben erhalten, die Daten in /data überstehen das Update also auch ohne benanntes Volume.
4. Der Hilfscontainer wartet, bis der Ersatz stabil läuft (und gesund ist, falls er einen Healthcheck hat). Klappt das, wird der alte Container entfernt und seine Volumes bleiben unangetastet. Klappt es nicht, wird der Ersatz entfernt und der alte Container zurückbenannt und wieder gestartet.

Mit --rm gestartete Container werden genauso aktualisiert. Der alte Container löscht sich beim Stoppen selbst, aber der Ersatz hält seine Volumes zu diesem Zeitpunkt schon, deshalb bleiben sie erhalten. Muss das Update zurückgerollt werden, legt der Hilfscontainer den alten Container aus seiner gespeicherten Konfiguration neu an.

Die Logs des Hilfscontainers sind die einzige Aufzeichnung eines Updates. Er entfernt sich am Ende selbst, um ein Update zu verfolgen, beobachte also den Container dozzle-self-update-*, solange er läuft.

Manche Setups lassen sich so nicht aktualisieren:

• Aktionen müssen eingeschaltet sein. Das Selbst-Update braucht DOZZLE_ENABLE_ACTIONS, und die Update-Aktion braucht bei aktivem Login die Rolle für Aktionen.
• Im Server-Modus, auch als Swarm-Service. Läuft Dozzle als Task eines Swarm-Service, gibt es keinen Hilfscontainer: Dozzle bittet den Swarm-Manager, den Service auf das neue Image umzustellen, und es gelten die Update- und Rollback-Einstellungen von Swarm. Dafür muss Dozzle auf einem Manager-Knoten laufen. Bei mehreren Replicas führt nur die erste den Zeitplan aus. Kubernetes und Dozzle-Agents aktualisieren sich nicht selbst.
• Feste Versions-Tags werden nie aktualisiert. amir20/dozzle:v8.12.0 liefert beim Ziehen immer dasselbe Image, deshalb sind automatische Updates nicht verfügbar und ein manuelles Update meldet, dass alles aktuell ist. Nutze latest oder ändere den Tag selbst.

Sicherheit

• Der Login ist der erste Schritt. Ein Neustart nach dem Speichern eines Kontos oder Proxys schaltet den Login ein, bevor irgendeine andere Einstellung geändert werden kann.
• Nur ein angemeldeter Benutzer kann Aktionen, Shell und automatische Updates ändern oder Dozzle neu starten. Der Benutzer braucht alle Rollen.
• Ohne Login bekommt nur eine neue Installation ein Zeitfenster von 15 Minuten. Ist authProvider auf none gesetzt, lassen sich diese Einstellungen nur innerhalb von 15 Minuten nach dem ersten Start einer neuen Installation ändern, also einer, deren /data leer war. Eine Installation, die schon Daten aus früheren Starts hat, bekommt das Zeitfenster nie, ein Neustart des Hosts oder ein Image-Update kann es also nicht öffnen. Außerhalb des Zeitfensters nutzt du Umgebungsvariablen oder schaltest den Login ein.
• Routen werden weiterhin beim Start festgelegt. Der Assistent schreibt nur in dozzle.yml. Die Endpunkte für Aktionen und Shell werden beim Start von Dozzle registriert, genau wie bei Umgebungsvariablen, also wird nichts aktiviert, bevor Dozzle neu startet.