Configuração

Cada canal tem sua própria seção de configuração em channels.<provider>. Consulte a página específica do canal para conhecer as etapas de configuração:

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

Todos os canais compartilham o mesmo padrão de política para mensagens diretas:

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

Defina o modelo principal e os modelos alternativos opcionais:

{  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 define o catálogo de modelos e atua como a lista de permissões de /model; entradas provider/* filtram /model, /models e seletores de modelos para os provedores selecionados, mantendo a descoberta dinâmica de modelos.
• Use openclaw config set agents.defaults.models '<json>' --strict-json --merge para adicionar entradas à lista de permissões sem remover os modelos existentes. Substituições simples que removeriam entradas são rejeitadas, a menos que você forneça --replace.
• As referências de modelos usam o formato provider/model (por exemplo, anthropic/claude-opus-4-6).
• agents.defaults.imageMaxDimensionPx controla a redução de escala das imagens de transcrições e ferramentas (padrão 1200); valores menores geralmente reduzem o uso de tokens de visão em execuções com muitas capturas de tela.
• Consulte a CLI de modelos para alternar modelos no chat e a Alternância de modelos em caso de falha para saber mais sobre a rotação de autenticação e o comportamento dos modelos alternativos.
• Para provedores personalizados ou auto-hospedados, consulte Provedores personalizados na referência.

O acesso por mensagens diretas é controlado por canal por meio de dmPolicy (padrão "pairing"):

• "pairing": remetentes desconhecidos recebem um código de pareamento de uso único para aprovação
• "allowlist": somente remetentes em allowFrom (ou no armazenamento de permissões pareadas)
• "open": permite todas as mensagens diretas recebidas (requer allowFrom: ["*"])
• "disabled": ignora todas as mensagens diretas

Para grupos, use groupPolicy ("allowlist" | "open" | "disabled") junto com groupAllowFrom ou listas de permissões específicas do canal.

Consulte a referência completa para obter detalhes de cada canal.

Por padrão, mensagens de grupo exigem menção. Configure padrões de acionamento por agente. Respostas normais em grupos e canais são publicadas automaticamente; habilite o caminho da ferramenta de mensagens em salas compartilhadas nas quais o agente deve decidir quando falar:

{  messages: {    visibleReplies: "automatic", // defina como "message_tool" para exigir envios pela ferramenta de mensagens em todos os lugares    groupChat: {      visibleReplies: "message_tool", // opção habilitada; a saída visível exige message(action=send)      unmentionedInbound: "room_event", // conversas contínuas em grupo sem menção são um contexto silencioso    },  },  agents: {    list: [      {        id: "main",        groupChat: {          mentionPatterns: ["@openclaw", "openclaw"],        },      },    ],  },  channels: {    whatsapp: {      groups: { "*": { requireMention: true } },    },  },}

• Menções por metadados: menções @ nativas (toque para mencionar no WhatsApp, @bot no Telegram etc.)
• Padrões de texto: padrões de expressões regulares seguros em mentionPatterns
• Respostas visíveis: messages.visibleReplies pode exigir globalmente envios pela ferramenta de mensagens; messages.groupChat.visibleReplies substitui essa configuração para grupos e canais.
• Consulte a referência completa para conhecer os modos de resposta visível, as substituições por canal e o modo de conversa consigo mesmo.

Use agents.defaults.skills como uma base compartilhada e depois substitua-a em agentes específicos com agents.list[].skills:

{  agents: {    defaults: {      skills: ["github", "weather"],    },    list: [      { id: "writer" }, // herda github, weather      { id: "docs", skills: ["docs-search"] }, // substitui os padrões      { id: "locked-down", skills: [] }, // sem Skills    ],  },}

• Omita agents.defaults.skills para permitir Skills sem restrições por padrão.
• Omita agents.list[].skills para herdar os padrões.
• Defina agents.list[].skills: [] para não permitir Skills.
• Consulte Skills, Configuração de Skills e a Referência de configuração.

Controle com que agressividade o Gateway reinicia canais que parecem inativos:

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

• Os valores mostrados são os padrões. Defina gateway.channelHealthCheckMinutes: 0 para desativar globalmente as reinicializações do monitor de integridade.
• channelStaleEventThresholdMinutes deve ser maior ou igual ao intervalo de verificação.
• Use channels.<provider>.healthMonitor.enabled ou channels.<provider>.accounts.<id>.healthMonitor.enabled para desativar as reinicializações automáticas de um canal ou uma conta sem desativar o monitor global.
• Consulte Verificações de integridade para depuração operacional e a referência completa para conhecer todos os campos.

Dê mais tempo aos clientes locais para concluir o handshake WebSocket anterior à autenticação em hosts sobrecarregados ou com poucos recursos:

{  gateway: {    handshakeTimeoutMs: 30000,  },}

• O padrão é 15000 milissegundos.
• OPENCLAW_HANDSHAKE_TIMEOUT_MS ainda tem precedência para substituições pontuais no serviço ou no shell.
• Prefira corrigir primeiro as interrupções na inicialização ou no loop de eventos; este ajuste destina-se a hosts que estão íntegros, mas são lentos durante o aquecimento.

As sessões controlam a continuidade e o isolamento das conversas:

{  session: {

    dmScope: "per-channel-peer",  // recomendado para vários usuários

    threadBindings: {

      enabled: true,      idleHours: 24,      maxAgeHours: 0,    },

    reset: {      mode: "daily",      atHour: 4,      idleMinutes: 120,    },  },}

• dmScope: main (compartilhado) | per-peer | per-channel-peer | per-account-channel-peer
• threadBindings: padrões globais para o roteamento de sessões vinculadas a threads. /focus, /unfocus, /agents, /session idle e /session max-age vinculam, desvinculam, listam e ajustam essa configuração por sessão (o Discord vincula threads; o Telegram vincula tópicos/conversas).
• Consulte Gerenciamento de sessões para saber mais sobre escopo, vínculos de identidade e política de envio.
• Consulte a referência completa para ver todos os campos.

Execute sessões do agente em ambientes de execução isolados:

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

Compile a imagem primeiro — a partir de um checkout do código-fonte, execute scripts/sandbox-setup.sh; ou, a partir de uma instalação via npm, consulte o comando docker build embutido em Sandboxing § Imagens e configuração.

Consulte Sandboxing para ver o guia completo e a referência completa para conhecer todas as opções.

As notificações por push via retransmissão para builds públicos da App Store usam a retransmissão hospedada do OpenClaw: https://ios-push-relay.openclaw.ai.

Implantações de retransmissão personalizadas exigem um caminho deliberadamente separado de build e implantação do iOS, cuja URL de retransmissão corresponda à URL de retransmissão do Gateway. Se você estiver usando um build de retransmissão personalizado, defina isto na configuração do Gateway:

{  gateway: {    push: {      apns: {        relay: {          baseUrl: "https://relay.example.com",          // Opcional. Padrão: 10000          timeoutMs: 10000,        },      },    },  },}

Equivalente na CLI:

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

O que isso faz:

• Permite que o Gateway envie push.test, estímulos de ativação e ativações de reconexão por meio do relay externo.
• Usa uma concessão de envio com escopo de registro encaminhada pelo aplicativo iOS pareado. O Gateway não precisa de um token de relay para toda a implantação.
• Vincula cada registro baseado em relay à identidade do Gateway com o qual o aplicativo iOS foi pareado, para que outro Gateway não possa reutilizar o registro armazenado.
• Mantém builds locais/manuais do iOS usando APNs diretamente. Os envios baseados em relay se aplicam apenas a builds oficiais distribuídos que se registraram por meio do relay.
• Deve corresponder à URL base do relay incorporada ao build do iOS, para que o tráfego de registro e envio chegue à mesma implantação do relay.

Fluxo de ponta a ponta:

1. Instale o aplicativo iOS oficial.
2. Opcional: configure gateway.push.apns.relay.baseUrl no Gateway somente ao usar um build personalizado de relay deliberadamente separado.
3. Pareie o aplicativo iOS com o Gateway e permita que as sessões do Node e do operador se conectem.
4. O aplicativo iOS obtém a identidade do Gateway, registra-se no relay usando o App Attest e o recibo do aplicativo e, em seguida, publica a carga útil push.apns.register baseada em relay no Gateway pareado.
5. O Gateway armazena o identificador do relay e a concessão de envio e os utiliza para push.test, estímulos de ativação e ativações de reconexão.

Notas operacionais:

• Se você mudar o aplicativo iOS para outro Gateway, reconecte o aplicativo para que ele possa publicar um novo registro de relay vinculado a esse Gateway.
• Se você distribuir um novo build do iOS que aponte para outra implantação do relay, o aplicativo atualizará seu registro de relay em cache em vez de reutilizar a origem antiga do relay.

Nota de compatibilidade:

• OPENCLAW_APNS_RELAY_BASE_URL e OPENCLAW_APNS_RELAY_TIMEOUT_MS ainda funcionam como substituições temporárias por variáveis de ambiente.
• URLs personalizadas de relay do Gateway devem corresponder à URL base do relay incorporada ao build do iOS; o fluxo público de lançamento da App Store rejeita substituições personalizadas da URL do relay do iOS.
• OPENCLAW_APNS_RELAY_ALLOW_HTTP=true continua sendo uma opção de escape de desenvolvimento restrita ao loopback; não persista URLs de relay HTTP na configuração.

Consulte Aplicativo iOS para ver o fluxo de ponta a ponta e Fluxo de autenticação e confiança para conhecer o modelo de segurança do relay.

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

• every: string de duração (30m, 2h). Defina como 0m para desativar. Padrão: 30m.
• target: last | none | <channel-id> (por exemplo, discord, matrix, telegram ou whatsapp)
• directPolicy: allow (padrão) ou block para destinos de Heartbeat no estilo de mensagens diretas
• Consulte Heartbeat para ver o guia completo.

{  cron: {    enabled: true,    maxConcurrentRuns: 8, // padrão; despacho do cron + execução isolada do turno do agente do cron    sessionRetention: "24h",    runLog: {      maxBytes: "2mb",      keepLines: 2000,    },  },}

• sessionRetention: remove sessões concluídas de execuções isoladas das linhas de sessão do SQLite (padrão: 24h; defina como false para desativar).
• runLog: remove linhas retidas do histórico de execuções do Cron por tarefa. O histórico é armazenado no SQLite; maxBytes (padrão: 2_000_000) é mantido para compatibilidade com logs de execução antigos baseados em arquivos; o padrão de keepLines é 2000.
• Consulte Tarefas Cron para obter uma visão geral do recurso e exemplos da CLI.

Ative endpoints de Webhook HTTP no 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,      },    ],  },}

Nota de segurança:

• Trate todo o conteúdo da carga útil de hooks/Webhooks como entrada não confiável.
• Use um hooks.token dedicado; não reutilize segredos de autenticação ativos do Gateway (gateway.auth.token / OPENCLAW_GATEWAY_TOKEN ou gateway.auth.password / OPENCLAW_GATEWAY_PASSWORD).
• A autenticação de hooks é feita somente por cabeçalho (Authorization: Bearer ... ou x-openclaw-token); tokens na string de consulta são rejeitados.
• hooks.path não pode ser /; mantenha a entrada de Webhooks em um subcaminho dedicado, como /hooks.
• Mantenha desativadas as opções que ignoram a verificação de conteúdo não seguro (hooks.gmail.allowUnsafeExternalContent, hooks.mappings[].allowUnsafeExternalContent), exceto durante depurações com escopo estritamente limitado.
• Se você ativar hooks.allowRequestSessionKey, também defina hooks.allowedSessionKeyPrefixes para limitar as chaves de sessão selecionadas pelo chamador.
• Para agentes acionados por hooks, prefira níveis de modelos modernos e robustos, além de uma política rigorosa de ferramentas (por exemplo, somente mensagens e, quando possível, uso de sandbox).

Consulte a referência completa para ver todas as opções de mapeamento e a integração com o Gmail.

Execute vários agentes isolados com espaços de trabalho e sessões separados:

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

Consulte Múltiplos agentes e a referência completa para ver as regras de associação e os perfis de acesso por agente.

Use $include para organizar configurações grandes:

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

• Arquivo único: substitui o objeto que o contém
• Matriz de arquivos: mesclada profundamente em ordem (o último prevalece), com até 10 níveis de aninhamento
• Chaves irmãs: mescladas após as inclusões (sobrescrevem os valores incluídos)
• Caminhos relativos: resolvidos em relação ao arquivo que faz a inclusão
• Formato do caminho: os caminhos de inclusão não podem conter bytes nulos e devem ter estritamente menos de 4096 caracteres antes e depois da resolução
• Gravações de propriedade do OpenClaw: quando uma gravação altera apenas uma seção de nível superior apoiada por uma inclusão de arquivo único, como plugins: { $include: "./plugins.json5" }, o OpenClaw atualiza o arquivo incluído e mantém openclaw.json intacto
• Gravação transparente não compatível: inclusões na raiz, matrizes de inclusões e inclusões com sobrescritas por chaves irmãs falham de forma segura em gravações de propriedade do OpenClaw, em vez de achatar a configuração
• Confinamento: os caminhos de $include devem ser resolvidos dentro do diretório que contém openclaw.json. Para compartilhar uma árvore entre máquinas ou usuários, defina OPENCLAW_INCLUDE_ROOTS como uma lista de caminhos (: no POSIX, ; no Windows) de diretórios adicionais que as inclusões podem referenciar. Links simbólicos são resolvidos e verificados novamente; portanto, um caminho que lexicalmente esteja em um diretório de configuração, mas cujo destino real escape de todas as raízes permitidas, ainda será rejeitado.
• Tratamento de erros: erros claros para arquivos ausentes, erros de análise, inclusões circulares, formato de caminho inválido e comprimento excessivo