Référence de configuration

Référence de configuration principale pour ~/.openclaw/openclaw.json. Pour une vue d’ensemble orientée tâche, consultez Configuration.

Couvre les principales surfaces de configuration OpenClaw et renvoie vers d’autres pages lorsqu’un sous-système dispose de sa propre référence plus détaillée. Les catalogues de commandes propres aux canaux et aux plugins ainsi que les réglages mémoire/QMD avancés se trouvent sur leurs propres pages plutôt que sur celle-ci.

Vérité du code :

• openclaw config schema affiche le JSON Schema actif utilisé pour la validation et l’interface Control UI, avec les métadonnées intégrées/plugin/canal fusionnées lorsqu’elles sont disponibles
• config.schema.lookup renvoie un nœud de schéma limité à un chemin pour les outils d’exploration détaillée
• pnpm config:docs:check / pnpm config:docs:gen valident le hachage de référence de la documentation de configuration par rapport à la surface de schéma actuelle

Chemin de recherche de l’agent : utilisez l’action d’outil gateway config.schema.lookup pour obtenir la documentation et les contraintes exactes au niveau des champs avant les modifications. Utilisez Configuration pour des conseils orientés tâche et cette page pour la carte plus large des champs, les valeurs par défaut et les liens vers les références des sous-systèmes.

Références approfondies dédiées :

• Référence de configuration de la mémoire pour agents.defaults.memorySearch.*, memory.qmd.*, memory.citations et la configuration de Dreaming sous plugins.entries.memory-core.config.dreaming
• Commandes slash pour le catalogue actuel des commandes intégrées + incluses
• les pages des canaux/plugins propriétaires pour les surfaces de commandes propres aux canaux

Le format de configuration est JSON5 (commentaires + virgules finales autorisés). Tous les champs sont facultatifs - OpenClaw utilise des valeurs par défaut sûres lorsqu’ils sont omis.

# Canaux

Les clés de configuration par canal ont été déplacées vers une page dédiée - consultez Configuration - canaux pour channels.*, y compris Slack, Discord, Telegram, WhatsApp, Matrix, iMessage et les autres canaux inclus (authentification, contrôle d’accès, multi-compte, déclenchement par mention).

# Valeurs par défaut des agents, multi-agent, sessions et messages

Déplacé vers une page dédiée - consultez Configuration - agents pour :

• agents.defaults.* (espace de travail, modèle, raisonnement, Heartbeat, mémoire, médias, Skills, bac à sable)
• multiAgent.* (routage multi-agent et liaisons)
• session.* (cycle de vie de session, Compaction, élagage)
• messages.* (livraison des messages, TTS, rendu markdown)
• talk.* (mode Talk)
  • talk.speechLocale: identifiant de locale BCP 47 facultatif pour la reconnaissance vocale Talk sur iOS/macOS
  • talk.silenceTimeoutMs: lorsqu’il n’est pas défini, Talk conserve la fenêtre de pause par défaut de la plateforme avant d’envoyer la transcription (700 ms on macOS and Android, 900 ms on iOS)

# Outils et fournisseurs personnalisés

La politique des outils, les bascules expérimentales, la configuration des outils adossés à des fournisseurs et la configuration des fournisseurs personnalisés / URL de base ont été déplacées vers une page dédiée - consultez Configuration - outils et fournisseurs personnalisés.

# Modèles

Les définitions de fournisseurs, les listes d’autorisation de modèles et la configuration des fournisseurs personnalisés se trouvent dans Configuration - outils et fournisseurs personnalisés. La racine models possède aussi le comportement global du catalogue de modèles.

{
  models: {
    // Optional. Default: true. Requires a Gateway restart when changed.
    pricing: { enabled: false },
  },
}

• models.mode: comportement du catalogue de fournisseurs (merge ou replace).
• models.providers: carte de fournisseurs personnalisés indexée par identifiant de fournisseur.
• models.pricing.enabled: contrôle l’amorçage des tarifs en arrière-plan qui démarre après que les sidecars et les canaux atteignent le chemin prêt du Gateway. Lorsque false, le Gateway ignore les récupérations des catalogues de tarifs OpenRouter et LiteLLM ; les valeurs models.providers.*.models[].cost configurées continuent de fonctionner pour les estimations de coût locales.

# MCP

Les définitions de serveurs MCP gérées par OpenClaw se trouvent sous mcp.servers et sont consommées par Pi intégré et d’autres adaptateurs d’exécution. Les commandes openclaw mcp list, show, set et unset gèrent ce bloc sans se connecter au serveur cible pendant les modifications de configuration.

{
  mcp: {
    // Optional. Default: 600000 ms (10 minutes). Set 0 to disable idle eviction.
    sessionIdleTtlMs: 600000,
    servers: {
      docs: {
        command: "npx",
        args: ["-y", "@modelcontextprotocol/server-fetch"],
      },
      remote: {
        url: "https://example.com/mcp",
        transport: "streamable-http", // streamable-http | sse
        headers: {
          Authorization: "Bearer ${MCP_REMOTE_TOKEN}",
        },
      },
    },
  },
}

• mcp.servers: définitions nommées de serveurs MCP stdio ou distants pour les environnements d’exécution qui exposent les outils MCP configurés. Les entrées distantes utilisent transport: "streamable-http" ou transport: "sse" ; type: "http" est un alias natif de la CLI que openclaw mcp set et openclaw doctor --fix normalisent dans le champ canonique transport.
• mcp.sessionIdleTtlMs: TTL d’inactivité pour les environnements d’exécution MCP inclus limités à la session. Les exécutions intégrées ponctuelles demandent un nettoyage en fin d’exécution ; ce TTL est le filet de sécurité pour les sessions de longue durée et les futurs appelants.
• Les modifications sous mcp.* s’appliquent à chaud en supprimant les environnements d’exécution MCP de session mis en cache. La prochaine découverte/utilisation d’outil les recrée à partir de la nouvelle configuration, donc les entrées mcp.servers supprimées sont purgées immédiatement au lieu d’attendre le TTL d’inactivité.

Consultez MCP et Backends CLI pour le comportement à l’exécution.

# Skills

{
  skills: {
    allowBundled: ["gemini", "peekaboo"],
    load: {
      extraDirs: ["~/Projects/agent-scripts/skills"],
    },
    install: {
      preferBrew: true,
      nodeManager: "npm", // npm | pnpm | yarn | bun
    },
    entries: {
      "image-lab": {
        apiKey: { source: "env", provider: "default", id: "GEMINI_API_KEY" }, // or plaintext string
        env: { GEMINI_API_KEY: "GEMINI_KEY_HERE" },
      },
      peekaboo: { enabled: true },
      sag: { enabled: false },
    },
  },
}

• allowBundled: liste d’autorisation facultative pour les Skills incluses uniquement (Skills gérées/de l’espace de travail non affectées).
• load.extraDirs: racines de Skills partagées supplémentaires (priorité la plus faible).
• install.preferBrew: lorsque true, privilégie les installateurs Homebrew lorsque brew est disponible avant de revenir à d’autres types d’installateurs.
• install.nodeManager: préférence d’installateur Node pour les spécifications metadata.openclaw.install (npm | pnpm | yarn | bun).
• entries.<skillKey>.enabled: false désactive une Skill même si elle est incluse/installée.
• entries.<skillKey>.apiKey: raccourci pour les Skills déclarant une variable d’environnement principale (chaîne en clair ou objet SecretRef).

# Plugins

{
  plugins: {
    enabled: true,
    allow: ["voice-call"],
    bundledDiscovery: "allowlist",
    deny: [],
    load: {
      paths: ["~/Projects/oss/voice-call-plugin"],
    },
    entries: {
      "voice-call": {
        enabled: true,
        hooks: {
          allowPromptInjection: false,
        },
        config: { provider: "twilio" },
      },
    },
  },
}

• Chargés depuis ~/.openclaw/extensions, <workspace>/.openclaw/extensions, ainsi que plugins.load.paths.
• La découverte accepte les Plugins OpenClaw natifs ainsi que les bundles Codex compatibles et les bundles Claude, y compris les bundles de disposition par défaut Claude sans manifeste.
• Les modifications de configuration nécessitent un redémarrage du Gateway.
• allow: liste d’autorisation facultative (seuls les Plugins listés se chargent). deny l’emporte.
• bundledDiscovery: valeur par défaut "allowlist" pour les nouvelles configurations, de sorte qu’un plugins.allow non vide contrôle aussi les Plugins fournisseurs inclus, y compris les fournisseurs d’exécution de recherche web. Doctor écrit "compat" pour les configurations de liste d’autorisation héritées migrées afin de préserver le comportement existant des fournisseurs inclus jusqu’à votre adhésion explicite.
• plugins.entries.<id>.apiKey: champ de raccourci de clé API au niveau du Plugin (lorsqu’il est pris en charge par le Plugin).
• plugins.entries.<id>.env: carte de variables d’environnement limitée au Plugin.
• plugins.entries.<id>.hooks.allowPromptInjection: lorsque false, le noyau bloque before_prompt_build et ignore les champs qui modifient le prompt provenant de l’ancien before_agent_start, tout en conservant l’ancien modelOverride et providerOverride. S’applique aux hooks de Plugins natifs et aux répertoires de hooks fournis par des bundles pris en charge.
• plugins.entries.<id>.hooks.allowConversationAccess: lorsque true, les Plugins non inclus approuvés peuvent lire le contenu brut des conversations depuis des hooks typés tels que llm_input, llm_output, before_model_resolve, before_agent_reply, before_agent_run, before_agent_finalize et agent_end.
• plugins.entries.<id>.subagent.allowModelOverride: fait explicitement confiance à ce Plugin pour demander des remplacements provider et model par exécution pour les exécutions de sous-agents en arrière-plan.
• plugins.entries.<id>.subagent.allowedModels: liste d’autorisation facultative de cibles canoniques provider/model pour les remplacements de sous-agent approuvés. Utilisez "*" uniquement lorsque vous voulez intentionnellement autoriser n’importe quel modèle.
• plugins.entries.<id>.config: objet de configuration défini par le Plugin (validé par le schéma du Plugin OpenClaw natif lorsqu’il est disponible).
• Les paramètres de compte/d’exécution des Plugins de canal se trouvent sous channels.<id> et doivent être décrits par les métadonnées channelConfigs du manifeste du Plugin propriétaire, et non par un registre central d’options OpenClaw.
• plugins.entries.firecrawl.config.webFetch: paramètres du fournisseur de récupération web Firecrawl.
  • apiKey: clé API Firecrawl (accepte SecretRef). Se replie sur plugins.entries.firecrawl.config.webSearch.apiKey, l’ancien tools.web.fetch.firecrawl.apiKey ou la variable d’environnement FIRECRAWL_API_KEY.
  • baseUrl: URL de base de l’API Firecrawl (par défaut : https://api.firecrawl.dev ; les remplacements auto-hébergés doivent cibler des points de terminaison privés/internes).
  • onlyMainContent: extrait uniquement le contenu principal des pages (par défaut : true).
  • maxAgeMs: âge maximal du cache en millisecondes (par défaut : 172800000 / 2 jours).
  • timeoutSeconds: délai d’expiration de la requête de scraping en secondes (par défaut : 60).
• plugins.entries.xai.config.xSearch: paramètres xAI X Search (recherche web Grok).
  • enabled: active le fournisseur X Search.
  • model: modèle Grok à utiliser pour la recherche (par ex. "grok-4-1-fast").
• plugins.entries.memory-core.config.dreaming: paramètres de Dreaming de mémoire. Consultez Dreaming pour les phases et seuils.
  • enabled: commutateur principal de Dreaming (par défaut false).
  • frequency: cadence Cron pour chaque balayage complet de Dreaming ("0 3 * * *" par défaut).
  • model: remplacement facultatif du modèle de sous-agent Dream Diary. Nécessite plugins.entries.memory-core.subagent.allowModelOverride: true ; associez-le à allowedModels pour limiter les cibles. Les erreurs de modèle indisponible réessaient une fois avec le modèle par défaut de la session ; les échecs de confiance ou de liste d’autorisation ne se replient pas silencieusement.
  • la politique de phase et les seuils sont des détails d’implémentation (pas des clés de configuration destinées aux utilisateurs).
• La configuration complète de la mémoire se trouve dans Référence de configuration de la mémoire :
  • agents.defaults.memorySearch.*
  • memory.backend
  • memory.citations
  • memory.qmd.*
  • plugins.entries.memory-core.config.dreaming
• Les Plugins de bundle Claude activés peuvent aussi contribuer aux valeurs par défaut de Pi intégré depuis settings.json ; OpenClaw les applique comme paramètres d’agent assainis, et non comme correctifs bruts de configuration OpenClaw.
• plugins.slots.memory: sélectionne l’identifiant du Plugin de mémoire actif, ou "none" pour désactiver les Plugins de mémoire.
• plugins.slots.contextEngine: sélectionne l’identifiant du Plugin de moteur de contexte actif ; par défaut "legacy" sauf si vous installez et sélectionnez un autre moteur.

Consultez Plugins.

# Engagements

commitments contrôle la mémoire de suivi inférée : OpenClaw peut détecter les points de suivi dans les tours de conversation et les livrer via des exécutions Heartbeat.

• commitments.enabled: active l’extraction LLM cachée, le stockage et la livraison Heartbeat pour les engagements de suivi inférés. Par défaut : false.
• commitments.maxPerDay: nombre maximal d’engagements de suivi inférés livrés par session d’agent sur une journée glissante. Par défaut : 3.

Consultez Engagements inférés.

# Navigateur

{
  browser: {
    enabled: true,
    evaluateEnabled: true,
    defaultProfile: "user",
    ssrfPolicy: {
      // dangerouslyAllowPrivateNetwork: true, // opt in only for trusted private-network access
      // allowPrivateNetwork: true, // legacy alias
      // hostnameAllowlist: ["*.example.com", "example.com"],
      // allowedHostnames: ["localhost"],
    },
    tabCleanup: {
      enabled: true,
      idleMinutes: 120,
      maxTabsPerSession: 8,
      sweepMinutes: 5,
    },
    profiles: {
      openclaw: { cdpPort: 18800, color: "#FF4500" },
      work: {
        cdpPort: 18801,
        color: "#0066CC",
        executablePath: "/Applications/Google Chrome.app/Contents/MacOS/Google Chrome",
      },
      user: { driver: "existing-session", attachOnly: true, color: "#00AA00" },
      brave: {
        driver: "existing-session",
        attachOnly: true,
        userDataDir: "~/Library/Application Support/BraveSoftware/Brave-Browser",
        color: "#FB542B",
      },
      remote: { cdpUrl: "http://10.0.0.42:9222", color: "#00AA00" },
    },
    color: "#FF4500",
    // headless: false,
    // noSandbox: false,
    // extraArgs: [],
    // executablePath: "/Applications/Brave Browser.app/Contents/MacOS/Brave Browser",
    // attachOnly: false,
  },
}

• evaluateEnabled: false désactive act:evaluate et wait --fn.
• tabCleanup récupère les onglets suivis de l’agent principal après un temps d’inactivité ou lorsqu’une session dépasse sa limite. Définissez idleMinutes: 0 ou maxTabsPerSession: 0 pour désactiver ces modes de nettoyage individuellement.
• ssrfPolicy.dangerouslyAllowPrivateNetwork est désactivé lorsqu’il n’est pas défini, la navigation du navigateur reste donc stricte par défaut.
• Définissez ssrfPolicy.dangerouslyAllowPrivateNetwork: true uniquement lorsque vous faites volontairement confiance à la navigation du navigateur sur le réseau privé.
• En mode strict, les points de terminaison des profils CDP distants (profiles.*.cdpUrl) sont soumis au même blocage du réseau privé pendant les vérifications d’accessibilité et de découverte.
• ssrfPolicy.allowPrivateNetwork reste pris en charge comme alias hérité.
• En mode strict, utilisez ssrfPolicy.hostnameAllowlist et ssrfPolicy.allowedHostnames pour les exceptions explicites.
• Les profils distants sont en attachement seul (démarrage/arrêt/réinitialisation désactivés).
• profiles.*.cdpUrl accepte http://, https://, ws:// et wss://. Utilisez HTTP(S) lorsque vous voulez qu’OpenClaw découvre /json/version ; utilisez WS(S) lorsque votre fournisseur vous donne une URL WebSocket DevTools directe.
• remoteCdpTimeoutMs et remoteCdpHandshakeTimeoutMs s’appliquent à l’accessibilité CDP distante et attachOnly, ainsi qu’aux demandes d’ouverture d’onglets. Les profils local loopback gérés conservent les valeurs CDP locales par défaut.
• Si un service CDP géré en externe est accessible via local loopback, définissez attachOnly: true pour ce profil ; sinon OpenClaw traite le port local loopback comme un profil de navigateur local géré et peut signaler des erreurs de propriété de port local.
• Les profils existing-session utilisent Chrome MCP au lieu de CDP et peuvent s’attacher sur l’hôte sélectionné ou via un nœud de navigateur connecté.
• Les profils existing-session peuvent définir userDataDir pour cibler un profil de navigateur basé sur Chromium spécifique, comme Brave ou Edge.
• Les profils existing-session conservent les limites actuelles de la route Chrome MCP : actions pilotées par snapshot/référence au lieu d’un ciblage par sélecteur CSS, hooks de téléversement d’un seul fichier, aucune substitution de délai d’expiration de boîte de dialogue, pas de wait --load networkidle, et pas de responsebody, d’export PDF, d’interception de téléchargement ni d’actions par lot.
• Les profils openclaw locaux gérés attribuent automatiquement cdpPort et cdpUrl ; ne définissez explicitement cdpUrl que pour le CDP distant.
• Les profils locaux gérés peuvent définir executablePath pour remplacer le browser.executablePath global pour ce profil. Utilisez cela pour exécuter un profil dans Chrome et un autre dans Brave.
• Les profils locaux gérés utilisent browser.localLaunchTimeoutMs pour la découverte HTTP CDP de Chrome après le démarrage du processus et browser.localCdpReadyTimeoutMs pour la disponibilité WebSocket CDP après lancement. Augmentez-les sur les hôtes plus lents où Chrome démarre correctement mais où les vérifications de disponibilité entrent en concurrence avec le démarrage. Les deux valeurs doivent être des entiers positifs jusqu’à 120000 ms ; les valeurs de configuration non valides sont rejetées.
• Ordre de détection automatique : navigateur par défaut s’il est basé sur Chromium → Chrome → Brave → Edge → Chromium → Chrome Canary.
• browser.executablePath et browser.profiles.<name>.executablePath acceptent tous deux ~ et ~/... pour le répertoire personnel de votre OS avant le lancement de Chromium. Le userDataDir par profil des profils existing-session est également développé depuis le tilde.
• Service de contrôle : local loopback uniquement (port dérivé de gateway.port, par défaut 18791).
• extraArgs ajoute des indicateurs de lancement supplémentaires au démarrage local de Chromium (par exemple --disable-gpu, le dimensionnement de fenêtre ou des indicateurs de débogage).

# UI

{
  ui: {
    seamColor: "#FF4500",
    assistant: {
      name: "OpenClaw",
      avatar: "CB", // emoji, short text, image URL, or data URI
    },
  },
}

• seamColor : couleur d’accentuation pour le chrome de l’UI d’application native (teinte de bulle du mode Talk, etc.).
• assistant : remplacement de l’identité de l’UI de contrôle. Se rabat sur l’identité de l’agent actif.

# Gateway

{
  gateway: {
    mode: "local", // local | remote
    port: 18789,
    bind: "loopback",
    auth: {
      mode: "token", // none | token | password | trusted-proxy
      token: "your-token",
      // password: "your-password", // or OPENCLAW_GATEWAY_PASSWORD
      // trustedProxy: { userHeader: "x-forwarded-user" }, // for mode=trusted-proxy; see /gateway/trusted-proxy-auth
      allowTailscale: true,
      rateLimit: {
        maxAttempts: 10,
        windowMs: 60000,
        lockoutMs: 300000,
        exemptLoopback: true,
      },
    },
    tailscale: {
      mode: "off", // off | serve | funnel
      resetOnExit: false,
    },
    controlUi: {
      enabled: true,
      basePath: "/openclaw",
      // root: "dist/control-ui",
      // embedSandbox: "scripts", // strict | scripts | trusted
      // allowExternalEmbedUrls: false, // dangerous: allow absolute external http(s) embed URLs
      // chatMessageMaxWidth: "min(1280px, 82%)", // optional grouped chat message max-width
      // allowedOrigins: ["https://control.example.com"], // required for non-loopback Control UI
      // dangerouslyAllowHostHeaderOriginFallback: false, // dangerous Host-header origin fallback mode
      // allowInsecureAuth: false,
      // dangerouslyDisableDeviceAuth: false,
    },
    remote: {
      url: "ws://gateway.tailnet:18789",
      transport: "ssh", // ssh | direct
      token: "your-token",
      // password: "your-password",
    },
    trustedProxies: ["10.0.0.1"],
    // Optional. Default false.
    allowRealIpFallback: false,
    nodes: {
      pairing: {
        // Optional. Default unset/disabled.
        autoApproveCidrs: ["192.168.1.0/24", "fd00:1234:5678::/64"],
      },
      allowCommands: ["canvas.navigate"],
      denyCommands: ["system.run"],
    },
    tools: {
      // Additional /tools/invoke HTTP denies
      deny: ["browser"],
      // Remove tools from the default HTTP deny list
      allow: ["gateway"],
    },
    push: {
      apns: {
        relay: {
          baseUrl: "https://relay.example.com",
          timeoutMs: 10000,
        },
      },
    },
  },
}

# Points de terminaison compatibles OpenAI

• Chat Completions : désactivé par défaut. Activez avec gateway.http.endpoints.chatCompletions.enabled: true.
• Responses API : gateway.http.endpoints.responses.enabled.
• Durcissement des entrées URL Responses :
  • gateway.http.endpoints.responses.maxUrlParts
  • gateway.http.endpoints.responses.files.urlAllowlist
  • gateway.http.endpoints.responses.images.urlAllowlist Les listes d’autorisation vides sont traitées comme non définies ; utilisez gateway.http.endpoints.responses.files.allowUrl=false et/ou gateway.http.endpoints.responses.images.allowUrl=false pour désactiver la récupération d’URL.
• En-tête facultatif de durcissement des réponses :
  • gateway.http.securityHeaders.strictTransportSecurity (à définir uniquement pour les origines HTTPS que vous contrôlez ; voir Authentification par proxy de confiance)

# Isolation multi-instance

Exécutez plusieurs Gateways sur un même hôte avec des ports et répertoires d’état uniques :

OPENCLAW_CONFIG_PATH=~/.openclaw/a.json \
OPENCLAW_STATE_DIR=~/.openclaw-a \
openclaw gateway --port 19001

Indicateurs de commodité : --dev (utilise ~/.openclaw-dev + port 19001), --profile <name> (utilise ~/.openclaw-<name>).

Voir Gateways multiples.

# gateway.tls

{
  gateway: {
    tls: {
      enabled: false,
      autoGenerate: false,
      certPath: "/etc/openclaw/tls/server.crt",
      keyPath: "/etc/openclaw/tls/server.key",
      caPath: "/etc/openclaw/tls/ca-bundle.crt",
    },
  },
}

• enabled : active la terminaison TLS sur l’écouteur Gateway (HTTPS/WSS) (par défaut : false).
• autoGenerate : génère automatiquement une paire cert/clé locale auto-signée lorsque des fichiers explicites ne sont pas configurés ; réservé à l’usage local/dev.
• certPath : chemin du système de fichiers vers le fichier de certificat TLS.
• keyPath : chemin du système de fichiers vers le fichier de clé privée TLS ; gardez des permissions restreintes.
• caPath : chemin facultatif vers un bundle CA pour la vérification client ou les chaînes de confiance personnalisées.

# gateway.reload

{
  gateway: {
    reload: {
      mode: "hybrid", // off | restart | hot | hybrid
      debounceMs: 500,
      deferralTimeoutMs: 300000,
    },
  },
}

• mode : contrôle la façon dont les modifications de configuration sont appliquées à l’exécution.
  • "off" : ignore les modifications en direct ; les changements nécessitent un redémarrage explicite.
  • "restart" : redémarre toujours le processus Gateway lors d’un changement de configuration.
  • "hot" : applique les changements dans le processus sans redémarrage.
  • "hybrid" (par défaut) : essaie d’abord le rechargement à chaud ; revient au redémarrage si nécessaire.
• debounceMs : fenêtre de debounce en ms avant l’application des changements de configuration (entier non négatif).
• deferralTimeoutMs : durée maximale facultative en ms à attendre pour les opérations en cours avant de forcer un redémarrage ou un rechargement à chaud du canal. Omettez-la pour utiliser l’attente bornée par défaut (300000) ; définissez 0 pour attendre indéfiniment et journaliser périodiquement des avertissements indiquant que des opérations sont toujours en attente.

# Hooks

{
  hooks: {
    enabled: true,
    token: "shared-secret",
    path: "/hooks",
    maxBodyBytes: 262144,
    defaultSessionKey: "hook:ingress",
    allowRequestSessionKey: true,
    allowedSessionKeyPrefixes: ["hook:", "hook:gmail:"],
    allowedAgentIds: ["hooks", "main"],
    presets: ["gmail"],
    transformsDir: "~/.openclaw/hooks/transforms",
    mappings: [
      {
        match: { path: "gmail" },
        action: "agent",
        agentId: "hooks",
        wakeMode: "now",
        name: "Gmail",
        sessionKey: "hook:gmail:{{messages[0].id}}",
        messageTemplate: "From: {{messages[0].from}}\nSubject: {{messages[0].subject}}\n{{messages[0].snippet}}",
        deliver: true,
        channel: "last",
        model: "openai/gpt-5.4-mini",
      },
    ],
  },
}

Authentification : Authorization: Bearer <token> ou x-openclaw-token: <token>. Les jetons de hooks dans la chaîne de requête sont refusés.

Notes de validation et de sécurité :

• hooks.enabled=true nécessite un hooks.token non vide.
• hooks.token doit être distinct de gateway.auth.token ; la réutilisation du jeton du Gateway est refusée.
• hooks.path ne peut pas être / ; utilisez un sous-chemin dédié comme /hooks.
• Si hooks.allowRequestSessionKey=true, limitez hooks.allowedSessionKeyPrefixes (par exemple ["hook:"]).
• Si un mapping ou un préréglage utilise une sessionKey avec modèle, définissez hooks.allowedSessionKeyPrefixes et hooks.allowRequestSessionKey=true. Les clés de mapping statiques ne nécessitent pas cette adhésion explicite.

Points de terminaison :

• POST /hooks/wake → { text, mode?: "now"|"next-heartbeat" }
• POST /hooks/agent → { message, name?, agentId?, sessionKey?, wakeMode?, deliver?, channel?, to?, model?, thinking?, timeoutSeconds? }
  • sessionKey issue de la charge utile de la requête n’est acceptée que lorsque hooks.allowRequestSessionKey=true (par défaut : false).
• POST /hooks/<name> → résolu via hooks.mappings
  • Les valeurs sessionKey de mapping rendues depuis un modèle sont traitées comme fournies depuis l’extérieur et nécessitent également hooks.allowRequestSessionKey=true.

# Intégration Gmail

• Le préréglage Gmail intégré utilise sessionKey: "hook:gmail:{{messages[0].id}}".
• Si vous conservez ce routage par message, définissez hooks.allowRequestSessionKey: true et limitez hooks.allowedSessionKeyPrefixes pour correspondre à l’espace de noms Gmail, par exemple ["hook:", "hook:gmail:"].
• Si vous avez besoin de hooks.allowRequestSessionKey: false, remplacez le préréglage par une sessionKey statique au lieu de la valeur par défaut avec modèle.

{
  hooks: {
    gmail: {
      account: "[email protected]",
      topic: "projects/<project-id>/topics/gog-gmail-watch",
      subscription: "gog-gmail-watch-push",
      pushToken: "shared-push-token",
      hookUrl: "http://127.0.0.1:18789/hooks/gmail",
      includeBody: true,
      maxBytes: 20000,
      renewEveryMinutes: 720,
      serve: { bind: "127.0.0.1", port: 8788, path: "/" },
      tailscale: { mode: "funnel", path: "/gmail-pubsub" },
      model: "openrouter/meta-llama/llama-3.3-70b-instruct:free",
      thinking: "off",
    },
  },
}

• Le Gateway démarre automatiquement gog gmail watch serve au démarrage lorsqu’il est configuré. Définissez OPENCLAW_SKIP_GMAIL_WATCHER=1 pour désactiver.
• N’exécutez pas un gog gmail watch serve séparé en parallèle du Gateway.

# Hôte du Plugin Canvas

{
  plugins: {
    entries: {
      canvas: {
        config: {
          host: {
            root: "~/.openclaw/workspace/canvas",
            liveReload: true,
            // enabled: false, // or OPENCLAW_SKIP_CANVAS_HOST=1
          },
        },
      },
    },
  },
}

• Sert du HTML/CSS/JS modifiable par l’agent et A2UI via HTTP sous le port du Gateway :
  • http://<gateway-host>:<gateway.port>/__openclaw__/canvas/
  • http://<gateway-host>:<gateway.port>/__openclaw__/a2ui/
• Local uniquement : gardez gateway.bind: "loopback" (par défaut).
• Liaisons non-loopback : les routes canvas nécessitent l’authentification du Gateway (jeton/mot de passe/proxy de confiance), comme les autres surfaces HTTP du Gateway.
• Les WebViews Node n’envoient généralement pas d’en-têtes d’authentification ; après l’appairage et la connexion d’un nœud, le Gateway annonce des URL de capacité limitées au nœud pour l’accès canvas/A2UI.
• Les URL de capacité sont liées à la session WS active du nœud et expirent rapidement. Le repli basé sur l’IP n’est pas utilisé.
• Injecte le client de rechargement à chaud dans le HTML servi.
• Crée automatiquement un index.html de démarrage quand le répertoire est vide.
• Sert également A2UI sur /__openclaw__/a2ui/.
• Les modifications nécessitent un redémarrage du Gateway.
• Désactivez le rechargement à chaud pour les grands répertoires ou les erreurs EMFILE.

# Découverte

# mDNS (Bonjour)

{
  discovery: {
    mdns: {
      mode: "minimal", // minimal | full | off
    },
  },
}

• minimal (par défaut lorsque le Plugin bonjour intégré est activé) : omet cliPath + sshPort des enregistrements TXT.
• full : inclut cliPath + sshPort ; l’annonce multicast LAN nécessite toujours que le Plugin bonjour intégré soit activé.
• off : supprime l’annonce multicast LAN sans modifier l’activation du Plugin.
• Le Plugin bonjour intégré démarre automatiquement sur les hôtes macOS et est optionnel sur Linux, Windows et les déploiements Gateway conteneurisés.
• Le nom d’hôte utilise par défaut le nom d’hôte système lorsqu’il s’agit d’une étiquette DNS valide, avec repli sur openclaw. Remplacez-le avec OPENCLAW_MDNS_HOSTNAME.

# Zone étendue (DNS-SD)

{
  discovery: {
    wideArea: { enabled: true },
  },
}

Écrit une zone DNS-SD unicast sous ~/.openclaw/dns/. Pour la découverte entre réseaux, associez-la à un serveur DNS (CoreDNS recommandé) + DNS fractionné Tailscale.

Configuration : openclaw dns setup --apply.

# Environnement

# env (variables d'environnement inline)

{
  env: {
    OPENROUTER_API_KEY: "sk-or-...",
    vars: {
      GROQ_API_KEY: "gsk-...",
    },
    shellEnv: {
      enabled: true,
      timeoutMs: 15000,
    },
  },
}

• Les variables d'environnement inline ne sont appliquées que si la variable est absente de l'environnement du processus.
• Fichiers .env : .env du CWD + ~/.openclaw/.env (aucun ne remplace les variables existantes).
• shellEnv : importe les clés attendues manquantes depuis le profil de votre shell de connexion.
• Consultez Environnement pour l'ordre de priorité complet.

# Substitution des variables d'environnement

Référencez des variables d'environnement dans n'importe quelle chaîne de configuration avec ${VAR_NAME} :

{
  gateway: {
    auth: { token: "${OPENCLAW_GATEWAY_TOKEN}" },
  },
}

• Seuls les noms en majuscules correspondent : [A-Z_][A-Z0-9_]*.
• Les variables manquantes/vides déclenchent une erreur au chargement de la configuration.
• Échappez avec $${VAR} pour un ${VAR} littéral.
• Fonctionne avec $include.

# Secrets

Les références de secrets sont additives : les valeurs en texte clair fonctionnent toujours.

# SecretRef

Utilisez une seule forme d'objet :

{ source: "env" | "file" | "exec", provider: "default", id: "..." }

Validation :

• Motif de provider : ^[a-z][a-z0-9_-]{0,63}$
• Motif d'id source: "env" : ^[A-Z][A-Z0-9_]{0,127}$
• id source: "file" : pointeur JSON absolu (par exemple "/providers/openai/apiKey")
• Motif d'id source: "exec" : ^[A-Za-z0-9][A-Za-z0-9._:/-]{0,255}$
• Les ids source: "exec" ne doivent pas contenir de segments de chemin délimités par des barres obliques . ou .. (par exemple, a/../b est rejeté)

# Surface d'identifiants prise en charge

• Matrice canonique : Surface d'identifiants SecretRef
• secrets apply cible les chemins d'identifiants openclaw.json pris en charge.
• Les références auth-profiles.json sont incluses dans la résolution à l'exécution et la couverture d'audit.

# Configuration des fournisseurs de secrets

{
  secrets: {
    providers: {
      default: { source: "env" }, // optional explicit env provider
      filemain: {
        source: "file",
        path: "~/.openclaw/secrets.json",
        mode: "json",
        timeoutMs: 5000,
      },
      vault: {
        source: "exec",
        command: "/usr/local/bin/openclaw-vault-resolver",
        passEnv: ["PATH", "VAULT_ADDR"],
      },
    },
    defaults: {
      env: "default",
      file: "filemain",
      exec: "vault",
    },
  },
}

Notes :

• Le fournisseur file prend en charge mode: "json" et mode: "singleValue" (id doit être "value" en mode singleValue).
• Les chemins des fournisseurs file et exec échouent en mode fermé lorsque la vérification des ACL Windows n'est pas disponible. Définissez allowInsecurePath: true uniquement pour les chemins de confiance qui ne peuvent pas être vérifiés.
• Le fournisseur exec exige un chemin command absolu et utilise des charges utiles de protocole sur stdin/stdout.
• Par défaut, les chemins de commande sous forme de lien symbolique sont rejetés. Définissez allowSymlinkCommand: true pour autoriser les chemins de lien symbolique tout en validant le chemin cible résolu.
• Si trustedDirs est configuré, la vérification du répertoire de confiance s'applique au chemin cible résolu.
• L'environnement enfant exec est minimal par défaut ; transmettez explicitement les variables requises avec passEnv.
• Les références de secrets sont résolues au moment de l'activation dans un instantané en mémoire, puis les chemins de requête lisent uniquement l'instantané.
• Le filtrage de surface active s'applique pendant l'activation : les références non résolues sur les surfaces activées font échouer le démarrage/rechargement, tandis que les surfaces inactives sont ignorées avec des diagnostics.

# Stockage de l'authentification

{
  auth: {
    profiles: {
      "anthropic:default": { provider: "anthropic", mode: "api_key" },
      "anthropic:work": { provider: "anthropic", mode: "api_key" },
      "openai-codex:personal": { provider: "openai-codex", mode: "oauth" },
    },
    order: {
      anthropic: ["anthropic:default", "anthropic:work"],
      "openai-codex": ["openai-codex:personal"],
    },
  },
}

• Les profils par agent sont stockés dans <agentDir>/auth-profiles.json.
• auth-profiles.json prend en charge les références au niveau des valeurs (keyRef pour api_key, tokenRef pour token) pour les modes d'identifiants statiques.
• Les anciennes cartes plates auth-profiles.json telles que { "provider": { "apiKey": "..." } } ne sont pas un format d'exécution ; openclaw doctor --fix les réécrit en profils de clé API canoniques provider:default avec une sauvegarde .legacy-flat.*.bak.
• Les profils en mode OAuth (auth.profiles.<id>.mode = "oauth") ne prennent pas en charge les identifiants de profil d'authentification adossés à SecretRef.
• Les identifiants d'exécution statiques proviennent d'instantanés résolus en mémoire ; les anciennes entrées statiques auth.json sont nettoyées lorsqu'elles sont découvertes.
• Les anciens imports OAuth proviennent de ~/.openclaw/credentials/oauth.json.
• Consultez OAuth.
• Comportement d'exécution des secrets et outils audit/configure/apply : Gestion des secrets.

# auth.cooldowns

{
  auth: {
    cooldowns: {
      billingBackoffHours: 5,
      billingBackoffHoursByProvider: { anthropic: 3, openai: 8 },
      billingMaxHours: 24,
      authPermanentBackoffMinutes: 10,
      authPermanentMaxMinutes: 60,
      failureWindowHours: 24,
      overloadedProfileRotations: 1,
      overloadedBackoffMs: 0,
      rateLimitedProfileRotations: 1,
    },
  },
}

• billingBackoffHours: délai d’attente de base en heures lorsqu’un profil échoue en raison de véritables erreurs de facturation/crédit insuffisant (par défaut : 5). Le texte explicite de facturation peut toujours arriver ici même sur des réponses 401/403, mais les correspondances de texte propres au fournisseur restent limitées au fournisseur qui les possède (par exemple OpenRouter Key limit exceeded). Les messages HTTP 402 réessayables liés à la fenêtre d’utilisation ou à la limite de dépenses de l’organisation/de l’espace de travail restent plutôt dans le chemin rate_limit.
• billingBackoffHoursByProvider: remplacements facultatifs par fournisseur pour les heures de délai d’attente de facturation.
• billingMaxHours: plafond en heures pour la croissance exponentielle du délai d’attente de facturation (par défaut : 24).
• authPermanentBackoffMinutes: délai d’attente de base en minutes pour les échecs auth_permanent à haute confiance (par défaut : 10).
• authPermanentMaxMinutes: plafond en minutes pour la croissance du délai d’attente auth_permanent (par défaut : 60).
• failureWindowHours: fenêtre glissante en heures utilisée pour les compteurs de délai d’attente (par défaut : 24).
• overloadedProfileRotations: nombre maximal de rotations de profils d’authentification du même fournisseur pour les erreurs de surcharge avant de basculer vers le modèle de secours (par défaut : 1). Les formes de fournisseur occupé telles que ModelNotReadyException arrivent ici.
• overloadedBackoffMs: délai fixe avant de réessayer une rotation de fournisseur/profil surchargé (par défaut : 0).
• rateLimitedProfileRotations: nombre maximal de rotations de profils d’authentification du même fournisseur pour les erreurs de limite de débit avant de basculer vers le modèle de secours (par défaut : 1). Ce compartiment de limite de débit inclut du texte formaté par les fournisseurs comme Too many concurrent requests, ThrottlingException, concurrency limit reached, workers_ai ... quota limit exceeded et resource exhausted.

# Journalisation

{
  logging: {
    level: "info",
    file: "/tmp/openclaw/openclaw.log",
    consoleLevel: "info",
    consoleStyle: "pretty", // pretty | compact | json
    redactSensitive: "tools", // off | tools
    redactPatterns: ["\\bTOKEN\\b\\s*[=:]\\s*([\"']?)([^\\s\"']+)\\1"],
  },
}

• Fichier journal par défaut : /tmp/openclaw/openclaw-YYYY-MM-DD.log.
• Définissez logging.file pour un chemin stable.
• consoleLevel passe à debug avec --verbose.
• maxFileBytes: taille maximale du fichier journal actif en octets avant rotation (entier positif ; par défaut : 104857600 = 100 Mo). OpenClaw conserve jusqu’à cinq archives numérotées à côté du fichier actif.
• redactSensitive / redactPatterns: masquage au mieux pour la sortie console, les journaux de fichiers, les enregistrements de journaux OTLP et le texte persistant des transcriptions de session. redactSensitive: "off" désactive uniquement cette politique générale de journalisation/transcription ; les surfaces de sécurité de l’interface utilisateur, des outils et des diagnostics masquent toujours les secrets avant émission.

# Diagnostics

{
  diagnostics: {
    enabled: true,
    flags: ["telegram.*"],
    stuckSessionWarnMs: 30000,
    stuckSessionAbortMs: 600000,

    otel: {
      enabled: false,
      endpoint: "https://otel-collector.example.com:4318",
      tracesEndpoint: "https://traces.example.com/v1/traces",
      metricsEndpoint: "https://metrics.example.com/v1/metrics",
      logsEndpoint: "https://logs.example.com/v1/logs",
      protocol: "http/protobuf", // http/protobuf | grpc
      headers: { "x-tenant-id": "my-org" },
      serviceName: "openclaw-gateway",
      traces: true,
      metrics: true,
      logs: false,
      sampleRate: 1.0,
      flushIntervalMs: 5000,
      captureContent: {
        enabled: false,
        inputMessages: false,
        outputMessages: false,
        toolInputs: false,
        toolOutputs: false,
        systemPrompt: false,
      },
    },

    cacheTrace: {
      enabled: false,
      filePath: "~/.openclaw/logs/cache-trace.jsonl",
      includeMessages: true,
      includePrompt: true,
      includeSystem: true,
    },
  },
}

• enabled: commutateur principal pour la sortie d’instrumentation (par défaut : true).
• flags: tableau de chaînes d’indicateurs activant une sortie de journal ciblée (prend en charge les jokers comme "telegram.*" ou "*").
• stuckSessionWarnMs: seuil d’âge sans progression en ms pour classer les sessions de traitement de longue durée comme session.long_running, session.stalled ou session.stuck. Les réponses, outils, statuts, blocs et la progression ACP réinitialisent le minuteur ; les diagnostics session.stuck répétés appliquent un délai d’attente lorsqu’ils restent inchangés.
• stuckSessionAbortMs: seuil d’âge sans progression en ms avant que le travail actif bloqué admissible puisse être vidangé par abandon pour récupération. Lorsqu’il n’est pas défini, OpenClaw utilise la fenêtre d’exécution intégrée étendue plus sûre d’au moins 10 minutes et 5x stuckSessionWarnMs.
• otel.enabled: active le pipeline d’export OpenTelemetry (par défaut : false). Pour la configuration complète, le catalogue de signaux et le modèle de confidentialité, consultez Export OpenTelemetry.
• otel.endpoint: URL du collecteur pour l’export OTel.
• otel.tracesEndpoint / otel.metricsEndpoint / otel.logsEndpoint: points de terminaison OTLP facultatifs propres à chaque signal. Lorsqu’ils sont définis, ils remplacent otel.endpoint uniquement pour ce signal.
• otel.protocol: "http/protobuf" (par défaut) ou "grpc".
• otel.headers: en-têtes de métadonnées HTTP/gRPC supplémentaires envoyés avec les requêtes d’export OTel.
• otel.serviceName: nom du service pour les attributs de ressource.
• otel.traces / otel.metrics / otel.logs: active l’export des traces, des métriques ou des journaux.
• otel.sampleRate: taux d’échantillonnage des traces 0-1.
• otel.flushIntervalMs: intervalle de vidage périodique de la télémétrie en ms.
• otel.captureContent: capture facultative du contenu brut pour les attributs de spans OTEL. Désactivée par défaut. Le booléen true capture le contenu non système des messages/outils ; la forme objet permet d’activer explicitement inputMessages, outputMessages, toolInputs, toolOutputs et systemPrompt.
• OTEL_SEMCONV_STABILITY_OPT_IN=gen_ai_latest_experimental: commutateur d’environnement pour les derniers attributs expérimentaux de fournisseur de span GenAI. Par défaut, les spans conservent l’attribut hérité gen_ai.system pour la compatibilité ; les métriques GenAI utilisent des attributs sémantiques bornés.
• OPENCLAW_OTEL_PRELOADED=1: commutateur d’environnement pour les hôtes ayant déjà enregistré un SDK OpenTelemetry global. OpenClaw ignore alors le démarrage/l’arrêt du SDK appartenant au plugin tout en conservant les écouteurs de diagnostic actifs.
• OTEL_EXPORTER_OTLP_TRACES_ENDPOINT, OTEL_EXPORTER_OTLP_METRICS_ENDPOINT et OTEL_EXPORTER_OTLP_LOGS_ENDPOINT: variables d’environnement de point de terminaison propres au signal utilisées lorsque la clé de configuration correspondante n’est pas définie.
• cacheTrace.enabled: journalise les instantanés de trace de cache pour les exécutions intégrées (par défaut : false).
• cacheTrace.filePath: chemin de sortie pour le JSONL de trace de cache (par défaut : $OPENCLAW_STATE_DIR/logs/cache-trace.jsonl).
• cacheTrace.includeMessages / includePrompt / includeSystem: contrôlent ce qui est inclus dans la sortie de trace de cache (tous par défaut : true).

# Mise à jour

{
  update: {
    channel: "stable", // stable | beta | dev
    checkOnStart: true,

    auto: {
      enabled: false,
      stableDelayHours: 6,
      stableJitterHours: 12,
      betaCheckIntervalHours: 1,
    },
  },
}

• channel: canal de publication pour les installations npm/git - "stable", "beta" ou "dev".
• checkOnStart: vérifie les mises à jour npm au démarrage du gateway (par défaut : true).
• auto.enabled: active la mise à jour automatique en arrière-plan pour les installations de paquets (par défaut : false).
• auto.stableDelayHours: délai minimal en heures avant l’application automatique du canal stable (par défaut : 6 ; max : 168).
• auto.stableJitterHours: fenêtre supplémentaire en heures pour étaler le déploiement du canal stable (par défaut : 12 ; max : 168).
• auto.betaCheckIntervalHours: fréquence des vérifications du canal bêta, en heures (par défaut : 1 ; max : 24).

# ACP

{
  acp: {
    enabled: true,
    dispatch: { enabled: true },
    backend: "acpx",
    defaultAgent: "main",
    allowedAgents: ["main", "ops"],
    maxConcurrentSessions: 10,

    stream: {
      coalesceIdleMs: 50,
      maxChunkChars: 1000,
      repeatSuppression: true,
      deliveryMode: "live", // live | final_only
      hiddenBoundarySeparator: "paragraph", // none | space | newline | paragraph
      maxOutputChars: 50000,
      maxSessionUpdateChars: 500,
    },

    runtime: {
      ttlMinutes: 30,
    },
  },
}

• enabled: garde-fou global de la fonctionnalité ACP (par défaut : true ; définissez false pour masquer l’envoi ACP et les affordances de lancement).
• dispatch.enabled: garde-fou indépendant pour l’envoi des tours de session ACP (par défaut : true). Définissez false pour garder les commandes ACP disponibles tout en bloquant l’exécution.
• backend: id par défaut du backend d’exécution ACP (doit correspondre à un plugin d’exécution ACP enregistré). Installez d’abord le plugin de backend, et si plugins.allow est défini, incluez l’id du plugin de backend (par exemple acpx) sinon le backend ACP ne se chargera pas.
• defaultAgent: id d’agent cible ACP de secours lorsque les lancements ne spécifient pas de cible explicite.
• allowedAgents: liste d’autorisation des ids d’agents permis pour les sessions d’exécution ACP ; vide signifie aucune restriction supplémentaire.
• maxConcurrentSessions: nombre maximal de sessions ACP actives simultanément.
• stream.coalesceIdleMs: fenêtre de vidage d’inactivité en ms pour le texte diffusé en continu.
• stream.maxChunkChars: taille maximale d’un fragment avant division de la projection de bloc diffusé.
• stream.repeatSuppression: supprime les lignes de statut/outil répétées par tour (par défaut : true).
• stream.deliveryMode: "live" diffuse progressivement ; "final_only" met en mémoire tampon jusqu’aux événements terminaux du tour.
• stream.hiddenBoundarySeparator: séparateur avant le texte visible après des événements d’outil masqués (par défaut : "paragraph").
• stream.maxOutputChars: nombre maximal de caractères de sortie de l’assistant projetés par tour ACP.
• stream.maxSessionUpdateChars: nombre maximal de caractères pour les lignes de statut/mise à jour ACP projetées.
• stream.tagVisibility: enregistrement des noms de balises vers des remplacements booléens de visibilité pour les événements diffusés.
• runtime.ttlMinutes: TTL d’inactivité en minutes pour les workers de session ACP avant nettoyage admissible.
• runtime.installCommand: commande d’installation facultative à exécuter lors de l’amorçage d’un environnement d’exécution ACP.

# CLI

{
  cli: {
    banner: {
      taglineMode: "off", // random | default | off
    },
  },
}

• cli.banner.taglineMode contrôle le style de la phrase d’accroche de la bannière :
  • "random" (par défaut) : phrases d’accroche amusantes/saisonnières tournantes.
  • "default" : phrase d’accroche neutre fixe (All your chats, one OpenClaw.).
  • "off" : aucun texte de phrase d’accroche (le titre/la version de la bannière restent affichés).
• Pour masquer toute la bannière (pas seulement les phrases d’accroche), définissez la variable d’environnement OPENCLAW_HIDE_BANNER=1.

# Assistant de configuration

Métadonnées écrites par les flux de configuration guidée de la CLI (onboard, configure, doctor) :

{
  wizard: {
    lastRunAt: "2026-01-01T00:00:00.000Z",
    lastRunVersion: "2026.1.4",
    lastRunCommit: "abc1234",
    lastRunCommand: "configure",
    lastRunMode: "local",
  },
}

# Identité

Consultez les champs d’identité agents.list sous Valeurs par défaut des agents.

# Bridge (hérité, supprimé)

Les versions actuelles n’incluent plus le bridge TCP. Les Nodes se connectent via le WebSocket du Gateway. Les clés bridge.* ne font plus partie du schéma de configuration (la validation échoue jusqu’à leur suppression ; openclaw doctor --fix peut retirer les clés inconnues).

{
"bridge": {
  "enabled": true,
  "port": 18790,
  "bind": "tailnet",
  "tls": {
    "enabled": true,
    "autoGenerate": true
  }
}
}

# Cron

{
  cron: {
    enabled: true,
    maxConcurrentRuns: 2, // cron dispatch + isolated cron agent-turn execution
    webhook: "https://example.invalid/legacy", // deprecated fallback for stored notify:true jobs
    webhookToken: "replace-with-dedicated-token", // optional bearer token for outbound webhook auth
    sessionRetention: "24h", // duration string or false
    runLog: {
      maxBytes: "2mb", // default 2_000_000 bytes
      keepLines: 2000, // default 2000
    },
  },
}

• sessionRetention : durée de conservation des sessions d’exécution Cron isolées terminées avant leur suppression de sessions.json. Contrôle aussi le nettoyage des transcriptions Cron archivées et supprimées. Par défaut : 24h ; définissez sur false pour désactiver.
• runLog.maxBytes : taille maximale par fichier de journal d’exécution (cron/runs/<jobId>.jsonl) avant suppression. Par défaut : 2_000_000 octets.
• runLog.keepLines : lignes les plus récentes conservées lorsque la suppression du journal d’exécution est déclenchée. Par défaut : 2000.
• webhookToken : jeton bearer utilisé pour la livraison POST du Webhook Cron (delivery.mode = "webhook"). S’il est omis, aucun en-tête d’authentification n’est envoyé.
• webhook : URL Webhook de repli héritée obsolète (http/https) utilisée uniquement pour les tâches stockées qui ont encore notify: true.

# cron.retry

{
  cron: {
    retry: {
      maxAttempts: 3,
      backoffMs: [30000, 60000, 300000],
      retryOn: ["rate_limit", "overloaded", "network", "timeout", "server_error"],
    },
  },
}

• maxAttempts : nombre maximal de nouvelles tentatives pour les tâches ponctuelles en cas d’erreurs transitoires (par défaut : 3 ; plage : 0-10).
• backoffMs : tableau des délais d’attente en ms pour chaque nouvelle tentative (par défaut : [30000, 60000, 300000] ; 1 à 10 entrées).
• retryOn : types d’erreurs qui déclenchent de nouvelles tentatives - "rate_limit", "overloaded", "network", "timeout", "server_error". Omettre pour réessayer tous les types transitoires.

S’applique uniquement aux tâches Cron ponctuelles. Les tâches récurrentes utilisent une gestion des échecs distincte.

# cron.failureAlert

{
  cron: {
    failureAlert: {
      enabled: false,
      after: 3,
      cooldownMs: 3600000,
      includeSkipped: false,
      mode: "announce",
      accountId: "main",
    },
  },
}

• enabled : active les alertes d’échec pour les tâches Cron (par défaut : false).
• after : nombre d’échecs consécutifs avant le déclenchement d’une alerte (entier positif, min. : 1).
• cooldownMs : nombre minimal de millisecondes entre deux alertes répétées pour la même tâche (entier non négatif).
• includeSkipped : compte les exécutions ignorées consécutives dans le seuil d’alerte (par défaut : false). Les exécutions ignorées sont suivies séparément et n’affectent pas l’attente après erreur d’exécution.
• mode : mode de livraison - "announce" envoie via un message de canal ; "webhook" publie vers le Webhook configuré.
• accountId : identifiant de compte ou de canal facultatif pour limiter la portée de la livraison des alertes.

# cron.failureDestination

{
  cron: {
    failureDestination: {
      mode: "announce",
      channel: "last",
      to: "channel:C1234567890",
      accountId: "main",
    },
  },
}

• Destination par défaut des notifications d’échec Cron pour toutes les tâches.
• mode : "announce" ou "webhook" ; utilise "announce" par défaut lorsqu’il existe assez de données de cible.
• channel : remplacement du canal pour la livraison par annonce. "last" réutilise le dernier canal de livraison connu.
• to : cible d’annonce explicite ou URL Webhook. Requis pour le mode Webhook.
• accountId : remplacement facultatif du compte pour la livraison.
• Le paramètre delivery.failureDestination propre à une tâche remplace cette valeur globale par défaut.
• Lorsqu’aucune destination d’échec globale ni propre à la tâche n’est définie, les tâches qui livrent déjà via announce se replient sur cette cible d’annonce principale en cas d’échec.
• delivery.failureDestination n’est pris en charge que pour les tâches sessionTarget="isolated", sauf si le delivery.mode principal de la tâche est "webhook".

Voir Tâches Cron. Les exécutions Cron isolées sont suivies comme des tâches en arrière-plan.

# Variables de modèle média

Espaces réservés de modèle développés dans tools.media.models[].args :

# Inclusions de configuration ($include)

Fractionnez la configuration en plusieurs fichiers :

// ~/.openclaw/openclaw.json
{
  gateway: { port: 18789 },
  agents: { $include: "./agents.json5" },
  broadcast: {
    $include: ["./clients/mueller.json5", "./clients/schmidt.json5"],
  },
}

Comportement de fusion :

• Fichier unique : remplace l’objet contenant.
• Tableau de fichiers : fusion profonde dans l’ordre (les derniers remplacent les précédents).
• Clés sœurs : fusionnées après les inclusions (remplacent les valeurs incluses).
• Inclusions imbriquées : jusqu’à 10 niveaux de profondeur.
• Chemins : résolus relativement au fichier qui inclut, mais doivent rester dans le répertoire de configuration de niveau supérieur (dirname de openclaw.json). Les formes absolues/../ sont autorisées uniquement lorsqu’elles se résolvent encore à l’intérieur de cette limite.
• Les écritures appartenant à OpenClaw qui modifient uniquement une section de niveau supérieur sauvegardée par une inclusion à fichier unique écrivent dans ce fichier inclus. Par exemple, plugins install met à jour plugins: { $include: "./plugins.json5" } dans plugins.json5 et laisse openclaw.json intact.
• Les inclusions racine, les tableaux d’inclusions et les inclusions avec remplacements par clés sœurs sont en lecture seule pour les écritures appartenant à OpenClaw ; ces écritures échouent de manière fermée au lieu d’aplatir la configuration.
• Erreurs : messages clairs pour les fichiers manquants, les erreurs d’analyse et les inclusions circulaires.

Connexe : Configuration · Exemples de configuration · Doctor

# Connexe

• Configuration
• Exemples de configuration