配置参考

Documentation Index

Fetch the complete documentation index at: https://openclaw.zhcndoc.com/llms.txt

Use this file to discover all available pages before exploring further.

• openclaw config schema 会打印用于校验和 Control UI 的实时 JSON Schema，并在可用时合并内置/plugin/channel 元数据
• config.schema.lookup 会返回一个按路径作用域限定的 schema 节点，供下钻工具使用
• pnpm config:docs:check / pnpm config:docs:gen 会根据当前 schema 表面对 config-doc 基线哈希进行校验

• Memory configuration reference，用于 agents.defaults.memorySearch.*、memory.qmd.*、memory.citations，以及 plugins.entries.memory-core.config.dreaming 下的 dreaming 配置
• Slash commands，用于当前内置 + 捆绑的命令目录
• 各 channel/plugin 自己的页面，用于 channel 特定的命令面

​

Channels

​

Agent defaults, multi-agent, sessions, and messages

• agents.defaults.*（workspace、model、thinking、heartbeat、memory、media、skills、sandbox）
• multiAgent.*（multi-agent 路由和绑定）
• session.*（session 生命周期、压缩、剪枝）
• messages.*（消息投递、TTS、markdown 渲染）
• talk.*（Talk 模式）
  • talk.speechLocale：Talk 在 iOS/macOS 上进行语音识别时可选的 BCP 47 locale id
  • talk.silenceTimeoutMs：未设置时，Talk 会在发送转写内容前保留平台默认的暂停窗口（macOS 和 Android 为 700 ms，iOS 为 900 ms）

​

Tools and custom providers

​

Models

{
  models: {
    // 可选。默认值：true。更改后需要重启 Gateway。
    pricing: { enabled: false },
  },
}

• models.mode：provider catalog 行为（merge 或 replace）。
• models.providers：以 provider id 为键的自定义 provider 映射。
• models.pricing.enabled：控制后台 pricing 启动流程，该流程在 sidecar 和 channel 到达 Gateway ready 路径后开始。设为 false 时，Gateway 会跳过 OpenRouter 和 LiteLLM pricing-catalog 拉取；已配置的 models.providers.*.models[].cost 值仍可用于本地成本估算。

​

MCP

{
  mcp: {
    // 可选。默认值：600000 ms（10 分钟）。设为 0 可禁用空闲驱逐。
    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：供暴露已配置 MCP 工具的运行时使用的命名 stdio 或远程 MCP server 定义。 远程条目使用 transport: "streamable-http" 或 transport: "sse"； type: "http" 是 CLI 原生别名，openclaw mcp set 和 openclaw doctor --fix 会将其规范化为 canonical 的 transport 字段。
• mcp.sessionIdleTtlMs：会话作用域内捆绑 MCP 运行时的空闲 TTL。 一次性嵌入式运行会请求在运行结束时清理；此 TTL 作为长生命周期会话和未来调用者的后备保障。
• mcp.* 下的更改会通过释放已缓存的会话 MCP 运行时而热应用。 下一次工具发现/使用会使用新配置重新创建它们，因此被移除的 mcp.servers 条目会立即被清理，而不是等待空闲 TTL。

​

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" }, // 或明文字符串
        env: { GEMINI_API_KEY: "GEMINI_KEY_HERE" },
      },
      peekaboo: { enabled: true },
      sag: { enabled: false },
    },
  },
}

• allowBundled：仅针对捆绑 skills 的可选 allowlist（不影响 managed/workspace skills）。
• load.extraDirs：额外的共享 skill 根目录（优先级最低）。
• install.preferBrew：当 brew 可用时，若为 true，则优先使用 Homebrew 安装器，然后再回退到其他安装器类型。
• install.nodeManager：metadata.openclaw.install 规范的 node 安装器偏好（npm | pnpm | yarn | bun）。
• entries.<skillKey>.enabled: false 会禁用某个 skill，即使它已捆绑/安装。
• entries.<skillKey>.apiKey：用于声明主环境变量的 skills 的便捷配置（明文字符串或 SecretRef 对象）。

​

Plugins

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

• 从 ~/.openclaw/extensions、<workspace>/.openclaw/extensions 以及 plugins.load.paths 加载。
• 发现机制接受原生 OpenClaw 插件，以及兼容的 Codex bundles 和 Claude bundles，包括无 manifest 的 Claude 默认布局 bundles。
• 配置更改需要重启 gateway。
• allow：可选 allowlist（仅加载列出的插件）。deny 优先级更高。
• plugins.entries.<id>.apiKey：插件级 API key 便捷字段（在插件支持时）。
• plugins.entries.<id>.env：插件作用域的环境变量映射。
• plugins.entries.<id>.hooks.allowPromptInjection：当为 false 时，核心会阻止 before_prompt_build，并忽略来自旧版 before_agent_start 的 prompt 修改字段，同时保留旧版 modelOverride 和 providerOverride。适用于原生插件 hooks 和受支持的 bundle 提供的 hook 目录。
• plugins.entries.<id>.hooks.allowConversationAccess：当为 true 时，受信任的非捆绑插件可以从类型化 hooks 中读取原始对话内容，例如 llm_input、llm_output、before_agent_finalize 和 agent_end。
• plugins.entries.<id>.subagent.allowModelOverride：显式信任该插件在后台 subagent 运行中请求按次运行的 provider 和 model 覆盖。
• plugins.entries.<id>.subagent.allowedModels：用于受信任 subagent 覆盖的 canonical provider/model 目标的可选 allowlist。仅在你有意允许任意模型时才使用 "*"。
• plugins.entries.<id>.config：插件定义的配置对象（在可用时由原生 OpenClaw 插件 schema 校验）。
• channel 插件账号/运行时设置位于 channels.<id> 下，应由拥有插件的 manifest channelConfigs 元数据来描述，而不是由中央 OpenClaw 选项注册表描述。
• plugins.entries.firecrawl.config.webFetch：Firecrawl web-fetch provider 设置。
  • apiKey：Firecrawl API key（接受 SecretRef）。回退到 plugins.entries.firecrawl.config.webSearch.apiKey、旧版 tools.web.fetch.firecrawl.apiKey，或 FIRECRAWL_API_KEY 环境变量。
  • baseUrl：Firecrawl API base URL（默认：https://api.firecrawl.dev；自托管覆盖必须指向私有/内部端点）。
  • onlyMainContent：仅从页面提取主体内容（默认：true）。
  • maxAgeMs：最大缓存时长，单位毫秒（默认：172800000 / 2 天）。
  • timeoutSeconds：抓取请求超时，单位秒（默认：60）。
• plugins.entries.xai.config.xSearch：xAI X Search（Grok web search）设置。
  • enabled：启用 X Search provider。
  • model：用于搜索的 Grok 模型（例如 "grok-4-1-fast"）。
• plugins.entries.memory-core.config.dreaming：memory dreaming 设置。有关各阶段和阈值，请参见 Dreaming。
  • enabled：主 dreaming 开关（默认 false）。
  • frequency：每次完整 dreaming 扫描的 cron 频率（默认 "0 3 * * *"）。
  • model：可选的 Dream Diary subagent 模型覆盖。需要 plugins.entries.memory-core.subagent.allowModelOverride: true；可配合 allowedModels 限制目标。模型不可用错误会使用 session 默认模型重试一次；信任或 allowlist 失败不会静默回退。
  • 阶段策略和阈值属于实现细节（不是面向用户的配置键）。
• 完整的 memory 配置位于 Memory configuration reference：
  • agents.defaults.memorySearch.*
  • memory.backend
  • memory.citations
  • memory.qmd.*
  • plugins.entries.memory-core.config.dreaming
• 已启用的 Claude bundle plugins 也可以从 settings.json 提供嵌入式 Pi 默认值；OpenClaw 会将其作为已净化的 agent 设置应用，而不是作为原始 OpenClaw 配置补丁。
• plugins.slots.memory：选择当前激活的 memory plugin id，或使用 "none" 来禁用 memory plugins。
• plugins.slots.contextEngine：选择当前激活的 context engine plugin id；默认值为 "legacy"，除非你安装并选择另一个引擎。

​

Commitments

• commitments.enabled：启用隐藏的 LLM 提取、存储以及推断式后续 commitments 的 heartbeat 传递。默认：false。
• commitments.maxPerDay：每个 agent session 在滚动一天内最多传递的推断式后续 commitments 数量。默认：3。

​

Browser

{
  browser: {
    enabled: true,
    evaluateEnabled: true,
    defaultProfile: "user",
    ssrfPolicy: {
      // dangerouslyAllowPrivateNetwork: true, // 仅在受信任的私有网络访问场景中启用
      // allowPrivateNetwork: true, // 旧版别名
      // 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 会禁用 act:evaluate 和 wait --fn。
• tabCleanup 会在空闲一段时间后，或会话超过其上限时，回收已跟踪的主代理标签页。将 idleMinutes: 0 或 maxTabsPerSession: 0 设为 0 可禁用对应的单独清理模式。
• 当未设置时，ssrfPolicy.dangerouslyAllowPrivateNetwork 为禁用状态，因此浏览器导航默认保持严格。
• 只有在你明确信任私有网络浏览器导航时，才设置 ssrfPolicy.dangerouslyAllowPrivateNetwork: true。
• 在严格模式下，远程 CDP 配置文件端点（profiles.*.cdpUrl）在可达性/发现检查期间也会受到相同的私有网络阻止限制。
• ssrfPolicy.allowPrivateNetwork 仍作为旧版别名受支持。
• 在严格模式下，使用 ssrfPolicy.hostnameAllowlist 和 ssrfPolicy.allowedHostnames 来配置显式例外。
• 远程配置文件为仅附加模式（禁止启动/停止/重置）。
• profiles.*.cdpUrl 支持 http://、https://、ws:// 和 wss://。 当你希望 OpenClaw 发现 /json/version 时使用 HTTP(S)；当提供方直接给你 DevTools WebSocket URL 时使用 WS(S)。
• remoteCdpTimeoutMs 和 remoteCdpHandshakeTimeoutMs 适用于远程和 attachOnly 的 CDP 可达性以及打开标签页请求。受管回环配置文件保留本地 CDP 默认值。
• 如果外部管理的 CDP 服务可通过回环地址访问，请将该配置文件设为 attachOnly: true；否则 OpenClaw 会将该回环端口视为本地受管浏览器配置文件，并可能报告本地端口占用错误。
• existing-session 配置文件使用 Chrome MCP 而不是 CDP，并且可以附加到 所选主机或通过已连接的浏览器节点附加。
• existing-session 配置文件可以设置 userDataDir 来指定某个 基于 Chromium 的浏览器配置文件，例如 Brave 或 Edge。
• existing-session 配置文件保留当前 Chrome MCP 路由限制： 使用基于快照/引用驱动的操作，而不是 CSS 选择器定位、单文件上传钩子、 不支持对话框超时覆盖、不支持 wait --load networkidle，也不支持 responsebody、PDF 导出、下载拦截或批量操作。
• 本地受管的 openclaw 配置文件会自动分配 cdpPort 和 cdpUrl；仅 在远程 CDP 场景下显式设置 cdpUrl。
• 本地受管配置文件可以设置 executablePath 来覆盖该配置文件的全局 browser.executablePath。可用它让一个配置文件运行 Chrome，另一个运行 Brave。
• 本地受管配置文件在进程启动后使用 browser.localLaunchTimeoutMs 进行 Chrome CDP HTTP 发现，并使用 browser.localCdpReadyTimeoutMs 进行启动后 CDP WebSocket 就绪检查。 在较慢的主机上，如果 Chrome 已成功启动但就绪检查与启动过程竞争，则应调高这两个值。两个值都必须为 介于 1 到 120000 ms 之间的正整数；无效配置值会被拒绝。
• 自动检测顺序：如果默认浏览器基于 Chromium，则优先默认浏览器 → Chrome → Brave → Edge → Chromium → Chrome Canary。
• browser.executablePath 和 browser.profiles.<name>.executablePath 在 Chromium 启动前都 支持将 ~ 和 ~/... 展开为你的操作系统主目录。 existing-session 配置文件中的按配置文件 userDataDir 也会进行波浪号展开。
• 控制服务：仅回环（端口由 gateway.port 推导，默认 18791）。
• extraArgs 会将额外启动标志追加到本地 Chromium 启动参数中（例如 --disable-gpu、窗口大小设置或调试标志）。

​

UI

{
  ui: {
    seamColor: "#FF4500",
    assistant: {
      name: "OpenClaw",
      avatar: "CB", // 表情符号、短文本、图片 URL 或数据 URI
    },
  },
}

• seamColor：本地应用 UI 装饰的强调色（如 Talk Mode 气泡色调等）。
• assistant：控制 UI 身份覆盖。回退到当前活跃代理身份。

​

网关

{
  gateway: {
    mode: "local", // local | remote
    port: 18789,
    bind: "loopback",
    auth: {
      mode: "token", // none | token | password | trusted-proxy
      token: "your-token",
      // password: "your-password", // 或 OPENCLAW_GATEWAY_PASSWORD
      // trustedProxy: { userHeader: "x-forwarded-user" }, // 适用于 mode=trusted-proxy；见 /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"],
    // 可选。默认 false。
    allowRealIpFallback: false,
    nodes: {
      pairing: {
        // 可选。默认未设置/已禁用。
        autoApproveCidrs: ["192.168.1.0/24", "fd00:1234:5678::/64"],
      },
      allowCommands: ["canvas.navigate"],
      denyCommands: ["system.run"],
    },
    tools: {
      // 额外的 /tools/invoke HTTP 拒绝项
      deny: ["browser"],
      // 从默认 HTTP 拒绝列表中移除工具
      allow: ["gateway"],
    },
    push: {
      apns: {
        relay: {
          baseUrl: "https://relay.example.com",
          timeoutMs: 10000,
        },
      },
    },
  },
}

​

OpenAI 兼容端点

• Chat Completions：默认禁用。通过 gateway.http.endpoints.chatCompletions.enabled: true 启用。
• Responses API：gateway.http.endpoints.responses.enabled。
• Responses URL 输入加固：
  • gateway.http.endpoints.responses.maxUrlParts
  • gateway.http.endpoints.responses.files.urlAllowlist
  • gateway.http.endpoints.responses.images.urlAllowlist 空允许列表会被视为未设置；使用 gateway.http.endpoints.responses.files.allowUrl=false 和/或 gateway.http.endpoints.responses.images.allowUrl=false 来禁用 URL 抓取。
• 可选的响应加固头：
  • gateway.http.securityHeaders.strictTransportSecurity（仅对你控制的 HTTPS origin 设置；见 Trusted Proxy Auth）

​

多实例隔离

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

​

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：在网关监听器处启用 TLS 终止（HTTPS/WSS）（默认：false）。
• autoGenerate：在未配置显式文件时自动生成本地自签名证书/密钥对；仅用于本地/开发场景。
• certPath：TLS 证书文件的文件系统路径。
• keyPath：TLS 私钥文件的文件系统路径；请限制其权限。
• caPath：用于客户端验证或自定义信任链的可选 CA bundle 路径。

​

gateway.reload

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

• mode：控制配置编辑在运行时如何应用。
  • "off"：忽略实时编辑；更改需要显式重启。
  • "restart"：配置变更时始终重启网关进程。
  • "hot"：在进程内应用更改，无需重启。
  • "hybrid"（默认）：先尝试热重载；若需要则回退到重启。
• debounceMs：应用配置更改前的防抖窗口，单位 ms（非负整数）。
• deferralTimeoutMs：可选的最长等待时间，单位 ms，用于等待进行中的操作完成后再强制重启。省略则使用默认的有界等待（300000）；设为 0 则无限等待，并定期记录仍在等待的警告。

​

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: "来自：{{messages[0].from}}\n主题：{{messages[0].subject}}\n{{messages[0].snippet}}",
        deliver: true,
        channel: "last",
        model: "openai/gpt-5.4-mini",
      },
    ],
  },
}

• hooks.enabled=true 需要一个非空的 hooks.token。
• hooks.token 必须与 gateway.auth.token 不同；重复使用 Gateway token 会被拒绝。
• hooks.path 不能是 /；请使用专用子路径，例如 /hooks。
• 如果 hooks.allowRequestSessionKey=true，请限制 hooks.allowedSessionKeyPrefixes（例如 ["hook:"]）。
• 如果某个 mapping 或 preset 使用模板化的 sessionKey，请设置 hooks.allowedSessionKeyPrefixes 和 hooks.allowRequestSessionKey=true。静态 mapping key 不需要该显式开启。

• POST /hooks/wake → { text, mode?: "now"|"next-heartbeat" }
• POST /hooks/agent → { message, name?, agentId?, sessionKey?, wakeMode?, deliver?, channel?, to?, model?, thinking?, timeoutSeconds? }
  • 当 hooks.allowRequestSessionKey=true 时，才接受请求负载中的 sessionKey（默认：false）。
• POST /hooks/<name> → 通过 hooks.mappings 解析
  • 模板渲染后的 mapping sessionKey 值会被视为外部提供，因此同样需要 hooks.allowRequestSessionKey=true。

​

Gmail 集成

• 内置的 Gmail preset 使用 sessionKey: "hook:gmail:{{messages[0].id}}"。
• 如果你保留这种按消息路由方式，请设置 hooks.allowRequestSessionKey: true，并将 hooks.allowedSessionKeyPrefixes 限制为匹配 Gmail 命名空间，例如 ["hook:", "hook:gmail:"]。
• 如果你需要 hooks.allowRequestSessionKey: false，请用静态 sessionKey 覆盖该 preset，而不是使用模板化默认值。

{
  hooks: {
    gmail: {
      account: "openclaw@gmail.com",
      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",
    },
  },
}

• 在配置后，Gateway 会在启动时自动启动 gog gmail watch serve。设置 OPENCLAW_SKIP_GMAIL_WATCHER=1 可禁用。
• 不要在 Gateway 旁边再单独运行一个 gog gmail watch serve。

​

Canvas 主机

{
  canvasHost: {
    root: "~/.openclaw/workspace/canvas",
    liveReload: true,
    // enabled: false, // 或 OPENCLAW_SKIP_CANVAS_HOST=1
  },
}

• 通过 Gateway 端口经 HTTP 提供 agent 可编辑的 HTML/CSS/JS 和 A2UI：
  • http://<gateway-host>:<gateway.port>/__openclaw__/canvas/
  • http://<gateway-host>:<gateway.port>/__openclaw__/a2ui/
• 仅本地可访问：保持 gateway.bind: "loopback"（默认）。
• 非 loopback 绑定：canvas 路由需要 Gateway 认证（token/password/trusted-proxy），与其他 Gateway HTTP 表面相同。
• Node WebView 通常不会发送认证头；当 node 完成配对并连接后，Gateway 会为 canvas/A2UI 访问公开按 node 范围限定的能力 URL。
• 能力 URL 绑定到当前激活的 node WS 会话，并会快速过期。不使用基于 IP 的回退。
• 在提供的 HTML 中注入 live-reload 客户端。
• 在目录为空时自动创建 starter index.html。
• 也会在 /__openclaw__/a2ui/ 提供 A2UI。
• 更改需要重启 gateway。
• 对于大型目录或 EMFILE 错误，请禁用 live reload。

​

发现

​

mDNS（Bonjour）

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

• minimal（在捆绑的 bonjour 插件启用时为默认值）：从 TXT 记录中省略 cliPath + sshPort。
• full：包含 cliPath + sshPort；LAN 组播广播仍需要启用捆绑的 bonjour 插件。
• off：在不改变插件启用状态的情况下抑制 LAN 组播广播。
• 捆绑的 bonjour 插件会在 macOS 主机上自动启动，并且在 Linux、Windows 和容器化的 Gateway 部署中为可选启用。
• 当主机名是有效的 DNS 标签时，默认使用系统主机名，否则回退为 openclaw。可通过 OPENCLAW_MDNS_HOSTNAME 覆盖。

​

广域（DNS-SD）

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

​

环境

​

env（内联环境变量）

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

• 只有当进程环境中缺少该键时，才会应用内联环境变量。
• .env 文件：CWD .env + ~/.openclaw/.env（都不会覆盖已有变量）。
• shellEnv：从你的登录 shell 配置文件中导入缺失的预期键。
• 完整优先级请参见 环境。

​

环境变量替换

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

• 仅匹配大写名称：[A-Z_][A-Z0-9_]*。
• 缺失/空值变量会在配置加载时抛出错误。
• 使用 $${VAR} 转义为字面量 ${VAR}。
• 可与 $include 一起使用。

​

密钥

​

SecretRef

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

• provider 模式：^[a-z][a-z0-9_-]{0,63}$
• source: "env" 的 id 模式：^[A-Z][A-Z0-9_]{0,127}$
• source: "file" 的 id：绝对 JSON Pointer（例如 "/providers/openai/apiKey"）
• source: "exec" 的 id 模式：^[A-Za-z0-9][A-Za-z0-9._:/-]{0,255}$
• source: "exec" 的 id 不能包含 . 或 .. 这类由斜杠分隔的路径段（例如 a/../b 会被拒绝）

​

支持的凭据范围

• 规范矩阵：SecretRef 凭据范围
• secrets apply 目标是受支持的 openclaw.json 凭据路径。
• auth-profiles.json 引用会包含在运行时解析和审计覆盖范围内。

​

密钥提供方配置

{
  secrets: {
    providers: {
      default: { source: "env" }, // 可选的显式 env 提供方
      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",
    },
  },
}

• file 提供方支持 mode: "json" 和 mode: "singleValue"（在 singleValue 模式下，id 必须是 "value"）。
• 当 Windows ACL 验证不可用时，文件和 exec 提供方路径会以 fail closed 方式处理。仅对无法验证的受信任路径设置 allowInsecurePath: true。
• exec 提供方要求绝对的 command 路径，并通过 stdin/stdout 使用协议负载。
• 默认情况下会拒绝符号链接的命令路径。设置 allowSymlinkCommand: true 可允许符号链接路径，同时验证解析后的目标路径。
• 如果配置了 trustedDirs，则 trusted-dir 检查适用于解析后的目标路径。
• exec 子进程环境默认是最小化的；请使用 passEnv 显式传递所需变量。
• 密钥引用在激活时解析为内存中的快照，之后请求路径只读取该快照。
• 激活期间会应用活动面过滤：启用的面上未解析的引用会导致启动/重载失败，而不活动的面会被跳过并输出诊断信息。

​

认证存储

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

• 每个 agent 的配置文件存储在 <agentDir>/auth-profiles.json。
• auth-profiles.json 支持值级引用（api_key 使用 keyRef，token 使用 tokenRef），适用于静态凭据模式。
• 旧式扁平 auth-profiles.json 映射，例如 { "provider": { "apiKey": "..." } }，不是运行时格式；openclaw doctor --fix 会将其重写为规范的 provider:default API-key 配置文件，并创建 .legacy-flat.*.bak 备份。
• OAuth 模式配置文件（auth.profiles.<id>.mode = "oauth"）不支持基于 SecretRef 的 auth-profile 凭据。
• 静态运行时凭据来自内存中解析后的快照；发现旧式静态 auth.json 条目时会被清理。
• 旧式 OAuth 导入来自 ~/.openclaw/credentials/oauth.json。
• 参见 OAuth。
• 密钥运行时行为以及 audit/configure/apply 工具： Secrets Management。

​

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：当配置文件因真实的计费/信用额度不足错误而失败时，基础退避时间（小时）（默认：5）。即使在 401/403 响应中出现明确的计费文本，也可能进入这里，但提供方特定的文本匹配器仍仅限于其所属提供方（例如 OpenRouter 的 Key limit exceeded）。可重试的 HTTP 402 使用窗口或组织/工作区花费上限消息则仍停留在 rate_limit 路径中。
• billingBackoffHoursByProvider：可选的按提供方覆盖计费退避小时数。
• billingMaxHours：计费退避指数增长的小时上限（默认：24）。
• authPermanentBackoffMinutes：高置信度 auth_permanent 失败的基础退避时间（分钟）（默认：10）。
• authPermanentMaxMinutes：auth_permanent 退避增长的分钟上限（默认：60）。
• failureWindowHours：用于退避计数器的滚动时间窗口（小时）（默认：24）。
• overloadedProfileRotations：在切换到模型回退前，针对过载错误允许的同提供方 auth-profile 轮换最大次数（默认：1）。如 ModelNotReadyException 之类的提供方忙碌形态会落在这里。
• overloadedBackoffMs：重试过载的提供方/配置文件轮换前的固定延迟（默认：0）。
• rateLimitedProfileRotations：在切换到模型回退前，针对限流错误允许的同提供方 auth-profile 轮换最大次数（默认：1）。该限流桶包括诸如 Too many concurrent requests、ThrottlingException、concurrency limit reached、workers_ai ... quota limit exceeded 和 resource exhausted 等提供方样式的文本。

​

日志

{
  logging: {
    level: "info",
    file: "/tmp/openclaw/openclaw.log",
    consoleLevel: "info",
    consoleStyle: "pretty", // 美观 | 紧凑 | JSON
    redactSensitive: "tools", // 关闭 | 工具
    redactPatterns: ["\\bTOKEN\\b\\s*[=:]\\s*([\"']?)([^\\s\"']+)\\1"],
  },
}

• 默认日志文件：/tmp/openclaw/openclaw-YYYY-MM-DD.log。
• 设置 logging.file 以使用稳定路径。
• 当使用 --verbose 时，consoleLevel 会提升为 debug。
• maxFileBytes：在轮转之前的活动日志文件最大大小（字节，正整数；默认：104857600 = 100 MB）。OpenClaw 会在活动文件旁保留最多五个编号归档文件。
• redactSensitive / redactPatterns：对控制台输出、文件日志、OTLP 日志记录以及持久化会话转录文本进行尽力而为的脱敏。redactSensitive: "off" 只会禁用这一通用日志/转录策略；UI/工具/诊断安全表面仍会在输出前对密钥进行脱敏。

​

诊断

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

    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：仪表输出的总开关（默认：true）。
• flags：启用定向日志输出的标志字符串数组（支持如 "telegram.*" 或 "*" 的通配符）。
• stuckSessionWarnMs：用于将长时间运行的处理会话分类为 session.long_running、session.stalled 或 session.stuck 的无进展时长阈值（毫秒）。回复、工具、状态、块和 ACP 进度会重置计时器；在未变化时，重复的 session.stuck 诊断会退避。
• otel.enabled：启用 OpenTelemetry 导出管道（默认：false）。完整配置、信号目录和隐私模型请参见 OpenTelemetry 导出。
• otel.endpoint：OTel 导出的收集器 URL。
• otel.tracesEndpoint / otel.metricsEndpoint / otel.logsEndpoint：按信号划分的可选 OTLP 端点。设置后，它们会仅针对该信号覆盖 otel.endpoint。
• otel.protocol："http/protobuf"（默认）或 "grpc"。
• otel.headers：随 OTel 导出请求发送的额外 HTTP/gRPC 元数据头。
• otel.serviceName：资源属性的服务名称。
• otel.traces / otel.metrics / otel.logs：启用 trace、metrics 或 log 导出。
• otel.sampleRate：trace 采样率 0–1。
• otel.flushIntervalMs：定期遥测刷新的间隔（毫秒）。
• otel.captureContent：为 OTEL span 属性选择性启用原始内容捕获。默认关闭。布尔值 true 会捕获非系统消息/工具内容；对象形式可显式启用 inputMessages、outputMessages、toolInputs、toolOutputs 和 systemPrompt。
• OTEL_SEMCONV_STABILITY_OPT_IN=gen_ai_latest_experimental：环境开关，用于最新的实验性 GenAI span provider 属性。默认情况下，为兼容性，span 保留旧版 gen_ai.system 属性；GenAI 指标使用有界语义属性。
• OPENCLAW_OTEL_PRELOADED=1：适用于已注册全局 OpenTelemetry SDK 的主机的环境开关。OpenClaw 随后会跳过插件拥有的 SDK 启动/关闭，同时保持诊断监听器处于活动状态。
• OTEL_EXPORTER_OTLP_TRACES_ENDPOINT、OTEL_EXPORTER_OTLP_METRICS_ENDPOINT 和 OTEL_EXPORTER_OTLP_LOGS_ENDPOINT：当匹配的配置键未设置时使用的按信号划分端点环境变量。
• cacheTrace.enabled：为嵌入式运行记录缓存跟踪快照（默认：false）。
• cacheTrace.filePath：缓存跟踪 JSONL 的输出路径（默认：$OPENCLAW_STATE_DIR/logs/cache-trace.jsonl）。
• cacheTrace.includeMessages / includePrompt / includeSystem：控制缓存跟踪输出中包含哪些内容（全部默认：true）。

​

更新

{
  update: {
    channel: "stable", // 稳定版 | 测试版 | 开发版
    checkOnStart: true,

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

• channel：npm/git 安装的发布通道 — "stable"、"beta" 或 "dev"。
• checkOnStart：在网关启动时检查 npm 更新（默认：true）。
• auto.enabled：为包安装启用后台自动更新（默认：false）。
• auto.stableDelayHours：稳定通道自动应用前的最小时延（小时，默认：6；最大：168）。
• auto.stableJitterHours：稳定通道发布扩散的额外窗口时长（小时，默认：12；最大：168）。
• auto.betaCheckIntervalHours：beta 通道检查运行的频率（小时，默认：1；最大：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", // 实时 | 仅最终
      hiddenBoundarySeparator: "paragraph", // 无 | 空格 | 换行 | 段落
      maxOutputChars: 50000,
      maxSessionUpdateChars: 500,
    },

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

• enabled：全局 ACP 功能开关（默认：true；设为 false 可隐藏 ACP dispatch 和 spawn 入口）。
• dispatch.enabled：ACP 会话轮次分发的独立开关（默认：true）。设为 false 可保留 ACP 命令可用，同时阻止执行。
• backend：默认 ACP 运行时后端 id（必须与已注册的 ACP 运行时插件匹配）。 请先安装后端插件，如果设置了 plugins.allow，请包含后端插件 id（例如 acpx），否则 ACP 后端将不会加载。
• defaultAgent：当 spawn 未指定明确目标时使用的 ACP 目标代理 id 备用值。
• allowedAgents：允许 ACP 运行时会话使用的代理 id 白名单；为空表示不额外限制。
• maxConcurrentSessions：可同时活动的 ACP 会话最大数量。
• stream.coalesceIdleMs：流式文本的空闲刷新窗口（毫秒）。
• stream.maxChunkChars：在拆分流式块投影之前的最大块大小。
• stream.repeatSuppression：按轮次抑制重复的状态/工具行（默认：true）。
• stream.deliveryMode："live" 表示增量流式输出；"final_only" 表示缓冲直到轮次终止事件。
• stream.hiddenBoundarySeparator：隐藏工具事件之后、可见文本之前的分隔符（默认："paragraph"）。
• stream.maxOutputChars：每个 ACP 轮次可投影的助手输出最大字符数。
• stream.maxSessionUpdateChars：投影的 ACP 状态/更新行最大字符数。
• stream.tagVisibility：用于流式事件的标签名称到布尔可见性覆盖值的记录。
• runtime.ttlMinutes：ACP 会话 worker 在可被清理前的空闲 TTL（分钟）。
• runtime.installCommand：引导 ACP 运行时环境时可选执行的安装命令。

​

CLI

{
  cli: {
    banner: {
      taglineMode: "off", // 随机 | 默认 | 关闭
    },
  },
}

• cli.banner.taglineMode 控制横幅标语样式：
  • "random"（默认）：轮换显示有趣/季节性标语。
  • "default"：固定的中性标语（All your chats, one OpenClaw.）。
  • "off"：不显示标语文本（仍会显示横幅标题/版本）。
• 如需隐藏整个横幅（不仅仅是标语），请设置环境变量 OPENCLAW_HIDE_BANNER=1。

​

向导

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

​

身份

​

Bridge（旧版，已移除）

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

​

Cron

{
  cron: {
    enabled: true,
    maxConcurrentRuns: 2, // cron 分发 + 隔离的 cron 代理轮次执行
    webhook: "https://example.invalid/legacy", // 已弃用的、用于已存储 notify:true 作业的回退项
    webhookToken: "replace-with-dedicated-token", // 用于出站 webhook 认证的可选 bearer token
    sessionRetention: "24h", // duration string 或 false
    runLog: {
      maxBytes: "2mb", // 默认 2_000_000 字节
      keepLines: 2000, // 默认 2000
    },
  },
}

• sessionRetention：在从 sessions.json 中清除前，已完成的隔离 cron 运行会话保留多长时间。也用于清理已归档删除的 cron 转录。默认：24h；设为 false 可禁用。
• runLog.maxBytes：每个运行日志文件（cron/runs/<jobId>.jsonl）在清理前的最大大小。默认：2_000_000 字节。
• runLog.keepLines：触发运行日志清理时保留的最新行数。默认：2000。
• webhookToken：用于 cron webhook POST 投递（delivery.mode = "webhook"）的 bearer token；如果省略，则不会发送认证头。
• webhook：已弃用的旧版回退 webhook URL（http/https），仅用于仍具有 notify: true 的已存储作业。

​

cron.retry

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

• maxAttempts：一次性作业在瞬态错误时的最大重试次数（默认：3；范围：0–10）。
• backoffMs：每次重试的退避延迟数组（毫秒）（默认：[30000, 60000, 300000]；1–10 项）。
• retryOn：触发重试的错误类型 — "rate_limit"、"overloaded"、"network"、"timeout"、"server_error"。省略则重试所有瞬态类型。

​

cron.failureAlert

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

• enabled：为 cron 作业启用失败告警（默认：false）。
• after：连续失败达到多少次后触发告警（正整数，最小：1）。
• cooldownMs：同一作业重复告警之间的最小间隔毫秒数（非负整数）。
• includeSkipped：将连续跳过的运行计入告警阈值（默认：false）。跳过的运行会单独跟踪，不会影响执行错误退避。
• mode：投递模式 — "announce" 通过频道消息发送；"webhook" 发布到配置的 webhook。
• accountId：可选的账户或频道 id，用于限定告警投递范围。

​

cron.failureDestination

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

• 所有作业的 cron 失败通知默认目的地。
• mode："announce" 或 "webhook"；当存在足够的目标数据时，默认值为 "announce"。
• channel：用于 announce 投递的频道覆盖值。"last" 会重用最后已知的投递频道。
• to：显式的 announce 目标或 webhook URL。webhook 模式必填。
• accountId：可选的投递账户覆盖值。
• 单个作业的 delivery.failureDestination 会覆盖此全局默认值。
• 当全局和作业级失败目的地都未设置时，已经通过 announce 投递的作业在失败时会回退到该主要 announce 目标。
• delivery.failureDestination 仅支持 sessionTarget="isolated" 的作业，除非该作业的主要 delivery.mode 是 "webhook"。

​

媒体模型模板变量

​

配置包含（$include）

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

• 单文件：替换所包含的对象。
• 文件数组：按顺序深度合并（后者覆盖前者）。
• 同级键：在 include 之后合并（覆盖被包含的值）。
• 嵌套 include：最多 10 层。
• 路径：相对于包含它的文件解析，但必须保留在顶级配置目录（openclaw.json 的 dirname）内。只有当绝对路径/../ 形式最终仍解析到该边界内时才允许。
• OpenClaw 负责的写入如果只更改由单文件 include 支持的某个顶级部分，则会写回到该包含文件中。例如，plugins install 会更新 plugins: { $include: "./plugins.json5" } 中的 plugins.json5，并保持 openclaw.json 不变。
• 根级 includes、include 数组以及带有同级覆盖的 includes 对 OpenClaw 负责的写入是只读的；这些写入会直接失败，而不是将配置扁平化。
• 错误：针对缺失文件、解析错误和循环 includes 提供清晰的消息。

​

相关

• 配置
• 配置示例