Advanced setup
Einrichtung
Kurzfassung
Wählen Sie einen Einrichtungsablauf danach aus, wie häufig Sie Aktualisierungen wünschen und ob Sie den Gateway selbst ausführen möchten:
- Anpassungen bleiben außerhalb des Repositorys: Bewahren Sie Ihre Konfiguration und Ihren Workspace in
~/.openclaw/openclaw.jsonund~/.openclaw/workspace/auf, damit Aktualisierungen des Repositorys sie nicht verändern. - Stabiler Ablauf (für die meisten empfohlen): Installieren Sie die macOS-App und lassen Sie sie den gebündelten Gateway ausführen.
- Bleeding-Edge-Ablauf (Entwicklung): Führen Sie den Gateway selbst über
pnpm gateway:watchaus und lassen Sie anschließend die macOS-App im lokalen Modus eine Verbindung herstellen.
Voraussetzungen (aus dem Quellcode)
- Node 24 empfohlen (Node 22 LTS, derzeit
22.19+, wird weiterhin unterstützt) pnpmist für Quellcode-Checkouts erforderlich. OpenClaw lädt gebündelte Plugins im Entwicklungsmodus aus den pnpm-Workspace-Paketen unterextensions/*. Daher bereitetnpm installim Stammverzeichnis nicht den vollständigen Quellcodebaum vor.- Docker (optional; nur für containerisierte Einrichtung/E2E – siehe Docker)
Anpassungsstrategie (damit Aktualisierungen nichts beeinträchtigen)
Wenn Sie sowohl eine „zu 100 % auf mich zugeschnittene“ Konfiguration als auch einfache Aktualisierungen wünschen, bewahren Sie Ihre Anpassungen hier auf:
- Konfiguration:
~/.openclaw/openclaw.json(JSON/ähnlich wie JSON5) - Workspace:
~/.openclaw/workspace(Skills, Prompts, Erinnerungen; richten Sie ihn als privates Git-Repository ein)
Initialisieren Sie die Konfigurations- und Workspace-Ordner einmalig, ohne den vollständigen Onboarding-Assistenten auszuführen:
openclaw setup --baselineNoch keine globale Installation vorhanden? Führen Sie den Befehl stattdessen aus diesem Repository aus:
pnpm openclaw setup --baseline(openclaw setup ohne --baseline ist ein Alias für openclaw onboard und führt den vollständigen interaktiven Assistenten aus.)
Gateway aus diesem Repository ausführen
Nach pnpm build können Sie die paketierte CLI direkt ausführen:
node openclaw.mjs gateway --port 18789 --verboseStabiler Ablauf (macOS-App zuerst)
- Installieren und starten Sie OpenClaw.app (Menüleiste).
- Schließen Sie die Onboarding-/Berechtigungscheckliste ab (TCC-Abfragen).
- Stellen Sie sicher, dass der Gateway auf Local eingestellt ist und ausgeführt wird (die App verwaltet ihn).
- Verknüpfen Sie Dienste (Beispiel: WhatsApp):
openclaw channels login- Führen Sie eine Plausibilitätsprüfung durch:
openclaw healthWenn das Onboarding in Ihrem Build nicht verfügbar ist:
- Führen Sie
openclaw setupund anschließendopenclaw channels loginaus. Starten Sie danach den Gateway manuell (openclaw gateway).
Bleeding-Edge-Ablauf (Gateway in einem Terminal)
Ziel: am TypeScript-Gateway arbeiten, Hot Reload nutzen und die Benutzeroberfläche der macOS-App verbunden halten.
0) (Optional) Auch die macOS-App aus dem Quellcode ausführen
Wenn Sie auch die macOS-App auf dem neuesten Entwicklungsstand verwenden möchten:
./scripts/restart-mac.sh1) Entwicklungs-Gateway starten
pnpm install# Nur bei der ersten Ausführung (oder nach dem Zurücksetzen der lokalen OpenClaw-Konfiguration/des Workspace)pnpm openclaw setuppnpm gateway:watchgateway:watch startet den Gateway-Watch-Prozess in einer benannten tmux-Sitzung
(openclaw-gateway-watch-main) oder startet ihn dort neu und verbindet interaktive
Terminals automatisch mit dieser Sitzung. Nicht interaktive Shells bleiben getrennt und geben
tmux attach -t openclaw-gateway-watch-main aus. Verwenden Sie
OPENCLAW_GATEWAY_WATCH_ATTACH=0 pnpm gateway:watch, damit eine interaktive Ausführung
getrennt bleibt, oder pnpm gateway:watch:raw für den Watch-Modus im Vordergrund. Der Watcher
lädt bei relevanten Änderungen am Quellcode, an der Konfiguration und an den Metadaten gebündelter Plugins neu. Wenn der
überwachte Gateway während des Starts beendet wird, führt gateway:watch einmal
openclaw doctor --fix --non-interactive aus und versucht es erneut. Setzen Sie
OPENCLAW_GATEWAY_WATCH_AUTO_DOCTOR=0, um diesen ausschließlich für die Entwicklung vorgesehenen Reparaturdurchlauf zu deaktivieren.
pnpm gateway:watch erstellt dist/control-ui nicht neu. Führen Sie daher nach Änderungen unter ui/ erneut pnpm ui:build aus oder verwenden Sie während der Entwicklung der Control UI pnpm ui:dev.
2) Die macOS-App mit Ihrem laufenden Gateway verbinden
In OpenClaw.app:
- Connection Mode: Local Die App stellt über den konfigurierten Port eine Verbindung zum laufenden Gateway her.
3) Überprüfen
- Der Gateway-Status in der App sollte "Using existing gateway …" anzeigen.
- Alternativ über die CLI:
openclaw healthHäufige Fallstricke
- Falscher Port: Gateway-WS verwendet standardmäßig
ws://127.0.0.1:18789. Verwenden Sie für App und CLI denselben Port. - Speicherorte des Zustands:
- Kanal-/Provider-Zustand:
~/.openclaw/credentials/ - Modellauthentifizierungsprofile:
~/.openclaw/agents/<agentId>/agent/auth-profiles.json - Sitzungen und Transkripte:
~/.openclaw/agents/<agentId>/agent/openclaw-agent.sqlite - Veraltete/archivierte Sitzungsartefakte:
~/.openclaw/agents/<agentId>/sessions/ - Protokolle:
/tmp/openclaw/
- Kanal-/Provider-Zustand:
Übersicht der Anmeldedatenspeicherung
Verwenden Sie diese Übersicht bei der Fehlerbehebung für die Authentifizierung oder um zu entscheiden, was gesichert werden soll:
- WhatsApp:
~/.openclaw/credentials/whatsapp/<accountId>/creds.json - Telegram-Bot-Token: Konfiguration/Umgebungsvariable oder
channels.telegram.tokenFile(nur reguläre Datei; symbolische Links werden abgelehnt) - Discord-Bot-Token: Konfiguration/Umgebungsvariable oder SecretRef (Provider für Umgebungsvariablen/Dateien/Ausführung)
- Slack-Token: Konfiguration/Umgebungsvariable (
channels.slack.*) - Kopplungs-Zulassungslisten:
~/.openclaw/credentials/<channel>-allowFrom.json(Standardkonto)~/.openclaw/credentials/<channel>-<accountId>-allowFrom.json(Nicht-Standardkonten)
- Modellauthentifizierungsprofile:
~/.openclaw/agents/<agentId>/agent/auth-profiles.json - Dateibasierte Secrets-Nutzdaten (optional):
~/.openclaw/secrets.json - Import veralteter OAuth-Daten:
~/.openclaw/credentials/oauth.jsonWeitere Details: Sicherheit.
Aktualisieren (ohne Ihre Einrichtung zu beschädigen)
- Behandeln Sie
~/.openclaw/workspaceund~/.openclaw/als „Ihre Daten“. Legen Sie keine persönlichen Prompts oder Konfigurationen imopenclaw-Repository ab. - Quellcode aktualisieren:
git pull+pnpm install+ weiterhinpnpm gateway:watchverwenden.
Linux (systemd-Benutzerdienst)
Linux-Installationen verwenden einen systemd-Benutzerdienst. Standardmäßig beendet systemd Benutzer- dienste bei der Abmeldung oder im Leerlauf, wodurch der Gateway beendet wird. Das Onboarding versucht, Lingering für Sie zu aktivieren (möglicherweise werden Sie zur Eingabe von sudo aufgefordert). Falls es weiterhin deaktiviert ist, führen Sie Folgendes aus:
sudo loginctl enable-linger $USERFür dauerhaft aktive Server oder Mehrbenutzerserver empfiehlt sich stattdessen ein Systemdienst anstelle eines Benutzerdienstes (kein Lingering erforderlich). Hinweise zu systemd finden Sie im Gateway-Betriebshandbuch.
Verwandte Dokumentation
- Gateway-Betriebshandbuch (Flags, Überwachung, Ports)
- Gateway-Konfiguration (Konfigurationsschema und Beispiele)
- Discord und Telegram (Antwort-Tags und replyToMode-Einstellungen)
- Einrichtung des OpenClaw-Assistenten
- macOS-App (Gateway-Lebenszyklus)