Skip to content

Commit d407d39

Browse files
build: 调整构建过程
1 parent b1aaefa commit d407d39

7 files changed

Lines changed: 188 additions & 22 deletions

File tree

.github/workflows/release-rcs.yml

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ jobs:
5454
push: false
5555
load: true
5656
tags: ${{ steps.tags.outputs.tags }}
57+
build-args: VERSION=${{ steps.version.outputs.VERSION }}
5758
cache-from: type=gha
5859
cache-to: type=gha,mode=max
5960

@@ -67,11 +68,8 @@ jobs:
6768
docker rm rcs-test
6869
6970
- name: Push Docker image
70-
uses: docker/build-push-action@v5
71-
with:
72-
context: .
73-
file: packages/remote-control-server/Dockerfile
74-
push: true
75-
tags: ${{ steps.tags.outputs.tags }}
76-
cache-from: type=gha
77-
cache-to: type=gha,mode=max
71+
run: |
72+
IFS=',' read -ra TAGS <<< "${{ steps.tags.outputs.tags }}"
73+
for TAG in "${TAGS[@]}"; do
74+
docker push "$TAG"
75+
done
Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,28 @@
1-
# ---- Stage 1: 安装依赖 + 构建 ----
1+
# ---- Stage 1: Install deps + build ----
22
FROM oven/bun:1 AS builder
33
WORKDIR /app
44

5+
ARG VERSION=0.1.0
6+
57
COPY packages/remote-control-server/package.json ./package.json
6-
RUN bun install
8+
COPY bun.lock ./bun.lock
9+
RUN bun install --frozen-lockfile
710

811
COPY packages/remote-control-server/src ./src
9-
RUN bun build src/index.ts --outfile=dist/server.js --target=bun
12+
RUN bun build src/index.ts --outfile=dist/server.js --target=bun \
13+
--define "process.env.RCS_VERSION=\"${VERSION}\""
1014

11-
# ---- Stage 2: 运行时 ----
15+
# ---- Stage 2: Runtime ----
1216
FROM oven/bun:1-slim AS runtime
1317

18+
ARG VERSION=0.1.0
19+
ENV RCS_VERSION=${VERSION}
20+
1421
RUN addgroup --system app && adduser --system --ingroup app app
1522

1623
WORKDIR /app
1724

18-
COPY --from=builder /app/dist/server.js ./server.js
25+
COPY --from=builder /app/dist/server.js ./dist/server.js
1926
COPY packages/remote-control-server/web ./web
2027

2128
VOLUME /app/data
@@ -27,4 +34,4 @@ HEALTHCHECK --interval=30s --timeout=5s --start-period=10s --retries=3 \
2734

2835
USER app
2936

30-
CMD ["bun", "run", "server.js"]
37+
CMD ["bun", "run", "dist/server.js"]
Lines changed: 167 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,167 @@
1+
# Remote Control Server (RCS)
2+
3+
Remote Control Server 是 Claude Code 的远程控制后端,允许你通过浏览器 Web UI 远程监控和操作 Claude Code 会话。
4+
5+
## 功能
6+
7+
- **会话管理** — 创建、监控、归档 Claude Code 会话
8+
- **实时消息流** — WebSocket / SSE 双向传输,实时查看对话和工具调用
9+
- **权限审批** — 在 Web UI 中审批 Claude Code 的工具权限请求
10+
- **多环境管理** — 注册多个运行环境,支持心跳和断线重连
11+
- **认证安全** — API Key + JWT 双层认证
12+
13+
## 快速开始
14+
15+
### Docker 部署(推荐)
16+
17+
```bash
18+
docker run -d \
19+
--name rcs \
20+
-p 3000:3000 \
21+
-e RCS_API_KEYS=your-api-key-here \
22+
-v rcs-data:/app/data \
23+
ghcr.io/claude-code-best/remote-control-server:latest
24+
```
25+
26+
## 环境变量
27+
28+
### 服务器配置
29+
30+
| 变量 | 默认值 | 说明 |
31+
|------|--------|------|
32+
| `RCS_PORT` | `3000` | 监听端口 |
33+
| `RCS_HOST` | `0.0.0.0` | 监听地址 |
34+
| `RCS_API_KEYS` | _(空)_ | API 密钥列表,逗号分隔。客户端和 Worker 连接时需要提供 |
35+
| `RCS_BASE_URL` | _(自动)_ | 外部访问地址,例如 `https://rcs.example.com`。用于生成 WebSocket 连接 URL |
36+
| `RCS_VERSION` | `0.1.0` | 服务版本号,显示在 `/health` 响应中 |
37+
38+
### 超时与心跳
39+
40+
| 变量 | 默认值 | 说明 |
41+
|------|--------|------|
42+
| `RCS_POLL_TIMEOUT` | `8` | V1 轮询超时(秒) |
43+
| `RCS_HEARTBEAT_INTERVAL` | `20` | 心跳间隔(秒) |
44+
| `RCS_JWT_EXPIRES_IN` | `3600` | JWT 令牌有效期(秒) |
45+
| `RCS_DISCONNECT_TIMEOUT` | `300` | 断线判定超时(秒) |
46+
47+
## Claude Code 客户端配置
48+
49+
### 连接到自托管服务器
50+
51+
在 Claude Code 所在环境设置以下变量:
52+
53+
```bash
54+
# 指向你的 RCS 服务器地址
55+
export CLAUDE_BRIDGE_BASE_URL="https://rcs.example.com"
56+
57+
# 认证令牌(与 RCS_API_KEYS 中的值对应)
58+
export CLAUDE_BRIDGE_OAUTH_TOKEN="your-api-key-here"
59+
```
60+
61+
然后启动远程控制模式:
62+
63+
```bash
64+
ccb --remote-control
65+
```
66+
67+
> **注意**:远程控制功能需要启用 `BRIDGE_MODE` feature flag。开发模式下默认启用。
68+
69+
### 环境变量参考
70+
71+
| 变量 | 说明 |
72+
|------|------|
73+
| `CLAUDE_BRIDGE_BASE_URL` | RCS 服务器地址,覆盖默认的 Anthropic 云端地址 |
74+
| `CLAUDE_BRIDGE_OAUTH_TOKEN` | 认证令牌,用于连接 RCS 服务器 |
75+
| `CLAUDE_BRIDGE_SESSION_INGRESS_URL` | WebSocket 入口地址(默认与 BASE_URL 相同) |
76+
| `CLAUDE_CODE_REMOTE` | 设为 `1` 时标记为远程执行模式 |
77+
78+
## Docker Compose 示例
79+
80+
```yaml
81+
version: "3.8"
82+
services:
83+
rcs:
84+
build:
85+
context: .
86+
dockerfile: packages/remote-control-server/Dockerfile
87+
args:
88+
VERSION: "0.1.0"
89+
ports:
90+
- "3000:3000"
91+
environment:
92+
- RCS_API_KEYS=sk-rcs-change-me
93+
- RCS_BASE_URL=https://rcs.example.com
94+
volumes:
95+
- rcs-data:/app/data
96+
restart: unless-stopped
97+
98+
volumes:
99+
rcs-data:
100+
```
101+
102+
## 反向代理配置
103+
104+
使用 Nginx 或 Caddy 反向代理时,需要支持 WebSocket 升级:
105+
106+
```nginx
107+
server {
108+
listen 443 ssl;
109+
server_name rcs.example.com;
110+
111+
location / {
112+
proxy_pass http://127.0.0.1:3000;
113+
proxy_http_version 1.1;
114+
proxy_set_header Upgrade $http_upgrade;
115+
proxy_set_header Connection "upgrade";
116+
proxy_set_header Host $host;
117+
proxy_set_header X-Real-IP $remote_addr;
118+
proxy_read_timeout 86400s;
119+
}
120+
}
121+
```
122+
123+
Caddy 配置更简单,自动处理 WebSocket:
124+
125+
```
126+
rcs.example.com {
127+
reverse_proxy localhost:3000
128+
}
129+
```
130+
131+
## 架构概览
132+
133+
```
134+
┌─────────────┐ WebSocket/SSE ┌──────────────────┐
135+
│ Claude Code │ ◄──────────────────► │ Remote Control │
136+
│ (Bridge CLI)│ HTTP API │ Server │
137+
└─────────────┘ │ │
138+
│ ┌────────────┐ │
139+
┌─────────────┐ HTTP/SSE │ │ Event Bus │ │
140+
│ Web UI │ ◄────────────────── │ └────────────┘ │
141+
│ (/code/*) │ │ ┌────────────┐ │
142+
└─────────────┘ │ │ In-Memory │ │
143+
│ │ Store │ │
144+
│ └────────────┘ │
145+
└──────────────────┘
146+
```
147+
148+
- **传输层**:WebSocket(V1)和 SSE + HTTP POST(V2)
149+
- **存储**:纯内存存储(Map),重启后数据清除
150+
- **认证**:API Key(客户端)+ JWT(Worker)
151+
- **前端**:原生 JS SPA,通过 `/code/*` 路径访问
152+
153+
## 开发
154+
155+
```bash
156+
# 安装依赖
157+
bun install
158+
159+
# 开发模式(热重载)
160+
bun run dev
161+
162+
# 类型检查
163+
bun run typecheck
164+
165+
# 运行测试
166+
bun test packages/remote-control-server/
167+
```

packages/remote-control-server/TODO.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

packages/remote-control-server/src/config.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
export const config = {
2+
version: process.env.RCS_VERSION || "0.1.0",
23
port: parseInt(process.env.RCS_PORT || "3000"),
34
host: process.env.RCS_HOST || "0.0.0.0",
45
apiKeys: (process.env.RCS_API_KEYS || "").split(",").filter(Boolean),

packages/remote-control-server/src/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ app.use("*", logger());
3131
app.use("/web/*", cors());
3232

3333
// Health check
34-
app.get("/health", (c) => c.json({ status: "ok", version: "0.1.0" }));
34+
app.get("/health", (c) => c.json({ status: "ok", version: config.version }));
3535

3636
// Static files — serve web/ directory under /code path
3737
const __dirname = dirname(fileURLToPath(import.meta.url));

packages/remote-control-server/test-write.txt

Lines changed: 0 additions & 2 deletions
This file was deleted.

0 commit comments

Comments
 (0)