Gateway Runbook: Startup und Betrieb
Kennst du das? Du willst einen Service starten, aber stößt ständig auf belegte Ports, fehlende Berechtigungen oder Konfigurationsfehler, die den Workflow unterbrechen. Es ist oft frustrierend, wenn die Infrastruktur mehr Zeit in Anspruch nimmt als die eigentliche Entwicklung, besonders wenn man nur eine stabile Verbindung für seine Tools braucht.
Ein zuverlässiges Gateway ist entscheidend, damit deine Prozesse sauber kommunizieren. Wenn der Prozess im Hintergrund nicht ordentlich läuft oder die Authentifizierung hakt, steht das gesamte System still.
Voraussetzungen
Abschnitt betitelt „Voraussetzungen“Bevor du startest, stelle sicher, dass du folgende Voraussetzungen erfüllst:
- Installierte openclaw CLI.
- Zugriff auf die Konfigurationsdatei (über das Profil oder
OPENCLAW_CONFIG_PATH). - Authentifizierungs-Daten (
gateway.auth.tokenodergateway.auth.password). - Eine lokale Umgebung für den initialen Test.
Schnellstart
Abschnitt betitelt „Schnellstart“In weniger als fünf Minuten ist dein Gateway einsatzbereit. Folge diesen Schritten für einen minimalen Setup-Pfad:
1. Gateway starten
Abschnitt betitelt „1. Gateway starten“Verwende diesen Befehl, um den Service auf dem Standard-Port zu starten:
openclaw gateway --port 18789Wenn du Fehler suchen musst, kannst du den Verbose-Modus nutzen oder einen Port-Reset erzwingen:
# Debug/Trace direkt in der Konsoleopenclaw gateway --port 18789 --verbose
# Listener auf dem Port killen und neu startenopenclaw gateway --force2. Service-Status prüfen
Abschnitt betitelt „2. Service-Status prüfen“Kontrolliere, ob alles korrekt läuft. Ein gesundes System zeigt Runtime: running und RPC probe: ok.
openclaw gateway statusopenclaw status3. Logs verfolgen
Abschnitt betitelt „3. Logs verfolgen“Beobachte die Aktivitäten deines Gateways in Echtzeit, um Fehler frühzeitig zu erkennen:
openclaw logs --follow4. Channel-Bereitschaft validieren
Abschnitt betitelt „4. Channel-Bereitschaft validieren“Prüfe abschließend, ob die Channels bereit für Verbindungen sind:
openclaw channels status --probeHinweis: Das Gateway überwacht Änderungen an der Konfigurationsdatei automatisch. Der Standard-Modus dafür ist
gateway.reload.mode="hybrid".
Runtime Model
Abschnitt betitelt „Runtime Model“Das Gateway arbeitet als ein einzelner Prozess, der das Routing, die Control Plane und die Channel-Verbindungen übernimmt.
- Multiplexed Port: Ein einziger Port für WebSocket (Control/RPC), HTTP APIs (OpenAI-kompatibel) und die Control UI.
- Bind Mode: Standardmäßig auf
loopbackeingestellt. - Auth: Standardmäßig aktiviert. Nutze
OPENCLAW_GATEWAY_TOKENoderOPENCLAW_GATEWAY_PASSWORD.
Port-Priorität und Bind-Modus
Abschnitt betitelt „Port-Priorität und Bind-Modus“| Einstellung | Auflösungsreihenfolge |
|---|---|
| Gateway Port | --port → OPENCLAW_GATEWAY_PORT → gateway.port → 18789 |
| Bind Mode | CLI/Override → gateway.bind → loopback |
Hot Reload Modi
Abschnitt betitelt „Hot Reload Modi“gateway.reload.mode | Verhalten |
|---|---|
off | Kein Reload der Konfiguration |
hot | Nur sicher anwendbare Änderungen übernehmen |
restart | Neustart bei erforderlichen Änderungen |
hybrid (default) | Hot-Apply wenn möglich, Neustart wenn nötig |
Remote Access
Abschnitt betitelt „Remote Access“Für den Fernzugriff ist ein VPN (wie Tailscale) die beste Wahl. Alternativ kannst du einen SSH-Tunnel nutzen:
ssh -N -L 18789:127.0.0.1:18789 user@hostVerbinde deine Clients danach lokal mit ws://127.0.0.1:18789. Auch über SSH-Tunnel bleibt die Authentifizierung (Token/Passwort) zwingend erforderlich.
Fehlerbehebung
Abschnitt betitelt „Fehlerbehebung“Hier findest du Lösungen für häufige Probleme, die beim Start oder Betrieb auftreten können:
| Signatur | Wahrscheinliche Ursache | Lösung |
|---|---|---|
refusing to bind gateway ... without auth | Bind außerhalb Loopback ohne Token/Passwort | Auth-Token setzen oder Bind-Modus prüfen. |
another gateway instance is already listening / EADDRINUSE | Port-Konflikt | Port ändern oder --force Flag nutzen. |
Gateway start blocked: set gateway.mode=local | Konfiguration steht auf Remote-Modus | gateway.mode in der Konfig anpassen. |
unauthorized während des Connects | Auth-Mismatch zwischen Client und Gateway | Token oder Passwort im Client abgleichen. |
Sicherheitsgarantien
Abschnitt betitelt „Sicherheitsgarantien“Das Gateway-Protokoll ist auf Sicherheit und Vorhersehbarkeit ausgelegt:
- Clients schlagen sofort fehl, wenn das Gateway nicht erreichbar ist (kein Fallback auf direkte Channels).
- Ungültige oder fehlende
connect-Frames führen zum sofortigen Verbindungsabbruch. - Ein Graceful Shutdown sendet ein
shutdown-Event, bevor der Socket geschlossen wird. - Der Zugriff ist standardmäßig auf die lokale Maschine beschränkt.
Benötigst du Hilfe bei der Einrichtung? Nutze den AI Setup Assistant.
Nächste Schritte
Abschnitt betitelt „Nächste Schritte“OpenClaw Expert
Noch festgefahren?
Wenn diese Seite nicht hilft, frage OpenClaw Expert nach Schritt-fuer-Schritt-Loesungen.