rCodex Logo rCodexWindows Deployment

WINDOWS GUIDE

Windows 部署

这页内容来自现有 Windows 部署手册，适用于 Docker Desktop + WSL 2 backend 的部署方式。

部署前提

  • Windows 10/11
  • Docker Desktop，启用 WSL 2 backend
  • PowerShell
  • Codex CLI 已在当前 Windows 用户下登录
  • 实际工作区目录，例如 `C:\rcodex-workspace`

你需要的文件

  • `docker-compose.yml`
  • `.env.example`
  • `gateway-image-<version>.tar`，离线分发时需要
  • `rCodex-<version>.apk`

STEP BY STEP

推荐流程

STEP 1

检查环境

先执行 `docker version`、`docker compose version`、`codex --version` 与 `Test-Path "$env:USERPROFILE\\.codex"`。

STEP 2

创建部署目录

建议使用 `C:\rcodex-deploy` 和 `C:\rcodex-workspace`，并准备 `gateway-data` 子目录。

STEP 3

修改 `.env`

Windows 路径优先写成正斜杠格式，例如 `C:/Users/你的用户名/.codex`，同时让 `GATEWAY_ALLOWED_PATHS` 与容器内路径一致。

STEP 4

确认 Docker Desktop 文件共享

至少保证 `.codex`、`.claude`、工作区目录和 `gateway-data` 可被容器挂载访问。

STEP 5

启动 Gateway

离线包用 `docker load -i`，镜像仓库则用 `docker compose pull`，然后统一 `docker compose up -d`。

STEP 6

开放端口并在 App 登录

必要时创建 Windows 防火墙入站规则，App 登录地址填写 `http://Windows局域网IP:8787`。

EXAMPLE

关键配置示例

RCODEX_CODEX_HOME_HOST_PATH=C:/Users/你的用户名/.codex
RCODEX_CLAUDE_HOME_HOST_PATH=C:/Users/你的用户名/.claude
RCODEX_WORKSPACE_HOST_PATH=C:/rcodex-workspace
RCODEX_WORKSPACE_CONTAINER_PATH=/workspace
GATEWAY_ALLOWED_PATHS=/workspace

GATEWAY_PORT=8787
GATEWAY_AUTH_USERNAME=your-name
GATEWAY_AUTH_PASSWORD=change-this-password
GATEWAY_AUTH_TOKEN=change-this-to-a-long-random-string

COMMON ISSUES

最常见的几个坑

Docker 挂载目录失败

优先检查 Docker Desktop 文件共享和 `.env` 中的 Windows 路径是否真实存在。

App 能登录但目录打不开

通常是 `RCODEX_WORKSPACE_CONTAINER_PATH` 与 `GATEWAY_ALLOWED_PATHS` 没对齐。

手机访问不到 8787

先确认 Windows 本机能 `curl`，再放行 Windows 防火墙端口。