Configuration

Chaque canal possède sa propre section de configuration sous channels.<provider>. Consultez la page dédiée au canal pour les étapes de configuration :

• WhatsApp - channels.whatsapp
• Telegram - channels.telegram
• Discord - channels.discord
• Feishu - channels.feishu
• Google Chat - channels.googlechat
• Microsoft Teams - channels.msteams
• Slack - channels.slack
• Signal - channels.signal
• iMessage - channels.imessage
• Mattermost - channels.mattermost

Tous les canaux partagent le même modèle de politique de messages privés :

{  channels: {    telegram: {      enabled: true,      botToken: "123:abc",      dmPolicy: "pairing",   // pairing | allowlist | open | disabled      allowFrom: ["tg:123"], // only for allowlist/open    },  },}

Définissez le modèle principal et les bascules facultatives :

{  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 définit le catalogue de modèles et sert de liste d’autorisation pour /model ; les entrées provider/* filtrent /model, /models et les sélecteurs de modèles vers les fournisseurs sélectionnés tout en continuant à utiliser la découverte dynamique des modèles.
• Utilisez openclaw config set agents.defaults.models '<json>' --strict-json --merge pour ajouter des entrées à la liste d’autorisation sans supprimer les modèles existants. Les remplacements simples qui supprimeraient des entrées sont rejetés sauf si vous passez --replace.
• Les références de modèle utilisent le format provider/model (par exemple anthropic/claude-opus-4-6).
• agents.defaults.imageMaxDimensionPx contrôle la réduction d’échelle des images de transcript/outils (par défaut 1200) ; des valeurs plus basses réduisent généralement l’utilisation de jetons de vision lors des exécutions comportant beaucoup de captures d’écran.
• Consultez CLI des modèles pour changer de modèle dans le chat et Bascule de modèle pour la rotation d’authentification et le comportement de secours.
• Pour les fournisseurs personnalisés/auto-hébergés, consultez Fournisseurs personnalisés dans la référence.

L’accès aux messages privés est contrôlé par canal via dmPolicy :

• "pairing" (par défaut) : les expéditeurs inconnus reçoivent un code d’association à usage unique à approuver
• "allowlist" : seuls les expéditeurs dans allowFrom (ou dans le magasin d’autorisations associées)
• "open" : autoriser tous les messages privés entrants (nécessite allowFrom: ["*"])
• "disabled" : ignorer tous les messages privés

Pour les groupes, utilisez groupPolicy + groupAllowFrom ou des listes d’autorisation propres au canal.

Consultez la référence complète pour les détails par canal.

Les messages de groupe exigent par défaut une mention. Configurez les motifs de déclenchement par agent. Les réponses normales de groupe/canal sont publiées automatiquement ; optez pour le chemin message-tool dans les salons partagés où l’agent doit décider quand parler :

{  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 } },    },  },}

• Mentions par métadonnées : @-mentions natives (mention par appui WhatsApp, @bot Telegram, etc.)
• Motifs textuels : motifs regex sûrs dans mentionPatterns
• Réponses visibles : messages.visibleReplies peut exiger des envois via message-tool globalement ; messages.groupChat.visibleReplies remplace ce réglage pour les groupes/canaux.
• Consultez la référence complète pour les modes de réponse visible, les remplacements par canal et le mode self-chat.

Utilisez agents.defaults.skills pour une base partagée, puis remplacez-la pour des agents spécifiques avec 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    ],  },}

• Omettez agents.defaults.skills pour autoriser les skills sans restriction par défaut.
• Omettez agents.list[].skills pour hériter des valeurs par défaut.
• Définissez agents.list[].skills: [] pour n’autoriser aucune skill.
• Consultez Skills, Configuration des Skills et la référence de configuration.

Contrôlez avec quelle agressivité le gateway redémarre les canaux qui semblent obsolètes :

{  gateway: {    channelHealthCheckMinutes: 5,    channelStaleEventThresholdMinutes: 30,    channelMaxRestartsPerHour: 10,  },  channels: {    telegram: {      healthMonitor: { enabled: false },      accounts: {        alerts: {          healthMonitor: { enabled: true },        },      },    },  },}

• Définissez gateway.channelHealthCheckMinutes: 0 pour désactiver globalement les redémarrages du moniteur de santé.
• channelStaleEventThresholdMinutes doit être supérieur ou égal à l’intervalle de vérification.
• Utilisez channels.<provider>.healthMonitor.enabled ou channels.<provider>.accounts.<id>.healthMonitor.enabled pour désactiver les redémarrages automatiques d’un canal ou d’un compte sans désactiver le moniteur global.
• Consultez Health Checks pour le débogage opérationnel et la référence complète pour tous les champs.

Donnez aux clients locaux plus de temps pour terminer la négociation WebSocket de pré-authentification sur des hôtes chargés ou peu puissants :

{  gateway: {    handshakeTimeoutMs: 30000,  },}

• La valeur par défaut est 15000 millisecondes.
• OPENCLAW_HANDSHAKE_TIMEOUT_MS reste prioritaire pour des remplacements ponctuels de service ou de shell.
• Préférez corriger d’abord les blocages de démarrage/boucle d’événements ; ce réglage est destiné aux hôtes sains mais lents pendant la mise en route.

Les sessions contrôlent la continuité et l’isolation des conversations :

{  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 (partagé) | per-peer | per-channel-peer | per-account-channel-peer
• threadBindings : paramètres par défaut globaux pour le routage des sessions liées à un fil (Discord prend en charge /focus, /unfocus, /agents, /session idle et /session max-age).
• Voir Gestion des sessions pour le périmètre, les liens d’identité et la politique d’envoi.
• Voir la référence complète pour tous les champs.

Exécutez les sessions d’agent dans des runtimes de bac à sable isolés :

{  agents: {    defaults: {      sandbox: {        mode: "non-main",  // off | non-main | all        scope: "agent",    // session | agent | shared      },    },  },}

Construisez d’abord l’image - depuis un checkout source, exécutez scripts/sandbox-setup.sh, ou depuis une installation npm, consultez la commande docker build intégrée dans Bac à sable § Images et configuration.

Voir Bac à sable pour le guide complet et la référence complète pour toutes les options.

Les notifications push adossées au relais pour les builds publiques de l’App Store utilisent le relais OpenClaw hébergé : https://ios-push-relay.openclaw.ai.

Les déploiements de relais personnalisés nécessitent un chemin de build/déploiement iOS volontairement séparé dont l’URL de relais correspond à l’URL de relais du Gateway. Si vous utilisez une build de relais personnalisée, définissez ceci dans la configuration du Gateway :

{  gateway: {    push: {      apns: {        relay: {          baseUrl: "https://relay.example.com",          // Optional. Default: 10000          timeoutMs: 10000,        },      },    },  },}

Équivalent CLI :

openclaw config set gateway.push.apns.relay.baseUrl https://relay.example.com

Ce que cela fait :

• Permet au Gateway d’envoyer push.test, des nudges de réveil et des réveils de reconnexion via le relais externe.
• Utilise une autorisation d’envoi limitée à l’inscription, transférée par l’application iOS appairée. Le Gateway n’a pas besoin d’un jeton de relais couvrant tout le déploiement.
• Lie chaque inscription adossée au relais à l’identité du Gateway avec lequel l’application iOS a été appairée, afin qu’un autre Gateway ne puisse pas réutiliser l’inscription stockée.
• Conserve les builds iOS locales/manuelles sur des APNs directs. Les envois adossés au relais s’appliquent uniquement aux builds distribuées officielles qui se sont inscrites via le relais.
• Doit correspondre à l’URL de base du relais intégrée à la build iOS, afin que le trafic d’inscription et d’envoi atteigne le même déploiement de relais.

Flux de bout en bout :

1. Installez l’application iOS officielle.
2. Facultatif : configurez gateway.push.apns.relay.baseUrl sur le Gateway uniquement si vous utilisez une build de relais personnalisée volontairement séparée.
3. Appairez l’application iOS au Gateway et laissez les sessions de nœud et d’opérateur se connecter.
4. L’application iOS récupère l’identité du Gateway, s’inscrit auprès du relais avec App Attest et le reçu de l’application, puis publie la charge utile push.apns.register adossée au relais vers le Gateway appairé.
5. Le Gateway stocke l’identifiant de relais et l’autorisation d’envoi, puis les utilise pour push.test, les nudges de réveil et les réveils de reconnexion.

Notes opérationnelles :

• Si vous basculez l’application iOS vers un autre Gateway, reconnectez l’application afin qu’elle puisse publier une nouvelle inscription de relais liée à ce Gateway.
• Si vous livrez une nouvelle build iOS qui pointe vers un autre déploiement de relais, l’application actualise son inscription de relais mise en cache au lieu de réutiliser l’ancienne origine de relais.

Note de compatibilité :

• OPENCLAW_APNS_RELAY_BASE_URL et OPENCLAW_APNS_RELAY_TIMEOUT_MS fonctionnent toujours comme remplacements temporaires via l’environnement.
• Les URL de relais de Gateway personnalisées doivent correspondre à l’URL de base du relais intégrée à la build iOS. La voie de publication publique de l’App Store rejette les remplacements personnalisés d’URL de relais iOS.
• OPENCLAW_APNS_RELAY_ALLOW_HTTP=true reste une échappatoire de développement limitée au local loopback ; ne persistez pas d’URL de relais HTTP dans la configuration.

Voir Application iOS pour le flux de bout en bout et Authentification et flux de confiance pour le modèle de sécurité du relais.

{  agents: {    defaults: {      heartbeat: {        every: "30m",        target: "last",      },    },  },}

• every : chaîne de durée (30m, 2h). Définissez 0m pour désactiver.
• target : last | none | <channel-id> (par exemple discord, matrix, telegram ou whatsapp)
• directPolicy : allow (par défaut) ou block pour les cibles Heartbeat de type MP
• Voir Heartbeat pour le guide complet.

{  cron: {    enabled: true,    maxConcurrentRuns: 8, // default; cron dispatch + isolated cron agent-turn execution    sessionRetention: "24h",    runLog: {      maxBytes: "2mb",      keepLines: 2000,    },  },}

• sessionRetention : supprime les sessions d’exécution isolées terminées de sessions.json (par défaut 24h ; définissez false pour désactiver).
• runLog : supprime les lignes conservées de l’historique d’exécution Cron par tâche. maxBytes reste accepté pour les anciens journaux d’exécution adossés à des fichiers.
• Voir Tâches Cron pour la vue d’ensemble de la fonctionnalité et des exemples CLI.

Activez les points de terminaison Webhook HTTP sur le 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,      },    ],  },}

Note de sécurité :

• Traitez tout le contenu des charges utiles de hook/Webhook comme une entrée non fiable.
• Utilisez un hooks.token dédié ; ne réutilisez pas les secrets d’authentification actifs du Gateway (gateway.auth.token / OPENCLAW_GATEWAY_TOKEN ou gateway.auth.password / OPENCLAW_GATEWAY_PASSWORD).
• L’authentification des hooks se fait uniquement par en-tête (Authorization: Bearer ... ou x-openclaw-token) ; les jetons dans la chaîne de requête sont rejetés.
• hooks.path ne peut pas être / ; gardez l’entrée Webhook sur un sous-chemin dédié tel que /hooks.
• Gardez les indicateurs de contournement de contenu non sûr désactivés (hooks.gmail.allowUnsafeExternalContent, hooks.mappings[].allowUnsafeExternalContent), sauf pour un débogage strictement délimité.
• Si vous activez hooks.allowRequestSessionKey, définissez aussi hooks.allowedSessionKeyPrefixes pour borner les clés de session choisies par l’appelant.
• Pour les agents pilotés par hook, privilégiez des niveaux de modèles modernes robustes et une politique d’outils stricte (par exemple messagerie uniquement, plus bac à sable lorsque c’est possible).

Voir la référence complète pour toutes les options de mappage et l’intégration Gmail.

Exécutez plusieurs agents isolés avec des espaces de travail et des sessions séparés :

{  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" } },  ],}

Voir Multi-agent et la référence complète pour les règles de liaison et les profils d’accès par agent.

Utilisez $include pour organiser les configurations volumineuses :

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

• Fichier unique : remplace l’objet conteneur
• Tableau de fichiers : fusion profonde dans l’ordre (le dernier l’emporte)
• Clés sœurs : fusionnées après les inclusions (remplacent les valeurs incluses)
• Inclusions imbriquées : prises en charge jusqu’à 10 niveaux de profondeur
• Chemins relatifs : résolus par rapport au fichier qui inclut
• Format du chemin : les chemins d’inclusion ne doivent pas contenir d’octets nuls et doivent être strictement inférieurs à 4096 caractères avant et après résolution
• Écritures détenues par OpenClaw : lorsqu’une écriture modifie une seule section de premier niveau adossée à une inclusion de fichier unique comme plugins: { $include: "./plugins.json5" }, OpenClaw met à jour ce fichier inclus et laisse openclaw.json intact
• Écriture traversante non prise en charge : les inclusions racine, les tableaux d’inclusions et les inclusions avec remplacements par clés sœurs échouent de manière fermée pour les écritures détenues par OpenClaw au lieu d’aplatir la configuration
• Confinement : les chemins $include doivent se résoudre sous le répertoire contenant openclaw.json. Pour partager une arborescence entre machines ou utilisateurs, définissez OPENCLAW_INCLUDE_ROOTS sur une liste de chemins (: sur POSIX, ; sur Windows) de répertoires supplémentaires auxquels les inclusions peuvent faire référence. Les liens symboliques sont résolus et revérifiés ; ainsi, un chemin qui se trouve lexicalement dans un répertoire de configuration mais dont la cible réelle s’échappe de toutes les racines autorisées est quand même rejeté.
• Gestion des erreurs : erreurs claires pour les fichiers manquants, erreurs d’analyse, inclusions circulaires, format de chemin invalide et longueur excessive