Zum Hauptinhalt springen
OpenClaw liest eine optionale -Konfiguration aus ~/.openclaw/openclaw.json. Der aktive Konfigurationspfad muss eine reguläre Datei sein. Symlink-Layouts für openclaw.json werden für von OpenClaw verwaltete Schreibvorgänge nicht unterstützt; ein atomarer Schreibvorgang kann den Pfad ersetzen, statt den Symlink beizubehalten. Wenn Sie die Konfiguration außerhalb des standardmäßigen Zustandsverzeichnisses aufbewahren, setzen Sie OPENCLAW_CONFIG_PATH direkt auf die echte Datei. Wenn die Datei fehlt, verwendet OpenClaw sichere Standardwerte. Häufige Gründe für eine Konfiguration:
  • Kanäle verbinden und steuern, wer dem Bot Nachrichten senden darf
  • Modelle, Tools, Sandboxing oder Automatisierung festlegen (Cron, Hooks)
  • Sitzungen, Medien, Netzwerk oder UI abstimmen
Alle verfügbaren Felder finden Sie in der vollständigen Referenz. Agents und Automatisierungen sollten config.schema.lookup für exakte Dokumentation auf Feldebene verwenden, bevor sie Konfiguration bearbeiten. Nutzen Sie diese Seite für aufgabenorientierte Anleitung und die Konfigurationsreferenz für die breitere Feldübersicht und Standardwerte.
Neu bei der Konfiguration? Beginnen Sie mit openclaw onboard für die interaktive Einrichtung, oder sehen Sie sich den Leitfaden Konfigurationsbeispiele für vollständige Copy-and-paste-Konfigurationen an.

Minimale Konfiguration

// ~/.openclaw/openclaw.json
{
  agents: { defaults: { workspace: "~/.openclaw/workspace" } },
  channels: { whatsapp: { allowFrom: ["+15555550123"] } },
}

Konfiguration bearbeiten

openclaw onboard       # full onboarding flow
openclaw configure     # config wizard

Strikte Validierung

OpenClaw akzeptiert nur Konfigurationen, die vollständig dem Schema entsprechen. Unbekannte Schlüssel, fehlerhafte Typen oder ungültige Werte führen dazu, dass der Gateway den Start verweigert. Die einzige Ausnahme auf Root-Ebene ist $schema (String), damit Editoren JSON-Schema-Metadaten anhängen können.
openclaw config schema gibt das kanonische JSON-Schema aus, das von Control UI und der Validierung verwendet wird. config.schema.lookup ruft einen einzelnen pfadbezogenen Knoten plus Zusammenfassungen der untergeordneten Elemente für Drilldown-Tools ab. Dokumentationsmetadaten der Felder title/description werden durch verschachtelte Objekte, Wildcard- (*), Array-Item- ([]) und anyOf-/ oneOf-/allOf-Zweige weitergegeben. Laufzeit-Schemas für Plugins und Kanäle werden zusammengeführt, wenn die Manifest-Registry geladen ist. Wenn die Validierung fehlschlägt:
  • Der Gateway bootet nicht
  • Nur Diagnosebefehle funktionieren (openclaw doctor, openclaw logs, openclaw health, openclaw status)
  • Führen Sie openclaw doctor aus, um die genauen Probleme zu sehen
  • Führen Sie openclaw doctor --fix (oder --yes) aus, um Reparaturen anzuwenden
Der Gateway behält nach jedem erfolgreichen Start eine vertrauenswürdige letzte bekanntermaßen funktionierende Kopie, aber Start und Hot Reload stellen sie nicht automatisch wieder her. Wenn openclaw.json die Validierung nicht besteht (einschließlich Plugin-lokaler Validierung), schlägt der Gateway-Start fehl oder das Neuladen wird übersprungen und die aktuelle Laufzeit behält die zuletzt akzeptierte Konfiguration. Führen Sie openclaw doctor --fix (oder --yes) aus, um mit Präfixen versehene/überschriebene Konfiguration zu reparieren oder die letzte bekanntermaßen funktionierende Kopie wiederherzustellen. Die Übernahme als letzte bekanntermaßen funktionierende Kopie wird übersprungen, wenn ein Kandidat geschwärzte Secret-Platzhalter wie *** enthält.

Häufige Aufgaben

Jeder Kanal hat seinen eigenen Konfigurationsabschnitt unter channels.<provider>. Einrichtungsschritte finden Sie auf der jeweiligen Kanalseite:Alle Kanäle teilen dasselbe DM-Richtlinienmuster:
{
  channels: {
    telegram: {
      enabled: true,
      botToken: "123:abc",
      dmPolicy: "pairing",   // pairing | allowlist | open | disabled
      allowFrom: ["tg:123"], // only for allowlist/open
    },
  },
}
Legen Sie das primäre Modell und optionale Fallbacks fest:
{
  agents: {
    defaults: {
      model: {
        primary: "anthropic/claude-sonnet-4-6",
        fallbacks: ["openai/gpt-5.4"],
      },
      models: {
        "anthropic/claude-sonnet-4-6": { alias: "Sonnet" },
        "openai/gpt-5.4": { alias: "GPT" },
      },
    },
  },
}
  • agents.defaults.models definiert den Modellkatalog und dient als Allowlist für /model; provider/*-Einträge filtern /model, /models und Modellauswahlen auf ausgewählte Provider, während weiterhin die dynamische Modellerkennung verwendet wird.
  • Verwenden Sie openclaw config set agents.defaults.models '<json>' --strict-json --merge, um Allowlist-Einträge hinzuzufügen, ohne vorhandene Modelle zu entfernen. Einfache Ersetzungen, die Einträge entfernen würden, werden abgelehnt, sofern Sie nicht --replace übergeben.
  • Modellreferenzen verwenden das Format provider/model (z. B. anthropic/claude-opus-4-6).
  • agents.defaults.imageMaxDimensionPx steuert das Herunterskalieren von Transkript-/Tool-Bildern (Standard 1200); niedrigere Werte reduzieren in der Regel die Vision-Token-Nutzung bei screenshotlastigen Läufen.
  • Siehe Models CLI zum Wechseln von Modellen im Chat und Model Failover für Auth-Rotation und Fallback-Verhalten.
  • Für benutzerdefinierte/selbst gehostete Provider siehe Custom providers in der Referenz.
DM-Zugriff wird pro Kanal über dmPolicy gesteuert:
  • "pairing" (Standard): unbekannte Absender erhalten einen einmaligen Pairing-Code zur Genehmigung
  • "allowlist": nur Absender in allowFrom (oder im gekoppelten Allow-Store)
  • "open": alle eingehenden DMs erlauben (erfordert allowFrom: ["*"])
  • "disabled": alle DMs ignorieren
Für Gruppen verwenden Sie groupPolicy + groupAllowFrom oder kanalspezifische Allowlists.Details pro Kanal finden Sie in der vollständigen Referenz.
Gruppennachrichten erfordern standardmäßig eine Erwähnung. Konfigurieren Sie Trigger-Muster pro Agent. Normale Gruppen-/Kanalantworten werden automatisch gepostet; aktivieren Sie den Message-Tool-Pfad für gemeinsam genutzte Räume, in denen der Agent entscheiden soll, wann er spricht:
{
  messages: {
    visibleReplies: "automatic", // set "message_tool" to require message-tool sends everywhere
    groupChat: {
      visibleReplies: "message_tool", // opt-in; visible output requires message(action=send)
      unmentionedInbound: "room_event", // unmentioned always-on group chatter is quiet context
    },
  },
  agents: {
    list: [
      {
        id: "main",
        groupChat: {
          mentionPatterns: ["@openclaw", "openclaw"],
        },
      },
    ],
  },
  channels: {
    whatsapp: {
      groups: { "*": { requireMention: true } },
    },
  },
}
  • Metadaten-Erwähnungen: native @-Erwähnungen (WhatsApp Tap-to-Mention, Telegram @bot usw.)
  • Textmuster: sichere Regex-Muster in mentionPatterns
  • Sichtbare Antworten: messages.visibleReplies kann Message-Tool-Sends global erzwingen; messages.groupChat.visibleReplies überschreibt dies für Gruppen/Kanäle.
  • Siehe vollständige Referenz für sichtbare Antwortmodi, Überschreibungen pro Kanal und Self-Chat-Modus.
Verwenden Sie agents.defaults.skills für eine gemeinsame Basis und überschreiben Sie dann bestimmte Agents mit agents.list[].skills:
{
  agents: {
    defaults: {
      skills: ["github", "weather"],
    },
    list: [
      { id: "writer" }, // inherits github, weather
      { id: "docs", skills: ["docs-search"] }, // replaces defaults
      { id: "locked-down", skills: [] }, // no skills
    ],
  },
}
  • Lassen Sie agents.defaults.skills weg, um Skills standardmäßig uneingeschränkt zu erlauben.
  • Lassen Sie agents.list[].skills weg, um die Standardwerte zu erben.
  • Setzen Sie agents.list[].skills: [], um keine Skills zuzulassen.
  • Siehe Skills, Skills-Konfiguration und die Konfigurationsreferenz.
Steuern Sie, wie aggressiv der Gateway Kanäle neu startet, die veraltet wirken:
{
  gateway: {
    channelHealthCheckMinutes: 5,
    channelStaleEventThresholdMinutes: 30,
    channelMaxRestartsPerHour: 10,
  },
  channels: {
    telegram: {
      healthMonitor: { enabled: false },
      accounts: {
        alerts: {
          healthMonitor: { enabled: true },
        },
      },
    },
  },
}
  • Setzen Sie gateway.channelHealthCheckMinutes: 0, um Health-Monitor-Neustarts global zu deaktivieren.
  • channelStaleEventThresholdMinutes sollte größer oder gleich dem Prüfintervall sein.
  • Verwenden Sie channels.<provider>.healthMonitor.enabled oder channels.<provider>.accounts.<id>.healthMonitor.enabled, um automatische Neustarts für einen Kanal oder Account zu deaktivieren, ohne den globalen Monitor zu deaktivieren.
  • Siehe Health Checks für operative Fehlersuche und die vollständige Referenz für alle Felder.
Geben Sie lokalen Clients mehr Zeit, den Pre-Auth-WebSocket-Handshake auf ausgelasteten oder leistungsschwachen Hosts abzuschließen:
{
  gateway: {
    handshakeTimeoutMs: 30000,
  },
}
  • Standardwert ist 15000 Millisekunden.
  • OPENCLAW_HANDSHAKE_TIMEOUT_MS hat weiterhin Vorrang für einmalige Service- oder Shell-Überschreibungen.
  • Beheben Sie bevorzugt zuerst Start-/Event-Loop-Blockaden; dieser Regler ist für Hosts gedacht, die gesund, aber beim Warmup langsam sind.
Sitzungen steuern Gesprächskontinuität und Isolation:
{
  session: {
    dmScope: "per-channel-peer",  // recommended for multi-user
    threadBindings: {
      enabled: true,
      idleHours: 24,
      maxAgeHours: 0,
    },
    reset: {
      mode: "daily",
      atHour: 4,
      idleMinutes: 120,
    },
  },
}
  • dmScope: main (gemeinsam) | per-peer | per-channel-peer | per-account-channel-peer
  • threadBindings: globale Standardwerte für Thread-gebundenes Sitzungsrouting (Discord unterstützt /focus, /unfocus, /agents, /session idle und /session max-age).
  • Siehe Sitzungsverwaltung für Scoping, Identitätsverknüpfungen und Senderichtlinie.
  • Siehe vollständige Referenz für alle Felder.
Führen Sie Agent-Sitzungen in isolierten Sandbox-Laufzeitumgebungen aus:
{
  agents: {
    defaults: {
      sandbox: {
        mode: "non-main",  // off | non-main | all
        scope: "agent",    // session | agent | shared
      },
    },
  },
}
Erstellen Sie zuerst das Image: Führen Sie aus einem Source-Checkout scripts/sandbox-setup.sh aus, oder lesen Sie bei einer npm-Installation den eingebetteten docker build-Befehl unter Sandboxing § Images und Einrichtung.Siehe Sandboxing für die vollständige Anleitung und vollständige Referenz für alle Optionen.
Relay-gestützter Push für öffentliche App-Store-Builds verwendet das gehostete OpenClaw-Relay: https://ios-push-relay.openclaw.ai.Benutzerdefinierte Relay-Bereitstellungen erfordern einen bewusst separaten iOS-Build-/Bereitstellungspfad, dessen Relay-URL mit der Gateway-Relay-URL übereinstimmt. Wenn Sie einen benutzerdefinierten Relay-Build verwenden, legen Sie dies in der Gateway-Konfiguration fest:
{
  gateway: {
    push: {
      apns: {
        relay: {
          baseUrl: "https://relay.example.com",
          // Optional. Default: 10000
          timeoutMs: 10000,
        },
      },
    },
  },
}
CLI-Entsprechung:
openclaw config set gateway.push.apns.relay.baseUrl https://relay.example.com
Was dies bewirkt:
  • Ermöglicht dem Gateway, push.test, Aufweck-Anstöße und Wiederverbindungs-Wecksignale über das externe Relay zu senden.
  • Verwendet eine registrierungsgebundene Sendeberechtigung, die von der gekoppelten iOS-App weitergeleitet wird. Das Gateway benötigt kein bereitstellungsweites Relay-Token.
  • Bindet jede Relay-gestützte Registrierung an die Gateway-Identität, mit der die iOS-App gekoppelt wurde, sodass ein anderes Gateway die gespeicherte Registrierung nicht wiederverwenden kann.
  • Belässt lokale/manuelle iOS-Builds bei direkten APNs. Relay-gestützte Sendungen gelten nur für offiziell verteilte Builds, die über das Relay registriert wurden.
  • Muss mit der in den iOS-Build eingebetteten Relay-Basis-URL übereinstimmen, damit Registrierungs- und Sendetraffic dieselbe Relay-Bereitstellung erreichen.
End-to-End-Ablauf:
  1. Installieren Sie die offizielle iOS-App.
  2. Optional: Konfigurieren Sie gateway.push.apns.relay.baseUrl auf dem Gateway nur, wenn Sie einen bewusst separaten benutzerdefinierten Relay-Build verwenden.
  3. Koppeln Sie die iOS-App mit dem Gateway und lassen Sie sowohl Node- als auch Operator-Sitzungen eine Verbindung herstellen.
  4. Die iOS-App ruft die Gateway-Identität ab, registriert sich beim Relay mit App Attest plus App-Beleg und veröffentlicht anschließend die Relay-gestützte push.apns.register-Payload an das gekoppelte Gateway.
  5. Das Gateway speichert das Relay-Handle und die Sendeberechtigung und verwendet sie dann für push.test, Aufweck-Anstöße und Wiederverbindungs-Wecksignale.
Betriebshinweise:
  • Wenn Sie die iOS-App auf ein anderes Gateway umstellen, verbinden Sie die App erneut, damit sie eine neue, an dieses Gateway gebundene Relay-Registrierung veröffentlichen kann.
  • Wenn Sie einen neuen iOS-Build ausliefern, der auf eine andere Relay-Bereitstellung zeigt, aktualisiert die App ihre zwischengespeicherte Relay-Registrierung, statt den alten Relay-Ursprung wiederzuverwenden.
Kompatibilitätshinweis:
  • OPENCLAW_APNS_RELAY_BASE_URL und OPENCLAW_APNS_RELAY_TIMEOUT_MS funktionieren weiterhin als temporäre Env-Overrides.
  • Benutzerdefinierte Gateway-Relay-URLs müssen mit der in den iOS-Build eingebetteten Relay-Basis-URL übereinstimmen. Der öffentliche App-Store-Release-Lane lehnt benutzerdefinierte iOS-Relay-URL-Overrides ab.
  • OPENCLAW_APNS_RELAY_ALLOW_HTTP=true bleibt ein nur für local loopback gedachter Entwicklungs-Notausstieg; speichern Sie keine HTTP-Relay-URLs dauerhaft in der Konfiguration.
Siehe iOS-App für den End-to-End-Ablauf und Authentifizierungs- und Vertrauensablauf für das Relay-Sicherheitsmodell.
{
  agents: {
    defaults: {
      heartbeat: {
        every: "30m",
        target: "last",
      },
    },
  },
}
  • every: Dauerzeichenfolge (30m, 2h). Setzen Sie 0m, um zu deaktivieren.
  • target: last | none | <channel-id> (zum Beispiel discord, matrix, telegram oder whatsapp)
  • directPolicy: allow (Standard) oder block für DM-artige Heartbeat-Ziele
  • Siehe Heartbeat für die vollständige Anleitung.
{
  cron: {
    enabled: true,
    maxConcurrentRuns: 8, // default; cron dispatch + isolated cron agent-turn execution
    sessionRetention: "24h",
    runLog: {
      maxBytes: "2mb",
      keepLines: 2000,
    },
  },
}
  • sessionRetention: Entfernt abgeschlossene isolierte Ausführungssitzungen aus sessions.json (Standard 24h; setzen Sie false, um zu deaktivieren).
  • runLog: Entfernt beibehaltene Cron-Ausführungsverlaufszeilen pro Job. maxBytes bleibt für ältere dateibasierte Ausführungslogs akzeptiert.
  • Siehe Cron-Jobs für Funktionsüberblick und CLI-Beispiele.
Aktivieren Sie HTTP-Webhook-Endpunkte auf dem Gateway:
{
  hooks: {
    enabled: true,
    token: "shared-secret",
    path: "/hooks",
    defaultSessionKey: "hook:ingress",
    allowRequestSessionKey: false,
    allowedSessionKeyPrefixes: ["hook:"],
    mappings: [
      {
        match: { path: "gmail" },
        action: "agent",
        agentId: "main",
        deliver: true,
      },
    ],
  },
}
Sicherheitshinweis:
  • Behandeln Sie alle Hook-/Webhook-Payload-Inhalte als nicht vertrauenswürdige Eingaben.
  • Verwenden Sie ein dediziertes hooks.token; verwenden Sie keine aktiven Gateway-Auth-Geheimnisse wieder (gateway.auth.token / OPENCLAW_GATEWAY_TOKEN oder gateway.auth.password / OPENCLAW_GATEWAY_PASSWORD).
  • Hook-Auth erfolgt nur per Header (Authorization: Bearer ... oder x-openclaw-token); Query-String-Token werden abgelehnt.
  • hooks.path darf nicht / sein; halten Sie Webhook-Ingress auf einem dedizierten Unterpfad wie /hooks.
  • Lassen Sie Bypass-Flags für unsichere Inhalte deaktiviert (hooks.gmail.allowUnsafeExternalContent, hooks.mappings[].allowUnsafeExternalContent), außer bei eng begrenztem Debugging.
  • Wenn Sie hooks.allowRequestSessionKey aktivieren, setzen Sie außerdem hooks.allowedSessionKeyPrefixes, um vom Aufrufer ausgewählte Sitzungsschlüssel zu begrenzen.
  • Für Hook-gesteuerte Agents sollten Sie starke moderne Modellstufen und strikte Tool-Richtlinien bevorzugen (zum Beispiel nur Messaging plus Sandboxing, wo möglich).
Siehe vollständige Referenz für alle Mapping-Optionen und die Gmail-Integration.
Führen Sie mehrere isolierte Agents mit separaten Arbeitsbereichen und Sitzungen aus:
{
  agents: {
    list: [
      { id: "home", default: true, workspace: "~/.openclaw/workspace-home" },
      { id: "work", workspace: "~/.openclaw/workspace-work" },
    ],
  },
  bindings: [
    { agentId: "home", match: { channel: "whatsapp", accountId: "personal" } },
    { agentId: "work", match: { channel: "whatsapp", accountId: "biz" } },
  ],
}
Siehe Multi-Agent und vollständige Referenz für Bindungsregeln und Zugriffprofile pro Agent.
Verwenden Sie $include, um große Konfigurationen zu organisieren:
// ~/.openclaw/openclaw.json
{
  gateway: { port: 18789 },
  agents: { $include: "./agents.json5" },
  broadcast: {
    $include: ["./clients/a.json5", "./clients/b.json5"],
  },
}
  • Einzelne Datei: ersetzt das enthaltende Objekt
  • Array von Dateien: wird der Reihe nach tief zusammengeführt (später gewinnt)
  • Geschwisterschlüssel: werden nach Includes zusammengeführt (überschreiben eingeschlossene Werte)
  • Verschachtelte Includes: bis zu 10 Ebenen tief unterstützt
  • Relative Pfade: werden relativ zur einschließenden Datei aufgelöst
  • Pfadformat: Include-Pfade dürfen keine Nullbytes enthalten und müssen vor und nach der Auflösung strikt kürzer als 4096 Zeichen sein
  • OpenClaw-eigene Schreibvorgänge: Wenn ein Schreibvorgang nur einen Top-Level-Abschnitt ändert, der durch einen Single-File-Include wie plugins: { $include: "./plugins.json5" } gestützt wird, aktualisiert OpenClaw diese eingeschlossene Datei und lässt openclaw.json unverändert
  • Nicht unterstütztes Write-through: Root-Includes, Include-Arrays und Includes mit Geschwister-Overrides schlagen für OpenClaw-eigene Schreibvorgänge geschlossen fehl, statt die Konfiguration zu flatten
  • Einschließung: $include-Pfade müssen unter dem Verzeichnis aufgelöst werden, das openclaw.json enthält. Um einen Baum über Maschinen oder Benutzer hinweg zu teilen, setzen Sie OPENCLAW_INCLUDE_ROOTS auf eine Pfadliste (: auf POSIX, ; unter Windows) mit zusätzlichen Verzeichnissen, auf die Includes verweisen dürfen. Symlinks werden aufgelöst und erneut geprüft, sodass ein Pfad, der lexikalisch in einem Konfigurationsverzeichnis liegt, dessen reales Ziel aber alle erlaubten Roots verlässt, dennoch abgelehnt wird.
  • Fehlerbehandlung: klare Fehler für fehlende Dateien, Parse-Fehler, zirkuläre Includes, ungültiges Pfadformat und übermäßige Länge

Config-Hot-Reload

Das Gateway überwacht ~/.openclaw/openclaw.json und wendet Änderungen automatisch an: Für die meisten Einstellungen ist kein manueller Neustart erforderlich. Direkte Dateiänderungen gelten als nicht vertrauenswürdig, bis sie validiert wurden. Der Watcher wartet, bis temporäre Schreib-/Umbenennungsaktivitäten des Editors abgeschlossen sind, liest die finale Datei und lehnt ungültige externe Änderungen ab, ohne openclaw.json neu zu schreiben. OpenClaw-eigene Konfigurations- Schreibvorgänge verwenden vor dem Schreiben dieselbe Schema-Prüfung; destruktives Überschreiben wie das Entfernen von gateway.mode oder das Verkleinern der Datei um mehr als die Hälfte wird abgelehnt und zur Prüfung als .rejected.* gespeichert. Wenn Sie config reload skipped (invalid config) sehen oder der Start Invalid config meldet, prüfen Sie die Konfiguration, führen Sie openclaw config validate aus und führen Sie anschließend openclaw doctor --fix zur Reparatur aus. Siehe Gateway-Fehlerbehebung für die Checkliste.

Reload-Modi

ModusVerhalten
hybrid (Standard)Wendet sichere Änderungen sofort per Hot-Apply an. Startet bei kritischen Änderungen automatisch neu.
hotWendet nur sichere Änderungen per Hot-Apply an. Protokolliert eine Warnung, wenn ein Neustart erforderlich ist - Sie kümmern sich darum.
restartStartet das Gateway bei jeder Konfigurationsänderung neu, ob sicher oder nicht.
offDeaktiviert die Dateiüberwachung. Änderungen werden beim nächsten manuellen Neustart wirksam.
{
  gateway: {
    reload: { mode: "hybrid", debounceMs: 300 },
  },
}

Was per Hot-Apply übernommen wird und was einen Neustart benötigt

Die meisten Felder werden ohne Ausfallzeit per Hot-Apply übernommen. Im Modus hybrid werden Änderungen, die einen Neustart erfordern, automatisch behandelt.
KategorieFelderNeustart erforderlich?
Kanälechannels.*, web (WhatsApp) - alle integrierten und Plugin-KanäleNein
Agent & Modelleagent, agents, models, routingNein
Automatisierunghooks, cron, agent.heartbeatNein
Sitzungen & Nachrichtensession, messagesNein
Tools & Medientools, browser, skills, mcp, audio, talkNein
UI & Sonstigesui, logging, identity, bindingsNein
Gateway-Servergateway.* (Port, Bind, Auth, Tailscale, TLS, HTTP)Ja
Infrastrukturdiscovery, pluginsJa
gateway.reload und gateway.remote sind Ausnahmen - Änderungen daran lösen keinen Neustart aus.

Planung des Neuladens

Wenn Sie eine Quelldatei bearbeiten, die über $include referenziert wird, plant OpenClaw das Neuladen anhand des in der Quelle verfassten Layouts, nicht anhand der abgeflachten Ansicht im Arbeitsspeicher. Dadurch bleiben Entscheidungen für Hot Reload (sofort anwenden vs. Neustart) vorhersehbar, selbst wenn ein einzelner Abschnitt der obersten Ebene in einer eigenen eingebundenen Datei liegt, etwa plugins: { $include: "./plugins.json5" }. Die Planung des Neuladens schlägt geschlossen fehl, wenn das Quelllayout mehrdeutig ist.

Config-RPC (programmatische Updates)

Für Tools, die Konfiguration über die Gateway-API schreiben, bevorzugen Sie diesen Ablauf:
  • config.schema.lookup, um einen Teilbaum zu prüfen (flacher Schemaknoten + Zusammenfassungen der Kinder)
  • config.get, um den aktuellen Snapshot plus hash abzurufen
  • config.patch für Teilupdates (JSON Merge Patch: Objekte werden zusammengeführt, null löscht, Arrays werden ersetzt, wenn dies ausdrücklich mit replacePaths bestätigt wurde, falls Einträge entfernt würden)
  • config.apply nur, wenn Sie die gesamte Konfiguration ersetzen möchten
  • update.run für ein explizites Self-Update plus Neustart; schließen Sie continuationMessage ein, wenn die Sitzung nach dem Neustart einen Folgeturn ausführen soll
  • update.status, um den neuesten Update-Neustart-Sentinel zu prüfen und nach einem Neustart die laufende Version zu verifizieren
Agents sollten config.schema.lookup als erste Anlaufstelle für genaue Dokumentation und Einschränkungen auf Feldebene behandeln. Verwenden Sie die Konfigurationsreferenz, wenn sie die umfassendere Konfigurationsübersicht, Standardwerte oder Links zu dedizierten Subsystemreferenzen benötigen.
Control-Plane-Schreibvorgänge (config.apply, config.patch, update.run) sind auf 3 Anfragen pro 60 Sekunden je deviceId+clientIp begrenzt. Neustart- Anfragen werden zusammengeführt und erzwingen anschließend eine Abkühlzeit von 30 Sekunden zwischen Neustartzyklen. update.status ist schreibgeschützt, aber admin-beschränkt, weil der Neustart-Sentinel Zusammenfassungen von Update-Schritten und Enden von Befehlsausgaben enthalten kann.
Beispiel für einen Teil-Patch:
openclaw gateway call config.get --params '{}'  # capture payload.hash
openclaw gateway call config.patch --params '{
  "raw": "{ channels: { telegram: { groups: { \"*\": { requireMention: false } } } } }",
  "baseHash": "<hash>"
}'
Sowohl config.apply als auch config.patch akzeptieren raw, baseHash, sessionKey, note und restartDelayMs. baseHash ist für beide Methoden erforderlich, wenn bereits eine Konfiguration existiert. config.patch akzeptiert außerdem replacePaths, ein Array von Konfigurationspfaden, deren Array- Ersetzung beabsichtigt ist. Wenn ein Patch ein vorhandenes Array durch eines mit weniger Einträgen ersetzen oder löschen würde, lehnt das Gateway den Schreibvorgang ab, sofern dieser genaue Pfad nicht in replacePaths erscheint; verschachtelte Arrays unter Array-Einträgen verwenden [], etwa agents.list[].skills. Dadurch wird verhindert, dass abgeschnittene config.get-Snapshots Routing- oder Allowlist-Arrays stillschweigend überschreiben. Verwenden Sie config.apply, wenn Sie die vollständige Konfiguration ersetzen möchten.

Umgebungsvariablen

OpenClaw liest Umgebungsvariablen aus dem Elternprozess plus:
  • .env aus dem aktuellen Arbeitsverzeichnis (falls vorhanden)
  • ~/.openclaw/.env (globaler Fallback)
Keine der beiden Dateien überschreibt vorhandene Umgebungsvariablen. Sie können Inline-Umgebungsvariablen auch in der Konfiguration setzen:
{
  env: {
    OPENROUTER_API_KEY: "sk-or-...",
    vars: { GROQ_API_KEY: "gsk-..." },
  },
}
Wenn aktiviert und erwartete Schlüssel nicht gesetzt sind, führt OpenClaw Ihre Login-Shell aus und importiert nur die fehlenden Schlüssel:
{
  env: {
    shellEnv: { enabled: true, timeoutMs: 15000 },
  },
}
Entsprechende Umgebungsvariable: OPENCLAW_LOAD_SHELL_ENV=1
Referenzieren Sie Umgebungsvariablen in beliebigen String-Werten der Konfiguration mit ${VAR_NAME}:
{
  gateway: { auth: { token: "${OPENCLAW_GATEWAY_TOKEN}" } },
  models: { providers: { custom: { apiKey: "${CUSTOM_API_KEY}" } } },
}
Regeln:
  • Nur passende Namen in Großbuchstaben: [A-Z_][A-Z0-9_]*
  • Fehlende/leere Variablen lösen beim Laden einen Fehler aus
  • Mit $${VAR} für literale Ausgabe escapen
  • Funktioniert innerhalb von $include-Dateien
  • Inline-Ersetzung: "${BASE}/v1""https://api.example.com/v1"
Für Felder, die SecretRef-Objekte unterstützen, können Sie Folgendes verwenden:
{
  models: {
    providers: {
      openai: { apiKey: { source: "env", provider: "default", id: "OPENAI_API_KEY" } },
    },
  },
  skills: {
    entries: {
      "image-lab": {
        apiKey: {
          source: "file",
          provider: "filemain",
          id: "/skills/entries/image-lab/apiKey",
        },
      },
    },
  },
  channels: {
    googlechat: {
      serviceAccountRef: {
        source: "exec",
        provider: "vault",
        id: "channels/googlechat/serviceAccount",
      },
    },
  },
}
Details zu SecretRef (einschließlich secrets.providers für env/file/exec) finden Sie unter Secrets Management. Unterstützte Zugangsdatenpfade sind in SecretRef Credential Surface aufgeführt.
Siehe Umgebung für vollständige Rangfolge und Quellen.

Vollständige Referenz

Die vollständige Feld-für-Feld-Referenz finden Sie in der Konfigurationsreferenz.
Verwandt: Konfigurationsbeispiele · Konfigurationsreferenz · Doctor

Verwandt