Skip to main content
OpenClaw 从 ~/.openclaw/openclaw.json 读取可选的 配置。如果该文件不存在,OpenClaw 将使用安全默认值。 有效配置路径必须是常规文件。OpenClaw 写入时会以原子方式替换该文件(重命名至此路径),因此,符号链接形式的 openclaw.json 会导致其目标被替换,而不是透过链接写入——请避免使用符号链接配置布局。如果配置位于默认状态目录之外,请将 OPENCLAW_CONFIG_PATH 直接指向实际文件。 添加配置的常见原因:
  • 连接渠道并控制谁可以向机器人发送消息
  • 设置模型、工具、沙箱隔离或自动化(定时任务、钩子)
  • 调整会话、媒体、网络或 UI
有关所有可用字段,请参阅完整参考 配置遵循双分区规则:根级同级项包含基础设施和跨智能体默认值,而 agents.defaults 包含 Agent loop 行为。在架构支持按智能体覆盖的位置,agents.entries 下的条目可以覆盖任一分区。 在编辑配置之前,智能体和自动化应使用 config.schema.lookup 获取精确到字段级别的文档。本页面提供面向任务的指南;更广泛的字段映射和默认值,请参阅配置参考
刚开始接触配置? 请先使用 openclaw onboard 进行交互式设置,或查看配置示例指南,获取可完整复制粘贴的配置。

最小配置

编辑配置

严格验证

OpenClaw 只接受完全符合架构的配置。未知键、错误类型或无效值会导致 Gateway 网关拒绝启动。根级唯一的例外是 $schema(字符串),以便编辑器附加 JSON Schema 元数据。
openclaw config schema 会输出 Control UI 和验证所使用的规范 JSON Schema。 config.schema.lookup 会获取单个限定路径的节点及其子项摘要,以供逐层深入工具使用。字段 title/description 文档元数据 会传递至嵌套对象、通配符(*)、数组项([])以及 anyOf/ oneOf/allOf 分支。加载清单注册表后,运行时插件和渠道架构会合并进来。 每个配置叶节点在 uiHints 中都有常用或高级呈现层级。 advanced: false 标记常用设置,advanced: true 标记高级 设置。没有直接提示的叶节点会继承最近祖先节点的层级; 没有已声明祖先节点的路径默认为高级。此设置仅影响呈现, 不会影响验证、默认值、重载行为,也不会影响该键能否设置。 验证失败时:
  • Gateway 网关不会启动
  • 只有诊断命令可用(openclaw doctoropenclaw logsopenclaw healthopenclaw status
  • 运行 openclaw doctor 查看具体问题
  • 运行 openclaw doctor --fix--repair 是同一个标志;--yes 可跳过提示)以应用修复
Gateway 网关会在每次成功启动后保存可信的最后已知良好副本, 但启动和热重载不会自动恢复该副本——只有 openclaw doctor --fix 会执行恢复。如果 openclaw.json 验证失败(包括插件本地验证),Gateway 网关 将启动失败或跳过重载,当前运行时则继续使用上次接受的 配置。被拒绝写入的内容还会保存为 <path>.rejected.<timestamp>,以供检查。 Gateway 网关会阻止看似意外覆盖的写入——例如删除 gateway.mode、 丢失 meta 块,或使文件缩小超过一半——除非写入操作 明确允许破坏性更改。当候选配置包含经过脱敏的密钥占位符(例如 ***[redacted])时, 不会将其提升为最后已知良好配置。

常见任务

每个渠道在 channels.<provider> 下都有自己的配置部分。有关设置步骤,请参阅相应的渠道页面:所有渠道都采用相同的私信策略模式:
设置主模型和可选的回退模型:
  • agents.defaults.models 存储别名和各模型设置;添加条目绝不会限制 /model--model 覆盖。
  • agents.defaults.modelPolicy.allow 是覆盖和模型选择器的显式允许列表。它接受精确引用和 provider/* 通配符;省略该项或使用 [] 可允许任何模型。
  • 模型引用采用 provider/model 格式(例如 anthropic/claude-opus-4-6)。
  • agents.defaults.imageMaxDimensionPx 控制对话记录/工具图像的缩小处理(默认值为 1200);在大量使用屏幕截图的运行中,较低的值通常能减少视觉 Token 用量。
  • 有关在聊天中切换模型的信息,请参阅模型 CLI;有关身份验证轮换和回退行为的信息,请参阅模型故障转移
  • 对于自定义/自行托管的提供商,请参阅参考文档中的自定义提供商
每个渠道的私信访问权限通过 dmPolicy 控制(默认值为 "pairing"):
  • "pairing":未知发送者会收到一次性配对码,以供批准
  • "allowlist":仅允许 allowFrom 中的发送者(或已配对允许存储中的发送者)
  • "open":允许所有传入私信(需要 allowFrom: ["*"]
  • "disabled":忽略所有私信
对于群组,请使用 groupPolicy"allowlist" | "open" | "disabled")以及 groupAllowFrom 或渠道专用允许列表。有关各渠道的详细信息,请参阅完整参考
群组消息默认要求提及。请为每个智能体配置触发模式。普通群组/渠道回复会自动发布;对于应由智能体决定何时发言的共享房间,可选择启用消息工具路径:
  • 元数据提及:原生 @ 提及(WhatsApp 点按提及、Telegram @bot 等)
  • 文本模式mentionPatterns 中的安全正则表达式模式
  • 可见回复messages.visibleReplies 可以在全局范围要求通过消息工具发送;messages.groupChat.visibleReplies 会为群组/渠道覆盖该设置。
  • 有关可见回复模式、各渠道覆盖和自聊模式,请参阅完整参考
使用 agents.defaults.skills 设置共享基线,然后通过 agents.entries.*.skills 覆盖特定智能体:
  • 省略 agents.defaults.skills 时,默认不限制 Skills。
  • 省略 agents.entries.*.skills 以继承默认值。
  • 设置 agents.entries.*.skills: [] 表示不使用 Skills。
  • 请参阅 SkillsSkills 配置配置参考
为渠道或账号禁用或启用自动健康重启:
  • 使用 channels.<provider>.healthMonitor.enabledchannels.<provider>.accounts.<id>.healthMonitor.enabled 控制单个渠道或账号的自动重启。
  • 有关运维调试,请参阅健康检查;有关所有字段,请参阅完整参考
会话控制对话的连续性和隔离:
  • dmScopemain(共享)| per-peer | per-channel-peer | per-account-channel-peer
  • threadBindings:线程绑定会话路由的全局默认值。/focus/unfocus/agents/session idle/session max-age 可按会话绑定、解绑、列出和调整此设置(Discord 绑定线程,Telegram 绑定话题/对话)。
  • 有关作用域、身份关联和发送策略,请参阅会话管理
  • 有关所有字段,请参阅完整参考
在隔离的沙箱运行时中运行智能体会话:
请先构建镜像——如果使用源码检出,请运行 scripts/sandbox-setup.sh;如果通过 npm 安装,请参阅沙箱隔离 § 镜像和设置中的内联 docker build 命令。完整指南请参阅沙箱隔离,所有选项请参阅完整参考
面向 App Store 公开构建的中继支持推送使用托管的 OpenClaw 中继:https://ios-push-relay.openclaw.ai自定义中继部署需要刻意采用单独的 iOS 构建/部署路径,并使其中继 URL 与 Gateway 网关的中继 URL 匹配。如果使用自定义中继构建,请在 Gateway 网关配置中设置:
等效 CLI 命令:
此设置的作用:
  • 允许 Gateway 网关通过外部中继发送 push.test、唤醒提示和重新连接唤醒。
  • 使用由已配对 iOS 应用转发、限定于注册范围的发送授权。Gateway 网关不需要部署范围的中继令牌。
  • 将每个中继支持的注册绑定到 iOS 应用所配对的 Gateway 网关身份,因此其他 Gateway 网关无法复用已存储的注册。
  • 本地/手动 iOS 构建仍使用直接 APNs。中继支持的发送仅适用于通过中继注册的官方分发构建。
  • 必须与内置于 iOS 构建中的中继基础 URL 匹配,以确保注册和发送流量到达同一个中继部署。
端到端流程:
  1. 安装官方 iOS 应用。
  2. 可选:仅当使用刻意单独构建的自定义中继版本时,才在 Gateway 网关上配置 gateway.push.apns.relay.baseUrl
  3. 将 iOS 应用与 Gateway 网关配对,并让节点会话和操作员会话都建立连接。
  4. iOS 应用获取 Gateway 网关身份,使用 App Attest 和应用收据向中继注册,然后将中继支持的 push.apns.register 有效载荷发布到已配对的 Gateway 网关。
  5. Gateway 网关存储中继句柄和发送授权,然后使用它们发送 push.test、唤醒提示和重新连接唤醒。
运维说明:
  • 如果将 iOS 应用切换到其他 Gateway 网关,请重新连接应用,使其可以发布绑定到该 Gateway 网关的新中继注册。
  • 如果发布的新 iOS 构建指向其他中继部署,应用会刷新缓存的中继注册,而不会复用旧的中继来源。
兼容性说明:
  • OPENCLAW_APNS_RELAY_BASE_URLOPENCLAW_APNS_RELAY_TIMEOUT_MS 仍可用作临时环境变量覆盖项。
  • 自定义 Gateway 网关中继 URL 必须与内置于 iOS 构建中的中继基础 URL 匹配;App Store 公开发布通道会拒绝自定义 iOS 中继 URL 覆盖项。
  • OPENCLAW_APNS_RELAY_ALLOW_HTTP=true 仍是仅限 local loopback 的开发逃生通道;不要在配置中持久化 HTTP 中继 URL。
有关端到端流程,请参阅 iOS 应用;有关中继安全模型,请参阅身份验证和信任流程
  • every:持续时间字符串(30m2h)。设置为 0m 可禁用。默认值:30m
  • targetlast | none | <channel-id>(例如 discordmatrixtelegramwhatsapp
  • directPolicy:私信式 Heartbeat 目标可设为 allow(默认)或 block
  • 完整指南请参阅 Heartbeat
  • sessionRetention:从 SQLite 会话行中清理已完成的隔离运行会话(默认值为 24h;设置为 false 可禁用)。
  • 运行历史记录会自动为每个任务保留最新的 2000 条终端记录;丢失的记录仍保留其 24 小时清理窗口。
  • 有关功能概览和 CLI 示例,请参阅定时任务
在 Gateway 网关上启用 HTTP webhook 端点:
安全说明:
  • 将所有 hook/webhook 有效载荷内容视为不受信任的输入。
  • 使用专用的 hooks.token;不要复用有效的 Gateway 网关身份验证密钥(gateway.auth.token / OPENCLAW_GATEWAY_TOKENgateway.auth.password / OPENCLAW_GATEWAY_PASSWORD)。
  • Hook 身份验证仅支持标头(Authorization: Bearer ...x-openclaw-token);查询字符串令牌会被拒绝。
  • hooks.path 不能是 /;请将 webhook 入口保留在专用子路径上,例如 /hooks
  • 除非进行严格限定范围的调试,否则请保持不安全内容绕过标志(hooks.gmail.allowUnsafeExternalContenthooks.mappings[].allowUnsafeExternalContent)处于禁用状态。
  • 如果启用 hooks.allowRequestSessionKey,还应设置 hooks.allowedSessionKeyPrefixes,以限制调用方选择的会话键。
  • 对于由 hook 驱动的智能体,优先使用强大的现代模型层级和严格的工具策略(例如仅允许消息传递,并尽可能启用沙箱隔离)。
有关所有映射选项和 Gmail 集成,请参阅完整参考
运行多个具有独立工作区和会话的隔离智能体:
有关绑定规则和按智能体配置的访问配置文件,请参阅多智能体完整参考
使用 $include 组织大型配置:
  • 单个文件:替换包含它的对象
  • 文件数组:按顺序深度合并(后者优先),最多嵌套 10 层
  • 同级键:在包含操作后合并(覆盖包含的值)
  • 相对路径:相对于执行包含操作的文件解析
  • 路径格式:包含路径不得含有空字节,并且在解析前后都必须严格短于 4096 个字符
  • OpenClaw 所有的写入操作:当写入仅更改一个由单文件包含项(例如 plugins: { $include: "./plugins.json5" })支持的顶层节时,OpenClaw 会更新该包含文件,并保持 openclaw.json 不变
  • 不支持的写穿透:对于根包含项、包含项数组以及带有同级覆盖项的包含项,OpenClaw 所有的写入操作会以失败关闭方式处理,而不会展平配置
  • 限制范围$include 路径必须解析到存放 openclaw.json 的目录之下。要在多台计算机或多个用户之间共享目录树,请将 OPENCLAW_INCLUDE_ROOTS 设置为路径列表(POSIX 上为 :,Windows 上为 ;),列出包含项可以引用的其他目录。系统会解析并重新检查符号链接,因此,即使某个路径在词法上位于配置目录内,但其真实目标逸出所有允许的根目录,该路径仍会被拒绝。
  • 错误处理:针对文件缺失、解析错误、循环包含、路径格式无效和长度超限提供清晰的错误信息

配置热重载

Gateway 网关会监视 ~/.openclaw/openclaw.json 并自动应用更改——大多数设置无需手动重启。 直接编辑文件的操作在通过验证之前会被视为不受信任。监视器会等待编辑器临时写入/重命名的变动结束,读取最终文件,并拒绝无效的外部编辑,同时不重写 openclaw.json。OpenClaw 所有的配置写入操作在写入前会使用相同的架构门控(有关适用于每次写入的覆盖/回滚规则,请参阅严格验证)。 如果看到 config reload skipped (invalid config),或启动报告 Invalid config,请检查配置,运行 openclaw config validate,然后运行 openclaw doctor --fix 进行修复。有关检查清单,请参阅 Gateway 网关故障排查

重载模式

哪些更改会热应用,哪些需要重启

大多数字段可在无停机的情况下热应用;某些热应用的部分只会重启相应的 子系统(渠道、定时任务、Heartbeat、健康监视器),而不是整个 Gateway 网关。在 hybrid 模式下,需要重启 Gateway 网关的更改会自动处理。
gateway.reloadgateway.remotegateway.* 下的例外——更改它们不会触发重启。各个插件也可以覆盖此表:已加载的插件可以声明自身会触发重启的配置前缀(例如,内置 Canvas 插件会因 plugins.enabledplugins.allowplugins.deny 而重启 Gateway 网关,并非仅针对其自身的 plugins.entries.canvas),因此实际行为取决于启用的插件。

重新加载规划

当你编辑通过 $include 引用的源文件时,OpenClaw 会根据 源文件中编写的布局规划重新加载,而不是使用扁平化的内存视图。 这样,即使单个顶级部分位于其独立的包含文件中(例如 plugins: { $include: "./plugins.json5" }),也能确保热重载决策(热应用还是重启)可预测。如果 源布局存在歧义,重新加载规划将以失败关闭方式处理。

配置 RPC(编程式更新)

对于通过 Gateway 网关 API 写入配置的工具,优先使用以下流程:
  • config.schema.lookup:检查一个子树(浅层架构节点 + 子项 摘要)
  • config.get:获取当前快照以及 hash
  • config.patch:执行部分更新(JSON 合并补丁:对象合并,null 执行删除;如果会移除条目,则必须使用 replacePaths 明确确认, 数组才会被替换)
  • config.apply:仅在你打算替换整个配置时使用
  • update.run:执行显式自更新并重启;如果重启后的会话应运行一次后续轮次,请包含 continuationMessage
  • update.status:检查最新的更新重启哨兵,并在重启后验证运行中的版本
智能体应将 config.schema.lookup 作为查找准确 字段级文档和约束的首选入口。当需要更广泛的配置地图、默认值或指向专用 子系统参考的链接时,请使用配置参考
控制平面写入(config.applyconfig.patchupdate.run)的 速率限制为每个 deviceId+clientIp、每种方法每 60 秒 30 个请求;请参阅速率限制。重启 请求会被合并,然后在各重启周期之间强制执行 30 秒冷却时间。 update.status 为只读,但仅限管理员使用,因为重启哨兵可能 包含更新步骤摘要和命令输出末尾内容。
部分补丁示例:
config.applyconfig.patch 均接受 rawbaseHashsessionKeynoterestartDelayMs。一旦配置文件已存在,两种方法都必须提供 baseHash(首次写入且没有现有配置时跳过此检查)。 config.patch 还接受 replacePaths,这是一个配置路径数组,表示有意 替换相应数组。如果补丁要以更少的条目替换或删除现有数组, 除非该确切路径出现在 replacePaths 中,否则 Gateway 网关会拒绝写入;数组条目中的嵌套数组使用 [],例如 agents.entries.*.skills。这可防止截断的 config.get 快照 在未提示的情况下覆盖路由或允许列表数组。当你 打算替换完整配置时,请使用 config.apply

环境变量

OpenClaw 从父进程以及以下位置读取环境变量:
  • .env:当前工作目录中的文件(如果存在)
  • ~/.openclaw/.env(全局回退)
这两个文件都不会覆盖现有环境变量。你也可以在配置中设置内联环境变量:
如果已启用且预期键名未设置,OpenClaw 会运行你的登录 Shell,并且仅导入缺失的键:
等效环境变量:OPENCLAW_LOAD_SHELL_ENV=1。默认 timeoutMs15000
使用 ${VAR_NAME} 在任意配置字符串值中引用环境变量:
规则:
  • 仅匹配大写名称:[A-Z_][A-Z0-9_]*
  • 变量缺失或为空时,在加载时抛出错误
  • 使用 $${VAR} 转义以输出字面值
  • 可在 $include 文件中使用
  • 内联替换:"${BASE}/v1""https://api.example.com/v1"
对于支持 SecretRef 对象的字段,可以使用:
SecretRef 的详细信息(包括用于 env/file/execsecrets.providers)请参阅密钥管理。 支持的凭据路径列于 SecretRef 凭据范围
有关完整的优先级和来源,请参阅环境

完整参考

有关逐字段的完整参考,请参阅**配置参考**。
相关:配置示例 · 配置参考 · Doctor

相关内容