Deployment guide

部署 rCodex Gateway

在运行 Codex 的电脑上安装 Gateway,再让手机连接这台机器。Linux 和 macOS 可以使用一条命令完成运行环境、Gateway 与后台服务安装。

运行环境自动准备 Node.js 22安装方式用户态一键安装适用场景个人主机与个人服务器

01 / Prepare

开始前,确认这三项环境。

Gateway 使用当前系统用户的 Codex CLI 登录态,因此安装和运行都应该在同一个用户下完成。

Node.js 与 npm

Node.js 需要 22 或更高版本,npm 用于安装 Gateway。

node --versionnpm --version

Codex CLI

当前用户已经完成 Codex 登录,并且终端可以找到命令。

codex --version

工作区目录

准备允许 rCodex 访问的项目目录。后续可以在 Gateway 配置中限制允许路径。

网络可达

手机需要能访问 Gateway 地址。局域网使用时,先确认两台设备网络互通。

个人部署边界

rCodex 当前面向个人远程控制场景。对公网开放前,请自行配置可信的反向代理、TLS 和访问边界。

02 / Install

一条命令完成 Gateway 安装。

Linux 和 macOS 使用用户态安装脚本;Windows 继续使用 npm 安装。

1

Linux / macOS

自动复用或安装 Node.js 22,并完成 Gateway 配置与当前用户后台服务启动。

curl -fsSL https://dl.rcodex.org/rcodex/install.sh | sh
2

Windows 手工安装

准备 Node.js 22 后通过 npm 安装,并按 Windows 指南创建当前用户计划任务。

npm install -g @rcodex-lab/gateway
rcodex-gateway setup
rcodex-gateway service install
rcodex-gateway service start

03 / Connect

连接手机 App。

Gateway 启动后,可以通过 Gateway Console 的连接二维码写入地址和账号,也可以手动填写。

扫码连接

在浏览器打开 Gateway Console 的连接页面,用 rCodex App 扫描一次性登录二维码。

手动连接

填写 Gateway 地址、管理员账号和初始化时生成的密码。

http://主机局域网IP:8787
地址格式

登录地址只填写 Gateway 根地址,不要追加 `/auth/login` 或 Console 页面路径。

04 / Upgrade

升级 Gateway。

自更新命令会更新当前安装目录、刷新服务定义、重启并显示最终状态。

rcodex-gateway service update

查看当前 Gateway 升级说明

05 / Troubleshooting

常见问题。

安装后找不到 `rcodex-gateway`

确认 npm 全局命令目录已经加入 PATH,然后重新打开终端。

Gateway 找不到 Codex CLI

先确认同一用户下 `codex --version` 正常;仍不稳定时,在配置中把 `CODEX_COMMAND` 写成绝对路径。

App 能登录,但看不到项目目录

检查允许目录配置是否包含目标项目,并确认 Gateway 进程用户对目录有读取权限。

手机无法访问 8787 端口

先在主机本机验证 Gateway,再检查局域网地址、系统防火墙和路由器隔离设置。