NocMate Logo NocMate
Checkmk Setup

Checkmk-Push und Connect einrichten

Der Standard-Weg ist Push: ein Befehl installiert das Notification-Plugin, dann zwei Parameter in der Rule — fertig. Connect ist optional und nur nötig, wenn die App auf eine Checkmk-Instanz hinter der Firewall zugreifen soll.

Voraussetzungen und Download

Installiere NocMate aus dem App Store. Für Push benötigt die Checkmk-Site ausgehenden HTTPS-Zugriff auf die NocMate API und eine Notification-Regel. Für Live-Ansichten brauchst du einen Checkmk-Benutzer mit passenden Rechten. Bei privaten Instanzen richtest du optional Connect separat ein.

App Store · Checkmk Benachrichtigungs-Dokumentation

Empfohlen · Push

Push in einem Befehl

~2 Min · 1 Befehl

Für reine Alerts auf iPhone und Mac brauchst du weder Connect noch einen Agent. Das Skript erkennt deine OMD-Site automatisch, legt das Notification-Plugin nocmate_push ab und lädt Checkmk neu. Danach nur noch die Notification-Rule mit zwei Parametern anlegen (Schritte unten).

curl -fsSL https://nocmate.app/downloads/install_nocmate_checkmk.sh | sudo bash

Lieber ohne Pipe-to-Shell? nocmate_push.sh manuell nach ~/local/share/check_mk/notifications/ legen und ausführbar machen.

Auto-erkannt
  • OMD-Site (auch in Multi-Site-Hosts)
  • Notifications-Verzeichnis der Site
  • Reload via cmk -R
Minimal & lokal
  • Nur ein Plugin-Skript, kein Daemon
  • Kein systemd-Service, kein Agent
  • Kein Inbound, kein Reverse Proxy nötig
Optional: Connect
  • Nur für App-Zugriff hinter Firewall
  • Voller Wizard: install/connect.sh
  • Siehe Tunnel-Quickstart unten

Direktpfade (für Skripte & Power-User)

Brauchst du keinen Wizard? Spring direkt zu einem der zwei Quickstarts.

Standard · Push
→

Push Notifications

Wenn deine Checkmk-Site Notifications direkt an unsere API senden kann (typisch via Reverse Proxy / DMZ).

  • ✓ Push auf iPhone & Mac
  • ✓ Notification-Rule per REST automatisch angelegt
  • ✓ 3 Schritte, kein Web-UI-Klicken
Beta · Tunnel
→

NocMate Connect

Wenn Checkmk hinter der Firewall liegt und kein Public-Endpoint existieren soll. Outbound-only HTTPS, kein VPN, kein Reverse Proxy.

  • ✓ App greift auf Hosts/Services zu
  • ✓ Multi-User mit eigenen Checkmk-Permissions
  • ✓ 3 Schritte über QR-Pairing

Push-Quickstart

~2 Min · 3 Schritte

Plugin und Notification-Rule werden automatisch eingerichtet. Du brauchst kein Web-UI-Klicken in Checkmk.

  1. User Key aus der App holen

    In NocMate: Settings → Push Notifications → den 40-stelligen User Key kopieren.

  2. Auf dem Checkmk-Server ausführen

    Der Wizard erkennt OMD-Site und Checkmk-User automatisch, fragt nur den User Key ab und legt das Push-Plugin sowie die Notification-Rule per Checkmk-REST-API direkt an. Kein Web-UI nötig.

    curl -fsSL https://api.nocmate.app/install/connect.sh | sudo bash

    Im Menü [1] Push-Notifications einrichten wählen. Für mehrere Personen: pro Person eine Rule (jeder hat seinen eigenen User Key in der App).

    Skripting-Variante (nach Erst-Install steht das CLI lokal): sudo nocmate-cli push --push-user-key <KEY> --push-cmk-user cmkadmin

  3. Testen

    WARNING / CRITICAL / Recovery auslösen, am iPhone bzw. Mac gegenprüfen. Falls keine Push ankommt: API-Health prüfen (api.nocmate.app/api/v1/health), Bulking deaktivieren, Rule-Conditions checken.

NocMate Connect (Beta)

Tunnel-Quickstart

~2 Min · 3 Schritte

Ein Agent (Python, systemd-Service) hält eine ausgehende TLS-Verbindung zum Relay offen und führt App-Anfragen lokal gegen Checkmk aus. Kein Inbound-Port, kein VPN, keine Snapshot-Speicherung beim Relay.

  1. Connect-Installer ausführen

    Erkennt die OMD-Site, holt das automation-Secret automatisch, installiert systemd-Service. Derselbe Befehl funktioniert später auch zum Hinzufügen einer weiteren Person.

    curl -fsSL https://api.nocmate.app/install/connect.sh | sudo bash -s -- pair --add
  2. QR-Code mit der App scannen

    Im Terminal erscheint ein QR-Code + 6-stelliger Pairing-Code (5 min, single-use). In NocMate: Settings → Connect Site hinzufügen.

  3. Fertig

    Hosts, Services, Acknowledge, Recheck, Downtime und Master Control funktionieren wie im REST-API-Modus. Connector-Status (online / last seen) erscheint pro Site in der App.

👥 Mehrere Personen am gleichen Server? Team-Setup ↓
API erreichbar?
Health Check
api.nocmate.app/api/v1/health
Endpoints
API-Dokumentation
OpenAPI / Swagger
Hilfe
FAQ
Häufige Fragen & Connect-FAQ

Erweitert

Details zum Aufklappen — alles weitere ist optional.

▸
Connect
Team-Setup (Multi-User)

Ein Connector kann mehrere NocMate-Identitäten parallel bedienen. Jede Identity hat eigene Tunnel-Credentials und ihren eigenen Checkmk-User — damit greifen die nativen Checkmk-Permissions (Contact Groups, Roles) auch durch den Tunnel.

curl -fsSL https://api.nocmate.app/install/connect.sh | sudo bash -s -- pair --add

Selber Befehl wie für den Erst-Install — er erkennt automatisch, ob bereits eine Identity existiert, und fügt dann nur eine weitere hinzu (kein Service-Neustart). Die zweite Person scannt den QR mit ihrem eigenen iPhone, iPad oder Mac. Nach dem Erst-Install steht ausserdem ein lokaler CLI-Wrapper bereit:

Identitäten auflisten
sudo nocmate-cli pair --list
Identity entfernen
sudo nocmate-cli pair --remove <name>

Voraussetzung: jede Person braucht einen eigenen Checkmk-User (Setup → Users → Automation secret). Empfohlen: Rolle monitoring_user + passende Contact Group, kein Admin. Acknowledgements erscheinen im Audit-Log unter dem korrekten User-Namen — kein geteilter automation-Account nötig.

▸
Operations
Verwalten, Logs & widerrufen
Status & Logs
systemctl status nocmate-connector
journalctl -u nocmate-connector -f
Tunnel widerrufen

In der App unter Settings → Sites die Connect-Site löschen. Token wird serverseitig sofort entwertet. Wenn keine Identity mehr aktiv ist, kann der Service deinstalliert werden:

sudo systemctl disable --now nocmate-connector
sudo rm /usr/local/bin/nocmate-connector \
  /etc/systemd/system/nocmate-connector.service \
  /etc/nocmate/connector.conf
▸
Push
Manuelle Installation & Downloads

Wenn du den Wizard nicht verwenden willst (Air-Gap, Image-Build, eigene Pipeline) kannst du das Push-Plugin auch direkt nach ~/local/share/check_mk/notifications/nocmate_push legen und ausführbar machen — dann manuell eine Notification-Rule mit Methode NocMate Push (nocmate_push) in Setup → Events → Notifications anlegen.

Rule-Parameter manuell: Parameter 1 = https://api.nocmate.app, Parameter 2 = User-Key aus der App. Empfohlen: Event Problem + Recovery, State type HARD, Bulking aus.

Mehr Infos & Hilfe

Sicherheit, Troubleshooting und Hintergrund

Sicherheits-Eigenschaften, Datenfluss, Firewall-Regeln, Push-Probleme und alles weitere zum Tunnel haben wir kompakt in der FAQ gebündelt — pro Frage eine kurze Antwort.