乐于分享
好东西不私藏

OpenClaw openclaw.json 全量小白教程:一篇讲清每个配置项的作用

OpenClaw openclaw.json 全量小白教程:一篇讲清每个配置项的作用

先关注后阅读,娇姐怕失去上进的你

文末娇姐整理openclaw所有文章链接

想了解娇姐点击文末链接

本文基于官方文档、官方字段参考、仓库实现、社区导出 schema 和生态案例交叉比对。遇到差异时采用三层原则:官方文档 > 本机导出 schema > 社区示例。

  • docs.openclaw.ai/gateway/configuration(官方任务导向)
  • docs.openclaw.ai/gateway/configuration-reference(官方字段级参考)
  • github.com/openclaw/openclaw(实现细节与 issue)
  • 社区 config.schema.json(枚举参考,版本会漂移)
  • 生态示例(OpenRouter、Docker CN IM 等,仅对照)

1. 配置文件基础机制(必须先懂)

1.1 文件路径与格式

默认路径是 ~/.openclaw/openclaw.json。文件采用 JSON5,支持注释和尾逗号;也可通过 OPENCLAW_CONFIG_PATH 覆盖路径。

1.2 严格 Schema 校验

未知字段、类型不匹配、无效枚举值都可能导致 Gateway 拒绝启动。根级通常唯一例外是 $schema(用于 IDE 联想)。

openclaw doctoropenclaw doctor --fixopenclaw doctor --deep --yes

1.3 四种编辑入口

方式
入口
适用场景
交互向导
openclaw onboard / openclaw configure
新手首选,输入即校验
CLI
openclaw config set/get/unset
脚本自动化
Control UI
127.0.0.1:18789 → Config
可视化编辑
直接编辑
任意文本编辑器
高级用户与版本管理

1.4 热加载机制

默认 gateway.reload.mode: "hybrid"。能热更新的就立即生效,必须重启的会自动重启。

类别
典型模块
热应用
channels、agents、models、hooks、cron、session、tools、ui、logging、env、skills、messages
需重启
gateway 栈(端口/bind/TLS/HTTP)、plugins、discovery、canvasHost、nodeHost

2. 顶层配置结构:每个 key 是什么作用

下面是你给出的顶层块全量说明,按“业务价值最高”排序。所有字段都可选,省略即走默认值。

顶层 key
作用
是否高频
$schema
编辑器字段联想入口
中
agents
Agent 行为总控(模型/并发/心跳/沙箱)
高
gateway
网关监听/认证/热加载
高
session
会话作用域、重置、维护
高
models
自定义 provider 与端点
中高
channels
消息渠道接入
高
tools
工具权限边界
高
skills
技能管理与可见性
中
plugins
插件系统
中
browser
浏览器工具行为与资源限制
中
cron
定时任务运行器
中
hooks
Webhook 事件入口
中高
messages
回复前后缀、ACK、TTS
中
memory
长期记忆后端与索引策略
中
talk
语音对话参数
低中
env
进程环境补齐
高
secrets
密钥后端
中高
auth
凭证 profile 与轮换
中高
logging
日志级别/格式/落盘/脱敏
高
identity
Agent 名称与人格主题
中
update
升级通道与自动更新策略
中
discovery
mDNS/DNS-SD 发现
低中
ui
控制台主题与界面体验
低中
bindings
多 Agent 渠道路由规则
中高
acp
ACP 运行时参数
低中

3. agents:核心中的核心

3.1 defaults.workspace

工作目录,承载 AGENTS.md、USER.md、SOUL.md、memory、工具产物等。你可以理解成 Agent 的“家目录”。

3.2 defaults.model / models / imageModel

字段
作用
建议
model.primary
主模型
先选稳定高性价比
model.fallbacks[]
降级链
至少配置一个
models.<id>
可切换模型目录
配 alias 便于 /model 切换
imageModel.primary
图像生成专用模型
独立于文本模型
imageMaxDimensionPx
视觉输入边长上限
1200 常用

3.3 defaults.heartbeat

定时心跳任务,适合日报、巡检提醒。字段包含 every、model、prompt、target、directPolicy。

3.4 defaults.compaction

上下文过长时自动压缩,避免 Token 爆掉。资料中共同确认的关键字段是 softThresholdTokens 和 model。

3.5 defaults.sandbox

沙箱隔离高风险工具调用。常见 mode:off、non-main、all;scope:session、agent、shared。

3.6 defaults 其他常用字段

  • thinkingDefault: off/low/high
  • elevatedDefault: off/full
  • timeoutSeconds: 默认 600
  • maxConcurrent: 默认 3
  • userTimezone: 如 Asia/Shanghai
  • subagents.maxConcurrent: 子 Agent 并发上限
  • skills: 共享技能白名单,[] 表示禁用
  • skipBootstrap: 是否跳过 Bootstrap prompt

3.7 agents.list 与 3.8 bindings

当你要把“家用”和“工作”隔离,或把不同账号路由给不同 Agent,就用 agents.list + bindings。匹配优先级通常是 peer > guildId/teamId > accountId > channel > 默认。


4. channels:消息渠道全量说明

4.1 通用策略

策略
可选值
意义
dmPolicy
pairing / allowlist / open / disabled
控制私聊接入
groupPolicy
allowlist / open / disabled
控制群聊接入

4.2 WhatsApp

重点字段:allowFrom(E.164 号码)、textChunkLimit、chunkMode、mediaMaxMb、sendReadReceipts、groups、accounts、defaultAccount。多账号最容易配置漏的是 defaultAccount。

4.3 Telegram

重点字段:botToken 或 tokenFile、streaming、replyToMode、webhookUrl、proxy、retry、configWrites。streaming=partial 会增加编辑请求次数,需关注限流。

4.4 Discord

重点字段:token、allowBots、historyLimit、textChunkLimit、threadBindings、actions、guilds。审核功能 moderation 常默认关闭,别误判权限。

4.5 Slack

重点字段:botToken(xoxb)、appToken(xapp)、signingSecret、nativeStreaming、typingReaction、thread.historyScope。Socket Mode 和 HTTP Mode 不能混配。

4.6 中国 IM(飞书/钉钉/企微/QQ)

这些通常依赖社区插件,字段以插件版本为准。常见核心字段分别是 appId/appSecret、clientId/clientSecret、robotCode、botId/secret。


5. gateway:网关配置项逐条解释

字段
默认
作用
gateway.port
18789
HTTP + WS 复用端口
gateway.bind
127.0.0.1
监听地址(loopback/lan)
gateway.mode
local
运行模式(local/remote)
gateway.auth.mode
无
token/password/trusted-proxy/none
gateway.reload.mode
hybrid
hot/restart/off 可切换
channelHealthCheckMinutes
5
渠道健康巡检周期
channelMaxRestartsPerHour
10
单渠道每小时重启上限

警告:Docker 中如果 bind 还是 loopback,做了 -p 映射也可能外部无法访问。容器场景通常要配 bind: "lan" 或 host 网络。

6. session:会话隔离与寿命管理

字段
默认
作用
dmScope
main
上下文隔离粒度
reset.mode
无
daily/idle/manual
reset.atHour
4
daily 模式重置点
maintenance.*
warn / 30d / 500
会话清理与轮转

重点:多用户多渠道部署建议直接用 per-channel-peer,最稳,不会串会话。

7. models:自定义提供商与本地模型

典型用途:接 OpenAI 兼容网关、Ollama、LM Studio、自建代理。关键是 mode、providers.<id>.baseUrl、api 适配器。

8. tools:最关键安全边界

推荐最小权限思路:先 profile 选低,后续按需放开;deny 永远比 allow 优先;workspaceOnly 建议开启。

tools: {  profile: "coding",  deny: ["canvas", "browser"],  fs: { workspaceOnly: true },  exec: { timeoutSec: 60, backgroundMs: 10000 },  loopDetection: { enabled: true, maxSameToolCalls: 5 }}

9. env / secrets / auth:凭证体系全量说明

9.1 env.vars 与 shellEnv

env.vars 只在进程环境未定义时补齐,适合非敏感默认值;shellEnv 用于从登录 shell 继承环境变量。

9.2 ${ENV_VAR} 替换

配置内任意字符串可引用环境变量。变量缺失会报错,这能尽早暴露安全配置问题。

9.3 API key 优先级

优先级
变量名
说明
1
OPENCLAW_LIVE_<PROVIDER>_KEY
一次性覆盖
2
<PROVIDER>_API_KEYS
轮换池,仅 429 触发
3
<PROVIDER>_API_KEY
常规单 key

9.4 SecretRef 来源

  • source: env(环境变量)
  • source: file(文件)
  • source: exec(外部命令,如 Vault CLI)

10. cron / hooks:自动化与事件入口

10.1 cron

cron 块控制“运行器”,任务条目建议放到 agents.list[].crons[]。关键字段:enabled、maxConcurrentRuns、sessionRetention、runLog、retry、failureAlert。

10.2 hooks

关键字段:enabled、token、path、defaultSessionKey、allowRequestSessionKey、mappings。payload 来自外部,必须视为不可信输入。

警告:hooks.token 必须配置;allowUnsafeExternalContent 保持关闭;外部请求体不要直接喂高权限工具。

11. 其他常用模块(经常被忽略)

模块
关键字段
作用
identity
name/theme
统一 Agent 身份表达
messages
responsePrefix/ackReaction/tts
消息体验、交互反馈
memory
backend/qmd.paths/limits/update
长期记忆索引策略
logging
level/format/file/redactSensitive
观测与脱敏
update
channel/checkOnStart/auto.enabled
升级节奏控制
discovery
mdns.mode / wideArea.enabled
服务发现开关
ui
主题与界面偏好
控制台使用体验
$include
单文件或数组
配置拆分,最多 10 层嵌套

12. 生产参考配置(可直接改造)

{  identity: { name: "Clawd", theme: "helpful AI assistant" },  agents: {    defaults: {      workspace: "~/.openclaw/workspace",      userTimezone: "Asia/Shanghai",      model: {        primary: "anthropic/claude-sonnet-4-6",        fallbacks: ["openai/gpt-4.1"]      },      heartbeat: { every: "2h", model: "openai/gpt-4.1-mini" },      compaction: { softThresholdTokens: 40000, model: "openai/gpt-4.1-mini" },      timeoutSeconds: 600,      maxConcurrent: 3    }  },  models: {    providers: {      anthropic: { apiKey: "${ANTHROPIC_API_KEY}" },      openai: { apiKey: "${OPENAI_API_KEY}" }    }  },  channels: {    defaults: { groupPolicy: "allowlist" },    whatsapp: {      dmPolicy: "allowlist",      allowFrom: ["+8613800138000"],      groups: { "*": { requireMention: true } }    },    telegram: {      enabled: true,      botToken: "${TELEGRAM_BOT_TOKEN}",      dmPolicy: "pairing",      streaming: "partial",      historyLimit: 50    }  },  gateway: {    bind: "loopback",    auth: { mode: "token", token: "${OPENCLAW_GATEWAY_TOKEN}" },    reload: { mode: "hybrid", debounceMs: 300 }  },  session: {    dmScope: "per-channel-peer",    reset: { mode: "daily", atHour: 4, idleMinutes: 120 },    maintenance: { mode: "prune", pruneAfter: "30d", maxEntries: 500 }  },  tools: {    profile: "coding",    fs: { workspaceOnly: true },    exec: { timeoutSec: 60 },    loopDetection: { enabled: true, maxSameToolCalls: 5 }  },  cron: {    enabled: true,    maxConcurrentRuns: 2,    sessionRetention: "24h"  },  env: {    vars: { TZ: "Asia/Shanghai" },    shellEnv: { enabled: true }  },  logging: {    level: "info",    redactSensitive: true  }}

13. 安全最佳实践(生产必做)

实践
落地动作
不提交敏感文件
openclaw.json、.env 入 .gitignore
环境变量注入
配置中全写 ${VAR},真实值放环境
权限最小化
tools.deny 关掉不必要工具
远程访问收口
loopback + 隧道,不裸露公网端口
定期审计
openclaw security audit --deep
密钥轮换
建议 90 天更新一次

14. CLI 配置命令速查(收藏即用)

# 查看配置openclaw config getopenclaw config get agents.defaults.workspaceopenclaw config get --json# 修改配置openclaw config set agents.defaults.heartbeat.every "2h"openclaw config set session.dmScope "per-channel-peer"# 删除配置项(回默认)openclaw config unset plugins.entries.brave.config.webSearch.apiKey# 导出 Schemaopenclaw config schema > config.schema.json# 诊断与修复openclaw doctoropenclaw doctor --fixopenclaw doctor --deep --yes# 安全审计openclaw security audit --deepgrep -r "sk-" ~/.openclaw/# 运行状态openclaw status --allopenclaw health --json --verboseopenclaw logs --follow --level warnopenclaw logs --json# Gateway 控制openclaw gateway startopenclaw gateway stopopenclaw gateway restart

重点:对小白最有价值的落地顺序是:先 schema,再 6 大核心块(agents/channels/gateway/session/models/tools),然后 doctor + health + status 三连验证。


一句话结论:openclaw.json 是 OpenClaw 的运行总开关。把配置当工程来维护,你的稳定性、安全性、成本都能显著提升。

关于openclaw资料包和系列文章

配套资料包

私信 kekohu 获取,内容不定期持续更新。

选项
内容
价格
资料包
《入门到精通》+《102个实战案例》+《避坑手册》+《数百skill技能包》+《AI日报》,付款后即发飞书权限
69元
付费社群
含上述全套资料包 + 群内实操答疑 + 不定期干货分享 + 同行交流
99 元

注意:付费社群包含资料包全部内容,无需重复购买。

openclaw系列文章

持续更新,建议每篇认真阅读

配置与理解

彻底搞懂 OpenClaw 配置体系:这才是 AI Agent 的正确打开方式
你在飞书或者微信发了句"你好",OpenClaw 到底花了多少 Token?
详细指南  微信插件支持OpenClaw
OpenClaw龙虾如何自我纠错   5步自我迭代法
【网友都说贼好看】我让openclaw开发了一个自己的交互式说明书

别被骗,OpenClaw 可以 24 小时干活——但你得先做对这 6 件事

火了三个月的"龙虾",普通人装了真的有用吗?

用 OpenClaw 把 AI 失忆治好:开关、精简、外挂三步走

OpenClaw 命令完整手册
OpenClaw 到底怎么跑?部署方式与玩法全景
如何申请 Brave Search API 密钥并配置 OpenClaw
大白话讲清楚OpenClaw的记忆术
OpenClaw 长任务必读:用 Sub-Agent 隔离上下文,token 消耗降 85%
OpenClaw 省 Token 实操手册:八个维度,节省 60–90%
OpenClaw 曲线救国:通过 CLI 后端使用 Claude 模型
飞书跟openclaw集成实操教程
【该文为openclaw输出】OpenClaw超简单且免费的安装实操教程

多 Agent 与协作

OpenClaw 多 Agent 协作实战完全教程
OpenClaw 多代理配置指南:让 AI 团队帮你同时干多件事

技能与工具

OpenClaw 官方 53 个技能完整指南:功能详解 + 风险评估 + 安装建议
【免费领取】7套不同赛道风格公众号排版Skill(有效果图)
12类人群必装的OpenClaw Skills
不写代码,如何让 OpenClaw Agent 学会新技能

实战与案例

本地部署 OpenClaw 自动发布公众号:小白完整教程
【实操分享】OpenClaw多文档多输入源笔记整理Agent搭建
本地部署 OpenClaw 自动发布小红书:小白完整教程
【保姆教程】OpenClaw作业错题分析师,每个家长都可以学起来
OpenClaw 完全指南:从零搭建你的 AI 员工团队
看看这个龙虾速度,就知道这OpenClaw有多火,速度跟上
OpenClaw 完全指南:从零搭建你的 AI 员工团队
OpenClaw 实战:从0到1搭建你的云端AI工作流
我的OpenClaw 多Agent 会主动发来 “上班打卡”
OpenClaw 实战操作指南:12大热门应用案例详细教程
我的openclaw龙虾开始自己赚钱了
用上了openclaw,跟telegram能双向通信了

排错与安全

OpenClaw 排错指南
OpenClaw 龙虾玩家的安全指南

关于娇姐

40+ IT 从业者,前荣耀员工,现专注 AI 效率工具研究与实践。持续输出 OpenClaw 及 AI 工具的干货教程与落地案例,偶尔分享职场思考与生活感悟。

高考的坚持与感恩:我心中的那座桥,跨越了命运
40 + IT女从荣耀离职:找工作碰壁、陪娃焦虑的日子里,我靠 AI 公众号找到了自我

提示:觉得有用,点赞、关注、转发,是我持续创作的动力。

相关学习资料