📘 Gateway 网关运行手册 — 关键内容与操作流程
1) Gateway 是什么
Gateway 网关服务是一款长期运行的进程,用于处理连接控制、事件平面,与底层 Baileys / Telegram 等协议对接,为客户端提供 RPC/HTTP 接口。它自身启动后持续运行,出现致命错误会以非零退出码退出以便 supervisor 重启。([openclaw.cc][1])
🚀 2) 启动与运行
本地启动示例
openclaw gateway--port18789# 开启网关服务openclaw gateway--port18789--verbose# debug/trace 日志输出openclaw gateway--force# 如果端口被占用,强制重启提示
- 默认监听端口是
18789。 --verbose显示详细调试日志。--force用以终止可能已占用该端口的进程,然后重新启动。([openclaw.cc][1])
⚙️ 3) 配置与热重载机制
配置文件位置
网关默认读取:
~/.openclaw/openclaw.json可通过环境变量替换:
OPENCLAW_CONFIG_PATH=<你的配置路径>热重载模式
| 模式 | 说明 |
|---|---|
hybrid(默认) | 尝试热应用安全配置,更改重大配置时触发重启 |
off | 禁止热重载,所有更改需手动重启服务 |
这个模式由gateway.reload.mode控制。([openclaw.cc][1])
📡 4) 端口与接口说明
默认端口与服务
控制与事件 WebSocket:
127.0.0.1:<port>
(通常是上面指定的 18789)HTTP 服务(复用同一端口)
支持如下接口:/v1/chat/completions/v1/responses/tools/invoke
Canvas 文件服务
- 在默认情况下,Canvas 静态文件服务器启动在
18793。 - 可用
canvasHost.enabled=false或设置OPENCLAW_SKIP_CANVAS_HOST=1禁用。([openclaw.cc][1])
🛠️ 5) Supervisor / 管理(运行模式)
建议使用Supervisor 管理器(如 systemd、launchd 等)将 Gateway 作为守护进程运行:
- 正常停止/重启发送:SIGTERM
- 错误退出码:非 0(可被 supervisor 捕获并重启)
- 可用日志轮转机制防止日志无限增长。([openclaw.cc][1])
🔐 6) 认证与安全配置
默认情况下,Gateway 要求认证。你需要配置一种方式:
| 配置项 | 说明 |
|---|---|
gateway.auth.token | 访问令牌 |
gateway.auth.password | 密码 |
客户端必须发送匹配的connect.params.auth.token或connect.params.auth.password才能连接,除非使用诸如 Tailscale Serve 等身份方法。([openclaw.cc][1])
🧪 7) 检查与诊断
常见的检查项包括:
健康检查(Health):
openclaw gateway status正常输出例子:
Runtime: running Connectivity probe: ok渠道就绪检查:
openclaw channels status--probe实时日志:
openclaw logs--follow可以帮助分析连接或 RPC 调用失败原因。([OpenClaw][2])
🧾 8) 参考结构(文档部分索引)
完整文档还包含以下部分:
- 多个 Gateway 实例在同一主机的管理
- Dev 模式快速配置
- 协议运维参考(RPC/事件/错误码结构)
- 远程访问与安全保证
- systemd / macOS service 示例
- 错误处理场景与恢复策略
- CLI 工具辅助功能
- 迁移指南(版本升级)([OpenClaw][2])
📌 总结
这份运行核心覆盖了 Gateway 网关的:
- 启动步骤与运行命令
- 配置与热重载机制
- 端口与服务说明
- Supervisor 守护运行策略
- 认证与安全机制
- 健康检查与日志追踪策略
参考链接:
[1]: https://openclaw.cc/gateway/?utm_source=chatgpt.com “Gateway 网关运行手册 | OpenClaw 中文站”
[2]: https://docs.openclaw.ai/zh-CN/gateway?utm_source=chatgpt.com “Gateway 网关运行手册 - OpenClaw”