Skip to content

附录 A:OpenClaw 配置速查表

本附录列出 OpenClaw 最常用的配置项,帮助读者快速查阅。所有配置项定义在 src/config/types*.tssrc/config/defaults.ts 中。

如何使用本附录

OpenClaw 配置采用 YAML 格式(openclaw.yaml),支持三种覆盖方式:

  1. 配置文件:在 openclaw.yaml 中以层级结构书写,如 gateway.port: 19000
  2. 环境变量:部分核心配置可通过环境变量注入(见 §A.9)
  3. CLI 参数:运行时通过 openclaw --port 19000 等方式覆盖

查阅建议:表中"默认值"列为空(—)的配置项,表示该值不会自动填充,需要用户显式设置才能生效。标记为 SecretInput 类型的字段支持直接字符串、env:VAR_NAME 引用或 file:/path 引用三种写法。完整的 JSON Schema 可通过 openclaw config schema 命令导出。


A.1 Gateway 配置(gateway.*

配置项类型默认值说明
gateway.portnumber18789Gateway WS + HTTP 复用端口
gateway.bindstring"loopback"绑定模式:auto / lan / loopback / tailnet / custom
gateway.customBindHoststringbind="custom" 时的自定义 IP
gateway.modestring"local""local" 本地启动 / "remote" 远程连接
gateway.channelHealthCheckMinutesnumber5通道健康检查间隔(分钟),0 禁用
gateway.channelStaleEventThresholdMinutesnumber30通道无事件超时阈值(分钟)
gateway.channelMaxRestartsPerHournumber10每小时最大自动重启次数

A.1.1 认证(gateway.auth.*

配置项类型默认值说明
gateway.auth.modestring"token"认证模式:none / token / password / trusted-proxy
gateway.auth.tokenSecretInputToken 认证的共享密钥
gateway.auth.allowTailscaleboolean允许 Tailscale 身份 Header
gateway.auth.rateLimit.maxAttemptsnumber10失败次数上限
gateway.auth.rateLimit.windowMsnumber60000滑动窗口(毫秒)
gateway.auth.rateLimit.lockoutMsnumber300000锁定时长(毫秒)

A.1.2 TLS(gateway.tls.*

配置项类型默认值说明
gateway.tls.enabledbooleanfalse启用 TLS
gateway.tls.autoGeneratebooleantrue自动生成自签名证书
gateway.tls.certPathstringPEM 证书路径
gateway.tls.keyPathstringPEM 私钥路径

A.1.3 热重载(gateway.reload.*

配置项类型默认值说明
gateway.reload.modestring"hybrid"重载策略:off / restart / hot / hybrid
gateway.reload.debounceMsnumber300防抖窗口(毫秒)
gateway.reload.deferralTimeoutMsnumber300000最大等待进行中操作时间

A.1.4 远程连接(gateway.remote.*

配置项类型默认值说明
gateway.remote.urlstring远程 Gateway WebSocket URL
gateway.remote.transportstring"direct"传输方式:ssh / direct
gateway.remote.tokenSecretInput远程认证 Token
gateway.remote.tlsFingerprintstringTLS 证书指纹(sha256)

A.2 会话配置(session.*

配置项类型默认值说明
session.scopestring"per-sender"会话范围:per-sender / global
session.dmScopestring"main"DM 会话范围:main / per-peer / per-channel-peer
session.idleMinutesnumber空闲超时(分钟)
session.typingModestring"thinking"打字指示:never / instant / thinking / message
session.resetTriggersstring[]重置触发关键词

A.2.1 会话重置(session.reset.*

配置项类型默认值说明
session.reset.modestring"daily"重置模式:daily / idle
session.reset.atHournumber0每日重置时间(0-23 本地小时)
session.reset.idleMinutesnumber空闲滑动窗口(分钟)

A.3 Agent 配置(agents.*

配置项类型默认值说明
agents.<id>.modelstringAgent 使用的模型 ID(如 anthropic/claude-opus-4-6
agents.<id>.systemPromptstring系统提示词
agents.<id>.contextTokensnumber默认值随模型上下文窗口 Token 上限
agents.<id>.maxConcurrentnumber见默认最大并发请求数
agents.<id>.toolsobject工具配置(allow/deny/profiles)
agents.<id>.skillsobject技能配置

A.4 模型配置(models.*

配置项类型默认值说明
models.<id>.idstringProvider 模型 ID
models.<id>.namestring显示名称
models.<id>.apistringAPI 协议(如 anthropic-messages
models.<id>.cost.inputnumber0输入 Token 单价
models.<id>.cost.outputnumber0输出 Token 单价
models.<id>.maxTokensnumber8192单次最大输出 Token

默认模型别名

别名解析为
opusanthropic/claude-opus-4-6
sonnetanthropic/claude-sonnet-4-6
gptopenai/gpt-5.4
gpt-miniopenai/gpt-5-mini
geminigoogle/gemini-3.1-pro-preview
gemini-flashgoogle/gemini-3-flash-preview

A.5 通道配置(channels.*

配置项类型默认值说明
telegram.botTokenSecretInputTelegram Bot Token
telegram.webhook.urlstringWebhook URL
discord.botTokenSecretInputDiscord Bot Token
discord.appIdstringDiscord 应用 ID
whatsapp.phoneIdstringWhatsApp 手机号 ID
slack.botTokenSecretInputSlack Bot Token
slack.appTokenSecretInputSlack App Token(Socket Mode)
feishu.appIdstring飞书应用 ID
feishu.appSecretSecretInput飞书应用密钥

A.6 工具与安全配置

A.6.1 工具(tools.*

配置项类型默认值说明
tools.allowstring[]允许的工具列表
tools.denystring[]禁止的工具列表
tools.profilesstring[]工具配置文件(能力包)

A.6.2 来源白名单(allowFrom.*

配置项类型默认值说明
allowFrom.usersstring[]允许交互的用户 ID 列表
allowFrom.groupsstring[]允许交互的群组 ID 列表

A.6.3 Exec 审批(approvals.*

配置项类型默认值说明
approvals.modestring审批模式
approvals.allowliststring[]免审批命令白名单

A.6.4 Sandbox(sandbox.*

配置项类型默认值说明
sandbox.enabledbooleanfalse启用沙箱
sandbox.docker.imagestringDocker 镜像名称

A.7 定时任务(cron.*

配置项类型默认值说明
cron.<name>.schedulestringCron 表达式(5/6 字段)
cron.<name>.promptstring触发时发送的提示词
cron.<name>.agentstring执行 Agent ID
cron.<name>.channelstring目标通道

A.8 TTS / Talk 配置(talk.*

配置项类型默认值说明
talk.providerstring"elevenlabs"TTS 提供商
talk.voiceIdstring默认语音 ID
talk.voiceAliasesRecord语音名称映射
talk.interruptOnSpeechbooleantrue用户说话时停止播放
talk.silenceTimeoutMsnumber静默超时(毫秒)

A.9 环境变量

环境变量说明
ANTHROPIC_API_KEYAnthropic API 密钥
OPENAI_API_KEYOpenAI API 密钥
TELEGRAM_BOT_TOKENTelegram Bot Token
DISCORD_BOT_TOKENDiscord Bot Token
OPENCLAW_GATEWAY_TOKENGateway 认证 Token
OPENCLAW_CONFIG_PATH自定义配置文件路径

A.10 默认端口

端口用途
18789Gateway 主端口(WS + HTTP)
18790Bridge 端口
18791Browser Control 端口
18793Canvas Host 端口
18800-18899Browser CDP 端口范围

提示:完整配置 Schema 可通过 openclaw config schema 命令查看,或参阅 src/config/zod-schema.ts

基于 VitePress 构建