Files
claude-code/docs/features/modes/remote-control-self-hosting.md
claude-code-best 37dac682b9 docs: 文档大重组,对齐 README 入口
以 README 为单一事实来源,重构整个 docs/ 目录。

最终结构(3 大组、15 篇文档):
- 开始: installation / quickstart / model-providers
- 核心功能: pipes-and-lan、acp、channels、chrome-control、computer-use、
  voice-mode、web-browser-tool、auto-dream、remote-control-self-hosting、
  langfuse-monitoring
- 内部机制: growthbook-adapter、sentry-setup

主要变更:
- 删除 56 个 README 未提及的文档(architecture 全部 / guides 全部 /
  features 中未在 README 出现的 20 篇 / internals 中的 5 篇)
- 合并 6 组重复文档(pipes-and-lan、chrome-control、acp、computer-use、
  auto-dream、coordinator-mode 简化为入口)
- features 子组从 5 → 4,ui/ 合并入 tools/
- 所有保留文档加上人性化 frontmatter(title/description/keywords)
- docs.json navigation 简化为 3 大组,redirects 重新过滤为 7 条合并跳转
- 新增 docs.md 工作大纲与验证脚本(verify-docs / check-docs-orphans /
  dump-docs-outline)

总计 130 文件改动,从约 35000 行精简到约 2000 行。

Co-Authored-By: glm-5.2 <zai-org@claude-code-best.win>
2026-06-15 16:51:29 +08:00

13 KiB
Raw Blame History

title, description, keywords
title description keywords
Remote Control 私有化部署 Docker 自托管 RCS含 Web UI 控制面板、ACP agent 接入、JWT 认证。
Remote Control Server
Docker 部署
ACP agent
JWT 认证
Web UI 控制面板

Remote Control Server 私有化部署指南

本指南说明如何将 Remote Control Server (RCS) 部署到私有环境,并通过 Claude Code CLI 连接使用。

架构概览

┌──────────────────┐                    ┌──────────────────────┐
│  Claude Code CLI  │ ◄── HTTP/SSE/WS ─►│  Remote Control      │
│  (Bridge Worker)  │     长轮询 + 心跳   │  Server (RCS)        │
└──────────────────┘                    │                      │
                                        │  ┌──────────────┐    │
┌──────────────────┐   HTTP/SSE        │  │ In-Memory    │    │
│  Web UI 控制面板  │ ◄─────────────── │  │ Store        │    │
│  (/code/*)       │                   │  └──────────────┘    │
│  (React + Vite)  │                   │  ┌──────────────┐    │
└──────────────────┘                   │  │ JWT Auth     │    │
                                       │  └──────────────┘    │
┌──────────────────┐                   │  ┌──────────────┐    │
│  acp-link        │ ◄── ACP Relay ─── │  │ ACP Handler  │    │
│  + ACP Agent     │     WebSocket      │  └──────────────┘    │
└──────────────────┘                   └──────────────────────┘

RCS 是一个纯内存的中间服务,它的职责是:

  • 接收 Claude Code CLI 的环境注册和工作轮询
  • 接收 acp-link 的 ACP agent 注册,支持 WebSocket relay 桥接
  • 提供 Web UI 供操作者远程监控和审批
  • 通过 WebSocket/SSE 双向传输消息
  • 管理会话、环境、权限请求
  • 提供 ACP SSE event stream 供外部消费者订阅 channel group 事件

前置条件

  • 一台可被 Claude Code CLI 和 Web 浏览器同时访问的服务器物理机、VM、容器均可
  • Docker
  • 启用 BRIDGE_MODE feature flag 的 Claude Code 构建

部署

构建 Docker 镜像

在项目根目录执行:

docker build -t rcs:latest -f packages/remote-control-server/Dockerfile .

启动容器

docker run -d \
  --name rcs \
  -p 3000:3000 \
  -e RCS_API_KEYS=sk-rcs-your-secret-key-here \
  -e RCS_BASE_URL=https://rcs.example.com \
  -v rcs-data:/app/data \
  --restart unless-stopped \
  rcs:latest

Docker Compose

version: "3.8"
services:
  rcs:
    build:
      context: .
      dockerfile: packages/remote-control-server/Dockerfile
      args:
        VERSION: "0.1.0"
    ports:
      - "3000:3000"
    environment:
      - RCS_API_KEYS=sk-rcs-your-secret-key-here
      - RCS_BASE_URL=https://rcs.example.com
    volumes:
      - rcs-data:/app/data
    restart: unless-stopped

volumes:
  rcs-data:

启动:

docker compose up -d

环境变量参考

服务器端

变量 必填 默认值 说明
RCS_API_KEYS (空) API 密钥列表,逗号分隔。用于客户端认证和 JWT 签名。务必设置强密钥
RCS_PORT 3000 服务监听端口
RCS_HOST 0.0.0.0 服务监听地址
RCS_BASE_URL http://localhost:3000 外部访问 URL。用于生成 WebSocket 连接地址,必须与客户端实际访问的地址一致
RCS_VERSION 0.1.0 版本号,显示在 /health 响应中
RCS_POLL_TIMEOUT 8 V1 工作轮询超时(秒)
RCS_HEARTBEAT_INTERVAL 20 心跳间隔(秒)
RCS_JWT_EXPIRES_IN 3600 JWT 令牌有效期(秒)
RCS_DISCONNECT_TIMEOUT 300 断线判定超时(秒)
RCS_WS_IDLE_TIMEOUT 30 WebSocket 空闲超时Bun 发送协议级 ping
RCS_WS_KEEPALIVE_INTERVAL 20 服务端→客户端 keep_alive 帧间隔(秒),防止反向代理关闭空闲连接

客户端Claude Code CLI

变量 必填 说明
CLAUDE_BRIDGE_BASE_URL RCS 服务器地址,例如 https://rcs.example.com。设置此变量即启用自托管模式,跳过 GrowthBook 门控
CLAUDE_BRIDGE_OAUTH_TOKEN 认证令牌,必须与服务器端 RCS_API_KEYS 中的某个值匹配
CLAUDE_BRIDGE_SESSION_INGRESS_URL WebSocket 入口地址(默认与 CLAUDE_BRIDGE_BASE_URL 相同)
CLAUDE_CODE_REMOTE 设为 1 时标记为远程执行模式

Claude Code 客户端连接

1. 设置环境变量

在运行 Claude Code 的机器上设置:

export CLAUDE_BRIDGE_BASE_URL="https://rcs.example.com"
export CLAUDE_BRIDGE_OAUTH_TOKEN="sk-rcs-your-secret-key-here"

2. 启动 Claude Code

# 使用 dev 模式BRIDGE_MODE 默认启用)
bun run dev

# 或使用构建产物
bun run dist/cli.js

3. 执行 /remote-control 命令

在 Claude Code 的 REPL 中输入:

/remote-control

环境型 Remote Control例如 claude remote-control 子命令)会向 RCS 注册环境,注册成功后在终端显示连接 URL

https://rcs.example.com/code?bridge=<environmentId>

交互式 REPL 方式(--remote-control/remote-control)在某些桥接模式下也可能直接给出会话 URL

https://rcs.example.com/code/session_<id>

两种 URL 都可以直接在浏览器打开并远程操控当前会话;只有 environment 模式才会出现在 Web UI 的环境列表中。

若已连接,再次执行 /remote-control 会显示对话框,包含以下选项:

  • Disconnect this session — 断开远程连接
  • Show QR code — 显示/隐藏二维码
  • Continue — 保持连接,继续使用

也可通过 CLI 参数直接启动:

claude remote-control
# 或简写
claude rc
# 或
claude bridge

Web UI 控制面板

通过 /remote-control 命令获取 URL 后,在浏览器打开即可使用。

技术栈v22026-04-18 重构)

Web UI 已从原生 JS 重构为 React + Vite + Radix UI

  • 框架: React 19 + Vite 构建TypeScript
  • UI 组件: Radix UI primitivesDialog、Tabs、Select、Popover 等)
  • 聊天组件: 完整的 ACP 聊天界面,支持 Plan 可视化、工具调用展示、权限审批
  • AI Elements: 独立的 AI 交互组件库message、reasoning、tool、code-block、prompt-input 等)
  • ACP 直连: 支持 QR 码扫描自动跳转 ACP 直连视图(ACPDirectView
  • 主题系统: 暗色/亮色主题切换,遵循 Impeccable 设计系统

功能

  • 查看已注册的运行环境environment 模式),区分 ACP Agent 和 Claude Code 类型
  • 创建和管理会话
  • 实时查看对话消息和工具调用
  • 查看 Autopilot 状态(standby / sleeping)和自动运行指示
  • 查看 authoritative task snapshots 驱动的 Tasks 面板
  • 审批 Claude Code 的工具权限请求
  • 权限模式选择器6 种模式:默认/自动接受编辑/跳过权限/规划/不询问/自动判断)
  • 模型选择器(可选可用模型)
  • Plan 可视化(进度条、状态图标、优先级标签)
  • ACP QR 扫描自动跳转到 ACP 聊天界面

Web UI 使用 UUID 认证(无需用户账户),适合受信任网络环境。

ACP 支持

RCS 支持 ACP (Agent Client Protocol) agent 通过 acp-link 包接入。

架构

acp-link ──REST注册──► RCS POST /v1/environments/bridge
acp-link ──WS identify──► RCS WebSocket (携带 agentId)
acp-link ◄──ACP relay──► RCS ◄──Web UI WS──► 浏览器

后端组件

文件 职责
src/routes/acp/index.ts ACP REST 路由agents 列表、channel groups、relay
src/transport/acp-ws-handler.ts ACP WebSocket 处理agent 注册、心跳、消息转发
src/transport/acp-relay-handler.ts 前端 WS → acp-link 透传 + EventBus inbound 转发
src/transport/acp-sse-writer.ts SSE event stream 供外部消费者订阅

ACP 的 agents、channel groups、relay 和 channel-group SSE 端点都要求有效 API key。浏览器 EventSource 不能发送 Authorization header外部订阅 /acp/channel-groups/:id/events 时需要使用 fetch + ReadableStream 并带 Authorization: Bearer <api-key>

详见 acp-link 文档

# 在 RCS 环境中启动 acp-link
# 注意claude 本身不支持 ACP需要用 ccb-bun --acp
ACP_RCS_URL=http://localhost:3000 \
ACP_RCS_TOKEN=sk-rcs-your-key \
acp-link ccb-bun -- --acp

ACP session 在 Web UI 中显示品牌色标签,与普通 Claude Code session 区分。

工作流程详解

┌──────────────────────────────────────────────────────────┐
│                    完整工作流程                            │
└──────────────────────────────────────────────────────────┘

 1. Claude Code CLI 启动,设置环境变量指向自托管 RCS

 2. 用户执行 /remote-control 命令

 3. 注册环境
    CLI ──POST /v1/environments/bridge──► RCS
    CLI ◄── { environment_id, environment_secret } ── RCS

 4. 终端显示连接 URL
    https://rcs.example.com/code?bridge=<environmentId>

 5. 开始工作轮询(循环)
    CLI ──GET /v1/environments/:id/work/poll──► RCS
         (长轮询,等待任务分配,超时 8 秒后重试)

 6. 浏览器打开 URL → Web UI 创建任务
    Browser ──POST /web/sessions──► RCS
    RCS 分配 work 给正在轮询的 CLI

 7. CLI 收到任务并确认
    CLI ◄── { id, data: { type, sessionId } } ── RCS
    CLI ──POST /v1/environments/:id/work/:workId/ack──► RCS

 8. 建立会话连接
    CLI ──WebSocket /v1/session_ingress──► RCS
         (或使用 V2 的 SSE + HTTP POST

 9. 双向通信
    CLI ──消息/工具调用结果──► RCS ──► Browser
    CLI ◄──权限审批/指令───── RCS ◄──── Browser
    CLI ──automation_state / task_state──► RCS ──► Browser

10. 心跳保活(每 20 秒)
    CLI ──POST /v1/environments/:id/work/:workId/heartbeat──► RCS

11. 任务完成 → 归档会话 → 注销环境

故障排查

Web UI 看不到当前 Autopilot 状态

  • standbyproactive 已开启,正在等待下一个 tick
  • sleeping:模型正在 SleepTool 等待窗口中

这两个状态通过 worker external_metadata.automation_state 上报。如果页面只显示普通 working spinner优先检查 CLI 和 RCS 之间的 worker metadata PUT 是否成功。

CLI 无法连接

Error: Remote Control is not available in this build.

原因BRIDGE_MODE feature flag 未启用。

解决:使用 dev 模式(默认启用)或确保构建时包含 BRIDGE_MODE flag。

认证失败 (401)

Error: Unauthorized

检查项

  1. CLAUDE_BRIDGE_OAUTH_TOKEN 是否与 RCS_API_KEYS 中的值匹配
  2. API Key 是否包含多余的空格或换行
  3. 两个环境变量是否都已正确设置

WebSocket 连接中断

检查项

  1. 如果使用反向代理,确认已正确配置 WebSocket 升级(Upgrade / Connection 头)
  2. 代理的 proxy_read_timeout 是否足够大(建议 86400 秒)
  3. 网络防火墙是否允许 WebSocket 流量

健康检查

curl https://rcs.example.com/health
# 预期: {"status":"ok","version":"0.1.0"}

限制与注意事项

项目 说明
存储 纯内存存储Map服务器重启后所有会话和环境数据丢失
扩展 不支持水平扩展(无共享状态),单实例部署
并发 适合中小规模使用,大量并发会话可能需要性能调优
数据持久化 /app/data 卷已预留但当前未使用,未来可能用于持久化
Web UI 认证 基于 UUID无用户账户系统适合受信任网络环境

与云端模式对比

特性 云端 (Anthropic CCR) 自托管 (RCS)
认证方式 claude.ai OAuth 订阅 API Key
GrowthBook 门控 需要 tengu_ccr_bridge 通过 自动跳过
功能标志 需要 BRIDGE_MODE=1 同样需要
部署位置 Anthropic 云端 用户自有服务器
数据流经 Anthropic 基础设施 用户私有网络
依赖 claude.ai 订阅 + OAuth 仅需 API Key

自托管模式的核心优势是:设置 CLAUDE_BRIDGE_BASE_URL 后,代码自动调用 isSelfHostedBridge() 返回 true,跳过所有 GrowthBook 和订阅检查,无需 claude.ai 账户即可使用。