简要总结
Gateway Runbook
这页说明书是教你如何启动和管理一个叫“Gateway”的服务,你可以把它想象成一个聪明的交通警察,专门负责指挥电脑里的各种信息。当你第一次想使用它,或者平时需要检查它是否工作正常时,就可以看看这页。
它告诉你怎么用简单的命令让它开始工作,怎么检查它是不是很健康,还有怎么让它一直乖乖地运行,不会偷偷跑掉。
五岁小孩版解释
这个Gateway服务就像一个一直在工作的信息小管家。它在一个固定的“门”(端口)上等着,帮我们处理各种请求,比如聊天、画画或者执行任务。下面我们来看看怎么让它开始工作。
第一步:让Gateway开始工作
- 要启动Gateway,你需要告诉电脑一个命令。打开一个命令窗口,输入
openclaw gateway --port 18789。这就像说:“小管家,请到18789号门开始工作吧!” - 如果你想看到更多它在做什么的小报告,可以加上
--verbose,比如openclaw gateway --port 18789 --verbose。 - 如果那个门(端口)已经被占用了,你可以用
--force命令,它会先请走占着门的人,再让Gateway进去。
第二步:检查小管家是否健康 启动后,我们要看看它是不是真的在好好工作。
- 输入
openclaw gateway status或openclaw status来问它:“你还好吗?” - 如果它回答
Runtime: running和RPC probe: ok,就说明它很健康,正在快乐地跑步呢! - 你还可以用
openclaw logs --follow命令,像看一个不断更新的日记本一样,看它正在做什么。
第三步:检查它的“电话线”
Gateway需要和其他服务“打电话”(连接通道)。输入 openclaw channels status --probe 来检查一下这些“电话线”是不是都准备好了。
重要提醒:
- Gateway需要一个密码才能工作,这就像进家门需要钥匙。你可以在设置里告诉它密码(
gateway.auth.token或gateway.auth.password),或者通过一个叫OPENCLAW_GATEWAY_TOKEN的环境变量告诉它。 - 默认情况下,它只在自己家里(本机)工作(
loopback模式)。如果你想从外面访问它,需要特别设置。 - 它的配置文件可以“热更新”。大部分时候,你改了设置,它不用重启就能生效(
hybrid模式)。但有些大改动,它可能需要重启一下自己。
让它一直乖乖运行(像守护神一样) 如果你想让Gateway一直工作,即使你关掉了命令窗口,可以把它安装成一个“服务”。
- 在苹果电脑(macOS)上,用
openclaw gateway install命令,它就会把自己注册成一个后台小精灵(LaunchAgent)。 - 在Linux电脑上,也可以用
openclaw gateway install,然后使用systemctl命令来管理和启动它,让它一直在后台运行。
如果出错了怎么办? 这里有一些常见的错误和可能的原因:
- 如果它说“没有密码我不能在非本地工作”(
refusing to bind gateway ... without auth),说明你让它对外工作,但没给它密码。 - 如果它说“这个门(端口)已经有人在用了”(
EADDRINUSE),你就需要换一个门(端口)号,或者用--force命令。 - 如果连接时它说“你不被允许”(
unauthorized),那可能是你给的密码和它记住的密码不一样。
最后的安全保证
这个Gateway小管家很可靠:如果它自己不在,其他程序会立刻知道,不会乱跑。如果不是用正确的方式(第一句话必须是 connect)和它打招呼,它会拒绝并关上门。当它要休息(关闭)时,也会先礼貌地说一声“我要下班啦”(shutdown 事件),然后再离开。