hequ commited on
Commit
1d737c4
·
verified ·
1 Parent(s): 5bdb07e

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +7 -939
README.md CHANGED
@@ -1,941 +1,9 @@
1
- # Claude Relay Service
2
-
3
- <div align="center">
4
-
5
- [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
6
- [![Node.js](https://img.shields.io/badge/Node.js-18+-green.svg)](https://nodejs.org/)
7
- [![Redis](https://img.shields.io/badge/Redis-6+-red.svg)](https://redis.io/)
8
- [![Docker](https://img.shields.io/badge/Docker-Ready-blue.svg)](https://www.docker.com/)
9
- [![Docker Build](https://github.com/Wei-Shaw/claude-relay-service/actions/workflows/auto-release-pipeline.yml/badge.svg)](https://github.com/Wei-Shaw/claude-relay-service/actions/workflows/auto-release-pipeline.yml)
10
- [![Docker Pulls](https://img.shields.io/docker/pulls/weishaw/claude-relay-service)](https://hub.docker.com/r/weishaw/claude-relay-service)
11
-
12
- **🔐 自行搭建Claude API中转服务,支持多账户管理**
13
-
14
- [English](README_EN.md) • [快速开始](https://pincc.ai/) • [演示站点](https://demo.pincc.ai/admin-next/login) • [公告频道](https://t.me/claude_relay_service)
15
-
16
- </div>
17
-
18
  ---
19
-
20
- ## 💎 Claude/Codex 拼车服务推荐
21
-
22
- <div align="center">
23
-
24
- | 平台 | 类型 | 服务 | 介绍 |
25
- |:---|:---|:---|:---|
26
- | **[pincc.ai](https://pincc.ai/)** | 🏆 **官方运营** | <small>✅ Claude Code<br>✅ Codex CLI</small> | 项目直营,提供稳定的 Claude Code / Codex CLI 拼车服务 |
27
- | **[ctok.ai](https://ctok.ai/)** | 🤝 合作伙伴 | <small>✅ Claude Code<br>✅ Codex CLI</small> | 社区认证,提供 Claude Code / Codex CLI 拼车 |
28
-
29
-
30
- </div>
31
-
32
  ---
33
-
34
- ## ⚠️ 重要提醒
35
-
36
- **使用本项目前请仔细阅读:**
37
-
38
- 🚨 **服务条款风险**: 使用本项目可能违反Anthropic的服务条款。请在使用前仔细阅读Anthropic的用户协议,使用本项目的一切风险由用户自行承担。
39
-
40
- 📖 **免责声明**: 本项目仅供技术学习和研究使用,作者不对因使用本项目导致的账户封禁、服务中断或其他损失承担任何责任。
41
-
42
-
43
- ## 🤔 这个项目适合你吗?
44
-
45
- - 🌍 **地区限制**: 所在地区无法直接访问Claude Code服务?
46
- - 🔒 **隐私担忧**: 担心第三方镜像服务会记录或泄露你的对话内容?
47
- - 👥 **成本分摊**: 想和朋友一起分摊Claude Code Max订阅费用?
48
- - ⚡ **稳定性**: 第三方镜像站经常故障不稳定,影响效率 ?
49
-
50
- 如果有以上困惑,那这个项目可能适合你。
51
-
52
- ### 适合的场景
53
-
54
- ✅ **找朋友拼车**: 三五好友一起分摊Claude Code Max订阅
55
- ✅ **隐私敏感**: 不想让第三方镜像看到你的对话内容
56
- ✅ **技术折腾**: 有基本的技术基础,愿意自己搭建和维护
57
- ✅ **稳定需求**: 需要长期稳定的Claude访问,不想受制于镜像站
58
- ✅ **地区受限**: 无法直接访问Claude官方服务
59
-
60
- ---
61
-
62
- ## 💭 为什么要自己搭?
63
-
64
- ### 现有镜像站可能的问题
65
-
66
- - 🕵️ **隐私风险**: 你的对话内容都被人家看得一清二楚,商业机密什么的就别想了
67
- - 🐌 **性能不稳**: 用的人多了就慢,高峰期经常卡死
68
- - 💰 **价格不透明**: 不知道实际成本
69
-
70
- ### 自建的好处
71
-
72
- - 🔐 **数据安全**: 所有接口请求都只经过你自己的服务器,直连Anthropic API
73
- - ⚡ **性能可控**: 就你们几个人用,Max 200刀套餐基本上可以爽用Opus
74
- - 💰 **成本透明**: 用了多少token一目了然,按官方价格换算了具体费用
75
- - 📊 **监控完整**: 使用情况、成本分析、性能监控全都有
76
-
77
- ---
78
-
79
- ## 🚀 核心功能
80
-
81
- ### 基础功能
82
-
83
- - ✅ **多账户管理**: 可以添加多个Claude账户自动轮换
84
- - ✅ **自定义API Key**: 给每个人分配独立的Key
85
- - ✅ **使用统计**: 详细记录每个人用了多少token
86
-
87
- ### 高级功能
88
-
89
- - 🔄 **智能切换**: 账户出问题自动换下一个
90
- - 🚀 **性能优化**: 连接池、缓存,减少延迟
91
- - 📊 **监控面板**: Web界面查看所有数据
92
- - 🛡️ **安全控制**: 访问限制、速率控制、客户端限制
93
- - 🌐 **代理支持**: 支持HTTP/SOCKS5代理
94
-
95
- ---
96
-
97
- ## 📋 部署要求
98
-
99
- ### 硬件要求(最低配置)
100
-
101
- - **CPU**: 1核心就够了
102
- - **内存**: 512MB(建议1GB)
103
- - **硬盘**: 30GB可用空间
104
- - **网络**: 能访问到Anthropic API(建议使用US地区的机器)
105
- - **建议**: 2核4G的基本够了,网络尽量选回国线路快一点的(为了提高速度,建议不要开代理或者设置服务器的IP直连)
106
- - **经验**: 阿里云、腾讯云的海外主机经测试会被Cloudflare拦截,无法直接访问claude api
107
-
108
- ### 软件要求
109
-
110
- - **Node.js** 18或更高版本
111
- - **Redis** 6或更高版本
112
- - **操作系统**: 建议Linux
113
-
114
- ### 费用估算
115
-
116
- - **服务器**: 轻量云服务器,一个月30-60块
117
- - **Claude订阅**: 看你怎么分摊了
118
- - **其他**: 域名(可选)
119
-
120
- ---
121
-
122
- ## 🚀 脚本部署(推荐)
123
-
124
- 推荐使用管理脚本进行一键部署,简单快捷,自动处理��有依赖和配置。
125
-
126
- ### 快速安装
127
-
128
- ```bash
129
- curl -fsSL https://pincc.ai/manage.sh -o manage.sh && chmod +x manage.sh && ./manage.sh install
130
- ```
131
-
132
- ### 脚本功能
133
-
134
- - ✅ **一键安装**: 自动检测系统环境,安装 Node.js 18+、Redis 等依赖
135
- - ✅ **交互式配置**: 友好的配置向导,设置端口、Redis 连接等
136
- - ✅ **自动启动**: 安装完成后自动启动服务并显示访问地址
137
- - ✅ **便捷管理**: 通过 `crs` 命令随时管理服务状态
138
-
139
- ### 管理命令
140
-
141
- ```bash
142
- crs install # 安装服务
143
- crs start # 启动服务
144
- crs stop # 停止服务
145
- crs restart # 重启服务
146
- crs status # 查看状态
147
- crs update # 更新服务
148
- crs uninstall # 卸载服务
149
- ```
150
-
151
- ### 安装示例
152
-
153
- ```bash
154
- $ crs install
155
-
156
- # 会依次询问:
157
- 安装目录 (默认: ~/claude-relay-service):
158
- 服务端口 (默认: 3000): 8080
159
- Redis 地址 (默认: localhost):
160
- Redis 端口 (默认: 6379):
161
- Redis 密码 (默认: 无密码):
162
-
163
- # 安装完成后自动启动并显示:
164
- 服务已成功安装并启动!
165
-
166
- 访问地址:
167
- 本地 Web: http://localhost:8080/web
168
- 公网 Web: http://YOUR_IP:8080/web
169
-
170
- 管理员账号信息已保存到: data/init.json
171
- ```
172
-
173
- ### 系统要求
174
-
175
- - 支持系统: Ubuntu/Debian、CentOS/RedHat、Arch Linux、macOS
176
- - 自动安装 Node.js 18+ 和 Redis
177
- - Redis 使用系统默认位置,数据独立于应用
178
-
179
- ---
180
-
181
- ## 📦 手动部署
182
-
183
- ### 第一步:环境准备
184
-
185
- **Ubuntu/Debian用户:**
186
-
187
- ```bash
188
- # 安装Node.js
189
- curl -fsSL https://deb.nodesource.com/setup_18.x | sudo -E bash -
190
- sudo apt-get install -y nodejs
191
-
192
- # 安装Redis
193
- sudo apt update
194
- sudo apt install redis-server
195
- sudo systemctl start redis-server
196
- ```
197
-
198
- **CentOS/RHEL用户:**
199
-
200
- ```bash
201
- # 安装Node.js
202
- curl -fsSL https://rpm.nodesource.com/setup_18.x | sudo bash -
203
- sudo yum install -y nodejs
204
-
205
- # 安装Redis
206
- sudo yum install redis
207
- sudo systemctl start redis
208
- ```
209
-
210
- ### 第二步:下载和配置
211
-
212
- ```bash
213
- # 下载项目
214
- git clone https://github.com/Wei-Shaw//claude-relay-service.git
215
- cd claude-relay-service
216
-
217
- # 安装依赖
218
- npm install
219
-
220
- # 复制配置文件(重要!)
221
- cp config/config.example.js config/config.js
222
- cp .env.example .env
223
- ```
224
-
225
- ### 第三步:配置文件设置
226
-
227
- **编辑 `.env` 文件:**
228
-
229
- ```bash
230
- # 这两个密钥随便生成,但要记住
231
- JWT_SECRET=你的超级秘密密钥
232
- ENCRYPTION_KEY=32位的加密密钥随便写
233
-
234
- # Redis配置
235
- REDIS_HOST=localhost
236
- REDIS_PORT=6379
237
- REDIS_PASSWORD=
238
-
239
- ```
240
-
241
- **编辑 `config/config.js` 文件:**
242
-
243
- ```javascript
244
- module.exports = {
245
- server: {
246
- port: 3000, // 服务端口,可以改
247
- host: '0.0.0.0' // 不用改
248
- },
249
- redis: {
250
- host: '127.0.0.1', // Redis地址
251
- port: 6379 // Redis端口
252
- }
253
- // 其他配置保持默认就行
254
- }
255
- ```
256
-
257
- ### 第四步:安装前端依赖并构建
258
-
259
- ```bash
260
- # 安装前端依赖
261
- npm run install:web
262
-
263
- # 构建前端(生成 dist 目录)
264
- npm run build:web
265
- ```
266
-
267
- ### 第五步:启动服务
268
-
269
- ```bash
270
- # 初始化
271
- npm run setup # 会随机生成后台账号密码信息,存储在 data/init.json
272
- # 或者通过环境变量预设管理员凭据:
273
- # export ADMIN_USERNAME=cr_admin_custom
274
- # export ADMIN_PASSWORD=your-secure-password
275
-
276
- # 启动服务
277
- npm run service:start:daemon # 后台运行
278
-
279
- # 查看状态
280
- npm run service:status
281
- ```
282
-
283
- ---
284
-
285
- ## 🐳 Docker 部署
286
-
287
- ### Docker compose
288
-
289
- #### 第一步:下载构建docker-compose.yml文件的脚本并执行
290
- ```bash
291
- curl -fsSL https://pincc.ai/crs-compose.sh -o crs-compose.sh && chmod +x crs-compose.sh && ./crs-compose.sh
292
- ```
293
-
294
- #### 第二步:启动
295
- ```bash
296
- docker-compose up -d
297
- ```
298
-
299
- ### Docker Compose 配置
300
-
301
- docker-compose.yml 已包含:
302
-
303
- - ✅ 自动初始化管理员账号
304
- - ✅ 数据持久化(logs和data目录自动挂载)
305
- - ✅ Redis数据库
306
- - ✅ 健康检查
307
- - ✅ 自动重启
308
-
309
- ### 环境变量说明
310
-
311
- #### 必填项
312
-
313
- - `JWT_SECRET`: JWT密钥,至少32个字符
314
- - `ENCRYPTION_KEY`: 加密密钥,必须是32个字符
315
-
316
- #### 可选项
317
-
318
- - `ADMIN_USERNAME`: 管理员用户名(不设置则自动生成)
319
- - `ADMIN_PASSWORD`: 管理员密码(不设置则自动生成)
320
- - `LOG_LEVEL`: 日志级别(默认:info)
321
- - 更多配置项请参考 `.env.example` 文件
322
-
323
- ### 管理员凭据获取方式
324
-
325
- 1. **查看容器日志**
326
-
327
- ```bash
328
- docker logs claude-relay-service
329
- ```
330
-
331
- 2. **查看挂载的文件**
332
-
333
- ```bash
334
- cat ./data/init.json
335
- ```
336
-
337
- 3. **使用环境变量预设**
338
- ```bash
339
- # 在 .env 文件中设置
340
- ADMIN_USERNAME=cr_admin_custom
341
- ADMIN_PASSWORD=your-secure-password
342
- ```
343
-
344
- ---
345
-
346
- ## 🎮 开始使用
347
-
348
- ### 1. 打开管理界面
349
-
350
- 浏览器访问:`http://你的服务器IP:3000/web`
351
-
352
- 管理员账号:
353
-
354
- - 自动生成:查看 data/init.json
355
- - 环境变量预设:通过 ADMIN_USERNAME 和 ADMIN_PASSWORD 设置
356
- - Docker 部署:查看容器日志 `docker logs claude-relay-service`
357
-
358
- ### 2. 添加Claude账户
359
-
360
- 这一步比较关键,需要OAuth授权:
361
-
362
- 1. 点击「Claude账户」标签
363
- 2. 如果你担心多个账号共用1个IP怕被封禁,可以选择设置静态代理IP(可选)
364
- 3. 点击「添加账户」
365
- 4. 点击「生成授权链接」,会打开一个新页面
366
- 5. 在新页面完成Claude登录和授权
367
- 6. 复制返回的Authorization Code
368
- 7. 粘贴到页面完成添加
369
-
370
- **注意**: 如果你在国内,这一步可能需要科学上网。
371
-
372
- ### 3. 创建API Key
373
-
374
- 给每个使用者分配一个Key:
375
-
376
- 1. 点击「API Keys」标签
377
- 2. 点击「创建新Key」
378
- 3. 给Key起个名字,比如「张三的Key」
379
- 4. 设置使用限制(可选):
380
- - **速率限制**: 限制每个时间窗口的请求次数和Token使用量
381
- - **并发限制**: 限制同时处理的请求数
382
- - **模型限制**: 限制可访问的模型列表
383
- - **客户端限制**: 限制只允许特定客户端使用(如ClaudeCode、Gemini-CLI等)
384
- 5. 保存,记下生成的Key
385
-
386
- ### 4. 开始使用 Claude Code 和 Gemini CLI
387
-
388
- 现在你可以用自己的服务替换官方API了:
389
-
390
- **Claude Code 设置环境变量:**
391
-
392
- 默认使用标准 Claude 账号池:
393
-
394
- ```bash
395
- export ANTHROPIC_BASE_URL="http://127.0.0.1:3000/api/" # 根据实际填写你服务器的ip地址或者域名
396
- export ANTHROPIC_AUTH_TOKEN="后台创建的API密钥"
397
- ```
398
-
399
- **VSCode Claude 插件配置:**
400
-
401
- 如果使用 VSCode 的 Claude 插件,需要在 `~/.claude/config.json` 文件中配置:
402
-
403
- ```json
404
- {
405
- "primaryApiKey": "crs"
406
- }
407
- ```
408
-
409
- 如果该文件不存在,请手动创建。Windows 用户路径为 `C:\Users\你的用户名\.claude\config.json`。
410
-
411
- **Gemini CLI 设置环境变量:**
412
-
413
- ```bash
414
- GEMINI_MODEL="gemini-2.5-pro"
415
- GOOGLE_GEMINI_BASE_URL="http://127.0.0.1:3000/gemini" # 根据实际填写你服务器的ip地址或者域名
416
- GEMINI_API_KEY="后台创建的API密钥" # 使用相同的API密钥即可
417
- ```
418
- **使用 Claude Code:**
419
-
420
- ```bash
421
- claude
422
- ```
423
-
424
- **使用 Gemini CLI:**
425
-
426
- ```bash
427
- gemini # 或其他 Gemini CLI 命令
428
- ```
429
-
430
- **Codex 配置:**
431
-
432
- 在 `~/.codex/config.toml` 文件**开头**添加以下配置:
433
-
434
- ```toml
435
- model_provider = "crs"
436
- model = "gpt-5-codex"
437
- model_reasoning_effort = "high"
438
- disable_response_storage = true
439
- preferred_auth_method = "apikey"
440
-
441
- [model_providers.crs]
442
- name = "crs"
443
- base_url = "http://127.0.0.1:3000/openai" # 根据实际填写你服务器的ip地址或者域名
444
- wire_api = "responses"
445
- requires_openai_auth = true
446
- env_key = "CRS_OAI_KEY"
447
- ```
448
-
449
- 在 `~/.codex/auth.json` 文件中配置API密钥为 null:
450
-
451
- ```json
452
- {
453
- "OPENAI_API_KEY": null
454
- }
455
- ```
456
-
457
- 环境变量设置:
458
-
459
- ```bash
460
- export CRS_OAI_KEY="后台创建的API密钥"
461
- ```
462
-
463
- > ⚠️ 在通过 Nginx 反向代理 CRS 服务并使用 Codex CLI 时,需要在 http 块中添加 underscores_in_headers on;。因为 Nginx 默认会移除带下划线的请求头(如 session_id),一旦该头被丢弃,多账号环境下的粘性会话功能将失效。
464
-
465
- **Droid CLI 配置:**
466
-
467
- Droid CLI 读取 `~/.factory/config.json`。可以在该文件中添加自定义模型以指向本服务的新端点:
468
-
469
- ```json
470
- {
471
- "custom_models": [
472
- {
473
- "model_display_name": "Sonnet 4.5 [crs]",
474
- "model": "claude-sonnet-4-5-20250929",
475
- "base_url": "http://127.0.0.1:3000/droid/claude",
476
- "api_key": "后台创建的API密钥",
477
- "provider": "anthropic",
478
- "max_tokens": 8192
479
- },
480
- {
481
- "model_display_name": "GPT5-Codex [crs]",
482
- "model": "gpt-5-codex",
483
- "base_url": "http://127.0.0.1:3000/droid/openai",
484
- "api_key": "后台创建的API密钥",
485
- "provider": "openai",
486
- "max_tokens": 16384
487
- }
488
- ]
489
- }
490
- ```
491
-
492
- > 💡 将示例中的 `http://127.0.0.1:3000` 替换为你的服务域名或公网地址,并写入后台生成的 API 密钥(cr_ 开头)。
493
-
494
- ### 5. 第三方工具API接入
495
-
496
- 本服务支持多种API端点格式,方便接入不同的第三方工具(如Cherry Studio等)。
497
-
498
- #### Cherry Studio 接入示例
499
-
500
- Cherry Studio支持多种AI服务的接入,下面是不同账号类型的详细配置:
501
-
502
- **1. Claude账号接入:**
503
-
504
- ```
505
- # API地址
506
- http://你的服务器:3000/claude
507
-
508
- # 模型ID示例
509
- claude-sonnet-4-5-20250929 # Claude Sonnet 4.5
510
- claude-opus-4-20250514 # Claude Opus 4
511
- ```
512
-
513
- 配置步骤:
514
- - 供应商类型选择"Anthropic"
515
- - API地址填入:`http://你的服务器:3000/claude`
516
- - API Key填入:后台创建的API密钥(cr_开头)
517
-
518
- **2. Gemini账号接入:**
519
-
520
- ```
521
- # API地址
522
- http://你的服务器:3000/gemini
523
-
524
- # 模型ID示例
525
- gemini-2.5-pro # Gemini 2.5 Pro
526
- ```
527
-
528
- 配置步骤:
529
- - 供应商类型选择"Gemini"
530
- - API地址填入:`http://你的服务器:3000/gemini`
531
- - API Key填入:后台创建的API密钥(cr_开头)
532
-
533
- **3. Codex接入:**
534
-
535
- ```
536
- # API地址
537
- http://你的服务器:3000/openai
538
-
539
- # 模型ID(固定)
540
- gpt-5 # Codex使用固定模型ID
541
- ```
542
-
543
- 配置步骤:
544
- - 供应商类型选择"Openai-Response"
545
- - API地址填入:`http://���的服务器:3000/openai`
546
- - API Key填入:后台创建的API密钥(cr_开头)
547
- - **重要**:Codex只支持Openai-Response标准
548
-
549
-
550
- **Cherry Studio 地址格式重要说明:**
551
-
552
- - ✅ **推荐格式**:`http://你的服务器:3000/claude`(不加结尾 `/`,让 Cherry Studio 自动加上 v1)
553
- - ✅ **等效格式**:`http://你的服务器:3000/claude/v1/`(手动指定 v1 并加结尾 `/`)
554
- - 💡 **说明**:这两种格式在 Cherry Studio 中是完全等效的
555
- - ❌ **错误格式**:`http://你的服务器:3000/claude/`(单独的 `/` 结尾会被 Cherry Studio 忽略 v1 版本)
556
-
557
- #### 其他第三方工具接入
558
-
559
- **接入要点:**
560
-
561
- - 所有账号类型都使用相同的API密钥(在后台统一创建)
562
- - 根据不同的路由前缀自动识别账号类型
563
- - `/claude/` - 使用Claude账号池
564
- - `/droid/claude/` - 使用Droid类型Claude账号池(只建议api调用或Droid Cli中使用)
565
- - `/gemini/` - 使用Gemini账号池
566
- - `/openai/` - 使用Codex账号(只支持Openai-Response格式)
567
- - `/droid/openai/` - 使用Droid类型OpenAI兼容账号池(只建议api调用或Droid Cli中使用)
568
- - 支持所有标准API端点(messages、models等)
569
-
570
- **重要说明:**
571
-
572
- - 确保在后台已添加对应类型的账号(Claude/Gemini/Codex)
573
- - API密钥可以通用,系统会根据路由自动选择账号类型
574
- - 建议为不同用户创建不同的API密钥便于使用统计
575
-
576
- ---
577
-
578
- ## 🔧 日常维护
579
-
580
- ### 服务管理
581
-
582
- ```bash
583
- # 查看服务状态
584
- npm run service:status
585
-
586
- # 查看日志
587
- npm run service:logs
588
-
589
- # 重启服务
590
- npm run service:restart:daemon
591
-
592
- # 停止服务
593
- npm run service:stop
594
- ```
595
-
596
- ### 监控使用情况
597
-
598
- - **Web界面**: `http://你的域名:3000/web` - 查看使用统计
599
- - **健康检查**: `http://你的域名:3000/health` - 确认服务正常
600
- - **日志文件**: `logs/` 目录下的各种日志文件
601
-
602
- ### 升级指南
603
-
604
- 当有新版本发布时,按照以下步骤升级服务:
605
-
606
- ```bash
607
- # 1. 进入项目目录
608
- cd claude-relay-service
609
-
610
- # 2. 拉取最新代码
611
- git pull origin main
612
-
613
- # 如果遇到 package-lock.json 冲突,使用远程版本
614
- git checkout --theirs package-lock.json
615
- git add package-lock.json
616
-
617
- # 3. 安装新的依赖(如果有)
618
- npm install
619
-
620
- # 4. 安装并构建前端
621
- npm run install:web
622
- npm run build:web
623
-
624
- # 5. 重启服务
625
- npm run service:restart:daemon
626
-
627
- # 6. 检查服务状态
628
- npm run service:status
629
- ```
630
-
631
- **注意事项:**
632
-
633
- - 升级前建议备份重要配置文件(.env, config/config.js)
634
- - 查看更新日志了解是否有破坏性变更
635
- - 如果有数据库结构变更,会自动迁移
636
-
637
- ---
638
-
639
- ## 🔒 客户端限制功能
640
-
641
- ### 功能说明
642
-
643
- 客户端限制功能允许你控制每个API Key可以被哪些客户端使用,通过User-Agent识别客户端,提高API的安全性。
644
-
645
- ### 使用方法
646
-
647
- 1. **在创建或编辑API Key时启用客户端限制**:
648
- - 勾选"启用客户端限制"
649
- - 选择允许的客户端(支持多选)
650
-
651
- 2. **预定义客户端**:
652
- - **ClaudeCode**: 官方Claude CLI(匹配 `claude-cli/x.x.x (external, cli)` 格式)
653
- - **Gemini-CLI**: Gemini命令行工具(匹配 `GeminiCLI/vx.x.x (platform; arch)` 格式)
654
-
655
- 3. **调试和诊断**:
656
- - 系统会在日志中记录所有请求的User-Agent
657
- - 客户端验证失败时会返回403错误并记录详细信息
658
- - 通过日志可以查看实际的User-Agent格式,方便配置自定义客户端
659
-
660
-
661
- ### 日志示例
662
-
663
- 认证成功时的日志:
664
-
665
- ```
666
- 🔓 Authenticated request from key: 测试Key (key-id) in 5ms
667
- User-Agent: "claude-cli/1.0.58 (external, cli)"
668
- ```
669
-
670
- 客户端限制检查日志:
671
-
672
- ```
673
- 🔍 Checking client restriction for key: key-id (测试Key)
674
- User-Agent: "Mozilla/5.0 (Windows NT 10.0; Win64; x64)"
675
- Allowed clients: claude_code, gemini_cli
676
- 🚫 Client restriction failed for key: key-id (测试Key) from 127.0.0.1, User-Agent: Mozilla/5.0...
677
- ```
678
-
679
- ### 常见问题处理
680
-
681
- **Redis连不上?**
682
-
683
- ```bash
684
- # 检查Redis是否启动
685
- redis-cli ping
686
-
687
- # 应该返回 PONG
688
- ```
689
-
690
- **OAuth授权失败?**
691
-
692
- - 检查代理设置是否正确
693
- - 确保能正常访问 claude.ai
694
- - 清除浏览器缓存重试
695
-
696
- **API请求失败?**
697
-
698
- - 检查API Key是否正确
699
- - 查看日志文件找错误信息
700
- - 确认Claude账户状态正常
701
-
702
- ---
703
-
704
- ## 🛠️ 进阶
705
-
706
- ### 反向代理部署指南
707
-
708
- 在生产环境中,建议通过反向代理进行连接,以便使用自动 HTTPS、安全头部和性能优化。下面提供两种常用方案: **Caddy** 和 **Nginx Proxy Manager (NPM)**。
709
-
710
- ---
711
-
712
- ## Caddy 方案
713
-
714
- Caddy 是一款自动管理 HTTPS 证书的 Web 服务器,配置简单、性能优秀,很适合不需要 Docker 环境的部署方案。
715
-
716
- **1. 安装 Caddy**
717
-
718
- ```bash
719
- # Ubuntu/Debian
720
- sudo apt install -y debian-keyring debian-archive-keyring apt-transport-https
721
- curl -1sLf 'https://dl.cloudsmith.io/public/caddy/stable/gpg.key' | sudo gpg --dearmor -o /usr/share/keyrings/caddy-stable-archive-keyring.gpg
722
- curl -1sLf 'https://dl.cloudsmith.io/public/caddy/stable/debian.deb.txt' | sudo tee /etc/apt/sources.list.d/caddy-stable.list
723
- sudo apt update
724
- sudo apt install caddy
725
-
726
- # CentOS/RHEL/Fedora
727
- sudo yum install yum-plugin-copr
728
- sudo yum copr enable @caddy/caddy
729
- sudo yum install caddy
730
- ```
731
-
732
- **2. Caddy 配置**
733
-
734
- 编辑 `/etc/caddy/Caddyfile` :
735
-
736
- ```caddy
737
- your-domain.com {
738
- # 反向代理到本地服务
739
- reverse_proxy 127.0.0.1:3000 {
740
- # 支持流式响应或 SSE
741
- flush_interval -1
742
-
743
- # 传递真实 IP
744
- header_up X-Real-IP {remote_host}
745
- header_up X-Forwarded-For {remote_host}
746
- header_up X-Forwarded-Proto {scheme}
747
-
748
- # 长读/写超时配置
749
- transport http {
750
- read_timeout 300s
751
- write_timeout 300s
752
- dial_timeout 30s
753
- }
754
- }
755
-
756
- # 安全头部
757
- header {
758
- Strict-Transport-Security "max-age=31536000; includeSubDomains"
759
- X-Frame-Options "DENY"
760
- X-Content-Type-Options "nosniff"
761
- -Server
762
- }
763
- }
764
- ```
765
-
766
- **3. 启动 Caddy**
767
-
768
- ```bash
769
- sudo caddy validate --config /etc/caddy/Caddyfile
770
- sudo systemctl start caddy
771
- sudo systemctl enable caddy
772
- sudo systemctl status caddy
773
- ```
774
-
775
- **4. 服务配置**
776
-
777
- Caddy 会自动管理 HTTPS,因此可以将服务限制在本地进行监听:
778
-
779
- ```javascript
780
- // config/config.js
781
- module.exports = {
782
- server: {
783
- port: 3000,
784
- host: '127.0.0.1' // 只监听本地
785
- }
786
- }
787
- ```
788
-
789
- **Caddy 特点**
790
-
791
- * 🔒 自动 HTTPS,零配置证书管理
792
- * 🛡️ 安全默认配置,启用现代 TLS 套件
793
- * ⚡ HTTP/2 和流式传输支持
794
- * 🔧 配置文件简洁,易于维护
795
-
796
- ---
797
-
798
- ## Nginx Proxy Manager (NPM) 方案
799
-
800
- Nginx Proxy Manager 通过图形化界面管理反向代理和 HTTPS 证书,並以 Docker 容器部署。
801
-
802
- **1. 在 NPM 创建新的 Proxy Host**
803
-
804
- Details 配置如下:
805
-
806
- | 项目 | 设置 |
807
- | --------------------- | ----------------------- |
808
- | Domain Names | relay.example.com |
809
- | Scheme | http |
810
- | Forward Hostname / IP | 192.168.0.1 (docker 机器 IP) |
811
- | Forward Port | 3000 |
812
- | Block Common Exploits | ☑️ |
813
- | Websockets Support | ❌ **关闭** |
814
- | Cache Assets | ❌ **关闭** |
815
- | Access List | Publicly Accessible |
816
-
817
- > 注意:
818
- > - 请确保 Claude Relay Service **监听 host 为 `0.0.0.0` 、容器 IP 或本机 IP**,以便 NPM 实现内网连接。
819
- > - **Websockets Support 和 Cache Assets 必须关闭**,否则会导致 SSE / 流式响应失败。
820
-
821
- **2. Custom locations**
822
-
823
- 無需添加任何内容,保持为空。
824
-
825
- **3. SSL 设置**
826
-
827
- * **SSL Certificate**: Request a new SSL Certificate (Let's Encrypt) 或已有证书
828
- * ☑️ **Force SSL**
829
- * ☑️ **HTTP/2 Support**
830
- * ☑️ **HSTS Enabled**
831
- * ☑️ **HSTS Subdomains**
832
-
833
- **4. Advanced 配置**
834
-
835
- Custom Nginx Configuration 中添加以下内容:
836
-
837
- ```nginx
838
- # 传递真实用户 IP
839
- proxy_set_header X-Real-IP $remote_addr;
840
- proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
841
- proxy_set_header X-Forwarded-Proto $scheme;
842
-
843
- # 支持 WebSocket / SSE 等流式通信
844
- proxy_http_version 1.1;
845
- proxy_set_header Upgrade $http_upgrade;
846
- proxy_set_header Connection "upgrade";
847
- proxy_buffering off;
848
-
849
- # 长连接 / 超时设置(适合 AI 聊天流式传输)
850
- proxy_read_timeout 300s;
851
- proxy_send_timeout 300s;
852
- proxy_connect_timeout 30s;
853
-
854
- # ---- 安全性设置 ----
855
- # 严格 HTTPS 策略 (HSTS)
856
- add_header Strict-Transport-Security "max-age=31536000; includeSubDomains" always;
857
-
858
- # 阻挡点击劫持与内容嗅探
859
- add_header X-Frame-Options "DENY" always;
860
- add_header X-Content-Type-Options "nosniff" always;
861
-
862
- # Referrer / Permissions 限制策略
863
- add_header Referrer-Policy "no-referrer-when-downgrade" always;
864
- add_header Permissions-Policy "camera=(), microphone=(), geolocation=()" always;
865
-
866
- # 隐藏服务器信息(等效于 Caddy 的 `-Server`)
867
- proxy_hide_header Server;
868
-
869
- # ---- 性能微调 ----
870
- # 关闭代理端缓存,确保即时响应(SSE / Streaming)
871
- proxy_cache_bypass $http_upgrade;
872
- proxy_no_cache $http_upgrade;
873
- proxy_request_buffering off;
874
- ```
875
-
876
- **4. 启动和验证**
877
-
878
- * 保存后等待 NPM 自动申请 Let's Encrypt 证书(如果有)。
879
- * Dashboard 中查看 Proxy Host 状态,确保显示为 "Online"。
880
- * 访问 `https://relay.example.com`,如果显示绿色锁图标即表示 HTTPS 正常。
881
-
882
- **NPM 特点**
883
-
884
- * 🔒 自动申请和续期证书
885
- * 🔧 图形化界面,方便管理多服务
886
- * ⚡ 原生支持 HTTP/2 / HTTPS
887
- * 🚀 适合 Docker 容器部署
888
-
889
- ---
890
-
891
- 上述两种方案均可用于生产部署。
892
-
893
- ---
894
-
895
- ## 💡 使用建议
896
-
897
- ### 账户管理
898
-
899
- - **定期检查**: 每周看看账户状态,及时处理异常
900
- - **合理分配**: 可以给不同的人分配不同的apikey,可以根据不同的apikey来分析用量
901
-
902
- ### 安全建议
903
-
904
- - **使用HTTPS**: 强烈建议使用Caddy反向代理(自动HTTPS),确保数据传输安全
905
- - **定期备份**: 重要配置和数据要备份
906
- - **监控日志**: 定期查看异常日志
907
- - **更新密钥**: 定期更换JWT和加密密钥
908
- - **防火墙设置**: 只开放必要的端口(80, 443),隐藏直接服务端口
909
-
910
- ---
911
-
912
- ## 🆘 遇到问题怎么办?
913
-
914
- ### 自助排查
915
-
916
- 1. **查看日志**: `logs/` 目录下的日志文件
917
- 2. **检查配置**: 确认配置文件设置正确
918
- 3. **测试连通性**: 用 curl 测试API是否正常
919
- 4. **重启服务**: 有时候重启一下就好了
920
-
921
- ### 寻求帮助
922
-
923
- - **GitHub Issues**: 提交详细的错误信息
924
- - **查看文档**: 仔细阅读错误信息和文档
925
- - **社区讨论**: 看看其他人是否遇到类似问题
926
-
927
- ---
928
-
929
- ## 📄 许可证
930
-
931
- 本项目采用 [MIT许可证](LICENSE)。
932
-
933
- ---
934
-
935
- <div align="center">
936
-
937
- **⭐ 觉得有用的话给个Star呗,这是对作者最大的鼓励!**
938
-
939
- **🤝 有问题欢迎提Issue,有改进建议欢迎PR**
940
-
941
- </div>
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
+ title: cc
3
+ emoji: 🛰️
4
+ colorFrom: indigo
5
+ colorTo: purple
6
+ sdk: docker
7
+ app_port: 7860
8
+ pinned: false
 
 
 
 
 
 
9
  ---