Heute bedienen wir ein wenig das Klischee, dass in jedem Homelab mehr Monitoring-Tools und Dashboards laufen, als eigentliche Dienste betrieben werden. Aber Uptime Kuma ist solch ein Klassiker und guter Einstieg in das ganze Thema Homelab, dass ich es nicht auslassen wollte.

Dieser Artikel gehört zur Reihe „Homelab Minis“. Darin stellen wir Software und Dienste kurz und knackig vor, führen durch die Einrichtung und geben praktische Anwendungsbeispiele.

Der weitere Verlauf geht davon aus, dass ihr bereits einen Host mit Docker sowie einem beliebigen Tool zur Verwaltung von Containern eingerichtet habt, beispielsweise Portainer Community Edition. In dem Github-Repository von Uptime Kuma gibt es eine Compose-Vorlage, die wir verwenden können:

services:
  uptime-kuma:
    image: louislam/uptime-kuma:2
    restart: unless-stopped
    volumes:
      - ./data:/app/data
    ports:
      # <Host Port>:<Container Port>
      - "3001:3001"

In Portainer navigiert man beispielsweise zu Stacks > Add Stack > Web editor und fügt die Compose dort ein. Eventuell müsst ihr den vorne stehenden Host Port abändern, wenn dieser in eurer Umgebung bereits belegt ist. Der Container Port muss unverändert bleiben.

Damit wir später andere Container überwachen können und alle Dateien direkt in einem Container Volumen gespeichert werden, habe ich die Vorlage abgewandelt:

services:
  uptime-kuma:
    container_name: uptime-kume
    image: louislam/uptime-kuma:2
    restart: unless-stopped
    network_mode: bridge
    volumes:
      - uptime-kuma_data:/app/data
      - /var/run/docker.sock:/var/run/docker.sock
    ports:
      - "3001:3001"   
volumes:
  uptime-kuma_data:
    name: uptime-kuma_data

Startet man dann den Container, kann über die IP-Adresse des Hosts und dem jeweils vergebenen Port auf die Weboberfläche von Uptime Kuma zugegriffen werden.

Uns steht direkt eine Vielzahl an möglichen Methoden der Überwachung zur Verfügung:

Beispielsweise die Erreichbarkeit einer internen oder externen Webseite über die Methode HTTP(S). Dazu muss nur der Anzeigename “Friendly Name” und der zu überwachende Link unter “URL” angegeben werden, bevor auf “Save” geklickt wird.

Soll hingegen direkt ein Docker Container überwacht werden, muss wie hier beschrieben und oben in meiner angepassten Compose bereits vorhanden, als Volumen für den Uptime Kuma Container der Docker Socket hinzugefügt werden.

Ist das erledigt, kann als “Monitor Type” die Methode “Docker Container” ausgewählt werden, bevor auf das + neben “Docker Host” geklickt wird.

In dem neuen Fenster könnt ihr wieder den Anzeigenamen “Friendly Name” vergeben, “Connection Type” auf “Socket” festlegen und als “Docker Daemon” einfach “/var/run/docker.sock” eintragen. Mit “Test” kann die Verbindung ausprobiert werden, bevor mit “Save” bestätigt wird.

Tragt beim “Friendly Name” dann wieder den gewünschten Anzeigenamen ein und verwendet bei “Container Name / ID” am besten den Namen, welcher in eurer Container-Verwaltung angezeigt wird. Bei “Docker Host” wählt ihr dann die eben angelegte Verbindung aus.

Um beispielsweise die Namensauflösung von einem selbst betriebenem DNS-Server zu überwachen, kann bei “Monitor Type” die Methode “DNS” ausgewählt werden. Vergebt dann wie gewohnt bei “Friendly Name” den Anzeigename, bei “Hostname” die Domain, für welche die Namensauflösung getestet werden soll, sowie bei “Resolver Server(s)” die IP-Adresse eures DNS-Servers.

Damit wir von Problemen aber überhaupt etwas mitbekommen, muss noch ein Weg für die Benachrichtigungen eingestellt werden. Navigiert dazu ganz rechts oben auf das Profilbild und dort auf “Settings” (1), dann “Notifications” (2) und dann auf Set Up Notification” (3).

Uptime Kuma stellt einen ganzen Haufen an Vorlagen bereits, drei verschiedene Beispiele zeige ich dann auf den nächsten Seiten.