Technical Documentation: Wei-Shaw/claude-relay-service
ℹ️ Provenance: Multi-Tier Ingestion · CodeWiki Reference
Overview (`README.md`)
Claude Relay Service
[!CAUTION]
安全更新通知：v1.1.248 及以下版本存在严重的管理员认证绕过漏洞，攻击者可未授权访问管理面板。请立即更新到 v1.1.249+ 版本，或迁移到新一代项目 CRS 2.0 (sub2api)
⚠️ 重要提醒
使用本项目前请仔细阅读：
🚨 服务条款风险: 使用本项目可能违反Anthropic的服务条款。请在使用前仔细阅读Anthropic的用户协议，使用本项目的一切风险由用户自行承担。
📖 免责声明: 本项目仅供技术学习和研究使用，作者不对因使用本项目导致的账户封禁、服务中断或其他损失承担任何责任。
🤔 这个项目适合你吗？
- 🌍 地区限制: 所在地区无法直接访问Claude Code服务？
- 🔒 隐私担忧: 担心第三方镜像服务会记录或泄露你的对话内容？
- 👥 成本分摊: 想和朋友一起分摊Claude Code Max订阅费用？
- ⚡ 稳定性: 第三方镜像站经常故障不稳定，影响效率 ？
如果有以上困惑，那这个项目可能适合你。
适合的场景
✅ 找朋友拼车: 三五好友一起分摊Claude Code Max订阅
✅ 隐私敏感: 不想让第三方镜像看到你的对话内容
✅ 技术折腾: 有基本的技术基础，愿意自己搭建和维护
✅ 稳定需求: 需要长期稳定的Claude访问，不想受制于镜像站
✅ 地区受限: 无法直接访问Claude官方服务
💭 为什么要自己搭？
现有镜像站可能的问题
- 🕵️ 隐私风险: 你的对话内容都被人家看得一清二楚，商业机密什么的就别想了
- 🐌 性能不稳: 用的人多了就慢，高峰期经常卡死
- 💰 价格不透明: 不知道实际成本
自建的好处
- 🔐 数据安全: 所有接口请求都只经过你自己的服务器，直连Anthropic API
- ⚡ 性能可控: 就你们几个人用，Max 200刀套餐基本上可以爽用Opus
- 💰 成本透明: 用了多少token一目了然，按官方价格换算了具体费用
- 📊 监控完整: 使用情况、成本分析、性能监控全都有
🚀 核心功能
基础功能
- ✅ 多账户管理: 可以添加多个Claude账户自动轮换
- ✅ 自定义API Key: 给每个人分配独立的Key
- ✅ 使用统计: 详细记录每个人用了多少token
高级功能
- 🔄 智能切换: 账户出问题自动换下一个
- 🚀 性能优化: 连接池、缓存，减少延迟
- 📊 监控面板: Web界面查看所有数据
- 🛡️ 安全控制: 访问限制、速率控制、客户端限制
- 🌐 代理支持: 支持HTTP/SOCKS5代理
📋 部署要求
硬件要求（最低配置）
- CPU: 1核心就够了
- 内存: 512MB（建议1GB）
- 硬盘: 30GB可用空间
- 网络: 能访问到Anthropic API（建议使用US地区的机器）
- 建议: 2核4G的基本够了，网络尽量选回国线路快一点的（为了提高速度，建议不要开代理或者设置服务器的IP直连）
- 经验: 阿里云、腾讯云的海外主机经测试会被Cloudflare拦截，无法直接访问claude api
软件要求
- Node.js 18或更高版本
- Redis 6或更高版本
- 操作系统: 建议Linux
费用估算
- 服务器: 轻量云服务器，一个月30-60块
- Claude订阅: 看你怎么分摊了
- 其他: 域名（可选）
🚀 脚本部署（推荐）
推荐使用管理脚本进行一键部署，简单快捷，自动处理所有依赖和配置。
快速安装
bash
curl -fsSL https://pincc.ai/manage.sh -o manage.sh && chmod +x manage.sh && ./manage.sh install脚本功能
- ✅ 一键安装: 自动检测系统环境，安装 Node.js 18+、Redis 等依赖
- ✅ 交互式配置: 友好的配置向导，设置端口、Redis 连接等
- ✅ 自动启动: 安装完成后自动启动服务并显示访问地址
- ✅ 便捷管理: 通过
crs命令随时管理服务状态
管理命令
bash
crs install # 安装服务
crs start # 启动服务
crs stop # 停止服务
crs restart # 重启服务
crs status # 查看状态
crs update # 更新服务
crs uninstall # 卸载服务安装示例
bash
$ crs install
# 会依次询问：
安装目录 (默认: ~/claude-relay-service):
服务端口 (默认: 3000): 8080
Redis 地址 (默认: localhost):
Redis 端口 (默认: 6379):
Redis 密码 (默认: 无密码):
# 安装完成后自动启动并显示：
服务已成功安装并启动！
访问地址：
本地 Web: http://localhost:8080/web
公网 Web: http://YOUR_IP:8080/web
管理员账号信息已保存到: data/init.json系统要求
- 支持系统: Ubuntu/Debian、CentOS/RedHat、Arch Linux、macOS
- 自动安装 Node.js 18+ 和 Redis
- Redis 使用系统默认位置，数据独立于应用
📦 手动部署
第一步：环境准备
Ubuntu/Debian用户：
bash
# 安装Node.js
curl -fsSL https://deb.nodesource.com/setup_18.x | sudo -E bash -
sudo apt-get install -y nodejs
# 安装Redis
sudo apt update
sudo apt install redis-server
sudo systemctl start redis-serverCentOS/RHEL用户：
bash
# 安装Node.js
curl -fsSL https://rpm.nodesource.com/setup_18.x | sudo bash -
sudo yum install -y nodejs
# 安装Redis
sudo yum install redis
sudo systemctl start redis第二步：下载和配置
bash
# 下载项目
git clone https://github.com/Wei-Shaw//claude-relay-service.git
cd claude-relay-service
# 安装依赖
npm install
# 复制配置文件（重要！）
cp config/config.example.js config/config.js
cp .env.example .env第三步：配置文件设置
编辑 .env 文件：
bash
# 这两个密钥随便生成，但要记住
JWT_SECRET=你的超级秘密密钥
ENCRYPTION_KEY=32位的加密密钥随便写
# Redis配置
REDIS_HOST=localhost
REDIS_PORT=6379
REDIS_PASSWORD=编辑 config/config.js 文件：
javascript
module.exports = {
server: {
port: 3000, // 服务端口，可以改
host: '0.0.0.0' // 不用改
},
redis: {
host: '127.0.0.1', // Redis地址
port: 6379 // Redis端口
}
// 其他配置保持默认就行
}第四步：安装前端依赖并构建
bash
# 安装前端依赖
npm run install:web
# 构建前端（生成 dist 目录）
npm run build:web第五步：启动服务
bash
# 初始化
npm run setup # 会随机生成后台账号密码信息，存储在 data/init.json
# 或者通过环境变量预设管理员凭据：
# export ADMIN_USERNAME=cr_admin_custom
# export ADMIN_PASSWORD=your-secure-password
# 启动服务
npm run service:start:daemon # 后台运行
# 查看状态
npm run service:status🐳 Docker 部署
Docker compose
第一步：下载构建docker-compose.yml文件的脚本并执行
bash
curl -fsSL https://pincc.ai/crs-compose.sh -o crs-compose.sh && chmod +x crs-compose.sh && ./crs-compose.sh第二步：启动
bash
docker-compose up -dDocker Compose 配置
docker-compose.yml 已包含：
- ✅ 自动初始化管理员账号
- ✅ 数据持久化（logs和data目录自动挂载）
- ✅ Redis数据库
- ✅ 健康检查
- ✅ 自动重启
环境变量说明
必填项
JWT_SECRET: JWT密钥，至少32个字符ENCRYPTION_KEY: 加密密钥，必须是32个字符
可选项
ADMIN_USERNAME: 管理员用户名（不设置则自动生成）ADMIN_PASSWORD: 管理员密码（不设置则自动生成）LOG_LEVEL: 日志级别（默认：info）- 更多配置项请参考
.env.example文件
管理员凭据获取方式
查看容器日志
bashdocker logs claude-relay-service查看挂载的文件
bashcat ./data/init.json使用环境变量预设
bash# 在 .env 文件中设置 ADMIN_USERNAME=cr_admin_custom ADMIN_PASSWORD=your-secure-password
🎮 开始使用
1. 打开管理界面
浏览器访问：http://你的服务器IP:3000/web
管理员账号：
- 自动生成：查看 data/init.json
- 环境变量预设：通过 ADMIN_USERNAME 和 ADMIN_PASSWORD 设置
- Docker 部署：查看容器日志
docker logs claude-relay-service
2. 添加Claude账户
这一步比较关键，需要OAuth授权：
- 点击「Claude账户」标签
- 如果你担心多个账号共用1个IP怕被封禁，可以选择设置静态代理IP（可选）
- 点击「添加账户」
- 点击「生成授权链接」，会打开一个新页面
- 在新页面完成Claude登录和授权
- 复制返回的Authorization Code
- 粘贴到页面完成添加
注意: 如果你在国内，这一步可能需要科学上网。
2.1 临时暂停（503/5xx）与账号级 TTL 覆盖
系统会在上游异常时临时暂停账号路由，默认由全局配置控制（见 .env.example）：
UPSTREAM_ERROR_503_TTL_SECONDSUPSTREAM_ERROR_5XX_TTL_SECONDSUPSTREAM_ERROR_OVERLOAD_TTL_SECONDSUPSTREAM_ERROR_AUTH_TTL_SECONDSUPSTREAM_ERROR_TIMEOUT_TTL_SECONDS
在管理后台编辑 Claude 官方 OAuth 账号 时，可做账号级覆盖：
禁用该账号临时冷却：该账号不再因 503/5xx 进入临时暂停503 冷却秒数：留空=跟随全局，0=关闭该账号 503 冷却5xx 冷却秒数：留空=跟随全局，0=关闭该账号 5xx 冷却
优先级从高到低：
- 账号级“禁用临时冷却”
- 账号级 503/5xx 冷却秒数
- 代码调用时传入的自定义 TTL（若有）
- 全局环境变量默认值
账户列表会显示“不可路由原因”，包含错误类型、HTTP 状态码、内部冷却总时长、剩余时间和预计恢复时间；点击 重置状态 可清除异常状态并恢复参与路由。
3. 创建API Key
给每个使用者分配一个Key：
- 点击「API Keys」标签
- 点击「创建新Key」
- 给Key起个名字，比如「张三的Key」
- 设置使用限制（可选）：
- 速率限制: 限制每个时间窗口的请求次数和Token使用量
- 并发限制: 限制同时处理的请求数
- 模型限制: 限制可访问的模型列表
- 客户端限制: 限制只允许特定客户端使用（如ClaudeCode、Gemini-CLI等）
- 保存，记下生成的Key
4. 开始使用 Claude Code 和 Gemini CLI
现在你可以用自己的服务替换官方API了：
Claude Code 设置环境变量：
使用标准 Claude 账号池
默认使用标准 Claude 账号池：
bash
export ANTHROPIC_BASE_URL="http://127.0.0.1:3000/api/" # 根据实际填写你服务器的ip地址或者域名
export ANTHROPIC_AUTH_TOKEN="后台创建的API密钥"使用 Antigravity 账户池
适用于通过 Antigravity 渠道使用 Claude 模型（如 claude-opus-4-5 等）。
bash
# 1. 设置 Base URL 为 Antigravity 专用路径
export ANTHROPIC_BASE_URL="http://127.0.0.1:3000/antigravity/api/"
# 2. 设置 API Key（在后台创建，权限需包含 'all' 或 'gemini'）
export ANTHROPIC_AUTH_TOKEN="后台创建的API密钥"
# 3. 指定模型名称（直接使用短名，无需前缀！）
export ANTHROPIC_MODEL="claude-opus-4-5"
# 4. 启动
claudeVSCode Claude 插件配置：
如果使用 VSCode 的 Claude 插件，需要在 ~/.claude/config.json 文件中配置：
json
{
"primaryApiKey": "crs"
}如果该文件不存在，请手动创建。Windows 用户路径为 C:\Users\你的用户名\.claude\config.json。
💡 IntelliJ IDEA 用户推荐：Claude Code Plus - 将 Claude Code 直接集成到 IDE，支持代码理解、文件读写、命令执行。插件市场搜索
Claude Code Plus即可安装。
Gemini CLI 设置环境变量：
方式一（推荐）：通过 Gemini Assist API 方式访问
bash
CODE_ASSIST_ENDPOINT="http://127.0.0.1:3000/gemini" # 根据实际填写你服务器的ip地址或者域名
GOOGLE_CLOUD_ACCESS_TOKEN="后台创建的API密钥"
GOOGLE_GENAI_USE_GCA="true"
GEMINI_MODEL="gemini-2.5-pro" # 如果你有gemini3权限可以填： gemini-3-pro-preview认证：只能选
Login with Google进行认证，如果跳 Google请删除~/.gemini/settings.json后再尝试启动gemini。
注意：gemini-cli 控制台会提示Failed to fetch user info: 401 Unauthorized，但使用不受任何影响。
方式二：通过 Gemini API 方式访问
bash
GOOGLE_GEMINI_BASE_URL="http://127.0.0.1:3000/gemini" # 根据实际填写你服务器的ip地址或者域名
GEMINI_API_KEY="后台创建的API密钥"
GEMINI_MODEL="gemini-2.5-pro" # 如果你有gemini3权限可以填： gemini-3-pro-preview认证：只能选
Use Gemini API Key进行认证，如果提示Enter Gemini API Key请直接留空按回车。如果一打开就跳 Google请删除~/.gemini/settings.json后再尝试启动gemini。
💡 进阶用法：想在 Claude Code 中直接使用 Gemini 3 模型？请参考 Claude Code 调用 Gemini 3 模型指南
使用 Claude Code：
bash
claude使用 Gemini CLI：
bash
gemini # 或其他 Gemini CLI 命令Codex 配置：
在 ~/.codex/config.toml 文件开头添加以下配置：
toml
model_provider = "crs"
model = "gpt-5.5"
model_reasoning_effort = "high"
disable_response_storage = true
preferred_auth_method = "apikey"
[model_providers.crs]
name = "crs"
base_url = "http://127.0.0.1:3000/openai" # 根据实际填写你服务器的ip地址或者域名
wire_api = "responses"
requires_openai_auth = true在 ~/.codex/auth.json 文件中配置API密钥为 null：
json
{
"OPENAI_API_KEY": "后台创建的API密钥"
}⚠️ 在通过 Nginx 反向代理 CRS 服务并使用 Codex CLI 时，需要在 http 块中添加 underscores_in_headers on;。因为 Nginx 默认会移除带下划线的请求头（如 session_id），一旦该头被丢弃，多账号环境下的粘性会话功能将失效。
Droid CLI 配置：
Droid CLI 读取 ~/.factory/config.json。可以在该文件中添加自定义模型以指向本服务的新端点：
json
{
"custom_models": [
{
"model_display_name": "Opus 4.5 [crs]",
"model": "claude-opus-4-5-20251101",
"base_url": "http://127.0.0.1:3000/droid/claude",
"api_key": "后台创建的API密钥",
"provider": "anthropic",
"max_tokens": 64000
},
{
"model_display_name": "GPT5.5 [crs]",
"model": "gpt-5.5",
"base_url": "http://127.0.0.1:3000/droid/openai",
"api_key": "后台创建的API密钥",
"provider": "openai",
"max_tokens": 16384
},
{
"model_display_name": "Gemini-3-Pro [crs]",
"model": "gemini-3-pro-preview",
"base_url": "http://127.0.0.1:3000/droid/comm/v1/",
"api_key": "后台创建的API密钥",
"provider": "generic-chat-completion-api",
"max_tokens": 65535
},
{
"model_display_name": "GLM-4.6 [crs]",
"model": "glm-4.6",
"base_url": "http://127.0.0.1:3000/droid/comm/v1/",
"api_key": "后台创建的API密钥",
"provider": "generic-chat-completion-api",
"max_tokens": 202800
}
]
}💡 将示例中的
http://127.0.0.1:3000替换为你的服务域名或公网地址，并写入后台生成的 API 密钥（cr_ 开头）。
5. 第三方工具API接入
本服务支持多种API端点格式，方便接入不同的第三方工具（如Cherry Studio等）。
Cherry Studio 接入示例
Cherry Studio支持多种AI服务的接入，下面是不同账号类型的详细配置：
1. Claude账号接入：
text
# API地址
http://你的服务器:3000/claude
# 模型ID示例
claude-sonnet-4-5-20250929 # Claude Sonnet 4.5
claude-opus-4-20250514 # Claude Opus 4配置步骤：
- 供应商类型选择"Anthropic"
- API地址填入：
http://你的服务器:3000/claude - API Key填入：后台创建的API密钥（cr_开头）
2. Gemini账号接入：
text
# API地址
http://你的服务器:3000/gemini
# 模型ID示例
gemini-2.5-pro # Gemini 2.5 Pro配置步骤：
- 供应商类型选择"Gemini"
- API地址填入：
http://你的服务器:3000/gemini - API Key填入：后台创建的API密钥（cr_开头）
3. Codex接入：
text
# API地址
http://你的服务器:3000/openai
# 模型ID（固定）
gpt-5 # Codex使用固定模型ID配置步骤：
- 供应商类型选择"Openai-Response"
- API地址填入：
http://你的服务器:3000/openai - API Key填入：后台创建的API密钥（cr_开头）
- 重要：Codex只支持Openai-Response标准
Cherry Studio 地址格式重要说明：
- ✅ 推荐格式：
http://你的服务器:3000/claude（不加结尾/，让 Cherry Studio 自动加上 v1） - ✅ 等效格式：
http://你的服务器:3000/claude/v1/（手动指定 v1 并加结尾/） - 💡 说明：这两种格式在 Cherry Studio 中是完全等效的
- ❌ 错误格式：
http://你的服务器:3000/claude/（单独的/结尾会被 Cherry Studio 忽略 v1 版本）
其他第三方工具接入
接入要点：
- 所有账号类型都使用相同的API密钥（在后台统一创建）
- 根据不同的路由前缀自动识别账号类型
/claude/- 使用Claude账号池/antigravity/api/- 使用Antigravity账号池（推荐用于Claude Code）/droid/claude/- 使用Droid类型Claude账号池（只建议api调用或Droid Cli中使用）/gemini/- 使用Gemini账号池/openai/- 使用Codex账号（只支持Openai-Response格式）/droid/openai/- 使用Droid类型OpenAI兼容账号池（只建议api调用或Droid Cli中使用）- 支持所有标准API端点（messages、models等）
重要说明：
- 确保在后台已添加对应类型的账号（Claude/Gemini/Codex）
- API密钥可以通用，系统会根据路由自动选择账号类型
- 建议为不同用户创建不同的API密钥便于使用统计
🔧 日常维护
服务管理
bash
# 查看服务状态
npm run service:status
# 查看日志
npm run service:logs
# 重启服务
npm run service:restart:daemon
# 停止服务
npm run service:stop监控使用情况
- Web界面:
http://你的域名:3000/web- 查看使用统计 - 健康检查:
http://你的域名:3000/health- 确认服务正常 - 日志文件:
logs/目录下的各种日志文件
升级指南
当有新版本发布时，按照以下步骤升级服务：
bash
# 1. 进入项目目录
cd claude-relay-service
# 2. 拉取最新代码
git pull origin main
# 如果遇到 package-lock.json 冲突，使用远程版本
git checkout --theirs package-lock.json
git add package-lock.json
# 3. 安装新的依赖（如果有）
npm install
# 4. 安装并构建前端
npm run install:web
npm run build:web
# 5. 重启服务
npm run service:restart:daemon
# 6. 检查服务状态
npm run service:status注意事项：
- 升级前建议备份重要配置文件（.env, config/config.js）
- 查看更新日志了解是否有破坏性变更
- 如果有数据库结构变更，会自动迁移
🔒 客户端限制功能
功能说明
客户端限制功能允许你控制每个API Key可以被哪些客户端使用，通过User-Agent识别客户端，提高API的安全性。
使用方法
在创建或编辑API Key时启用客户端限制：
- 勾选"启用客户端限制"
- 选择允许的客户端（支持多选）
预定义客户端：
- ClaudeCode: 官方Claude CLI（匹配
claude-cli/x.x.x (external, cli)格式） - Gemini-CLI: Gemini命令行工具（匹配
GeminiCLI/vx.x.x (platform; arch)格式）
- ClaudeCode: 官方Claude CLI（匹配
调试和诊断：
- 系统会在日志中记录所有请求的User-Agent
- 客户端验证失败时会返回403错误并记录详细信息
- 通过日志可以查看实际的User-Agent格式，方便配置自定义客户端
日志示例
认证成功时的日志：
text
🔓 Authenticated request from key: 测试Key (key-id) in 5ms
User-Agent: "claude-cli/1.0.58 (external, cli)"客户端限制检查日志：
text
🔍 Checking client restriction for key: key-id (测试Key)
User-Agent: "Mozilla/5.0 (Windows NT 10.0; Win64; x64)"
Allowed clients: claude_code, gemini_cli
🚫 Client restriction failed for key: key-id (测试Key) from 127.0.0.1, User-Agent: Mozilla/5.0...常见问题处理
Redis连不上？
bash
# 检查Redis是否启动
redis-cli ping
# 应该返回 PONGOAuth授权失败？
- 检查代理设置是否正确
- 确保能正常访问 claude.ai
- 清除浏览器缓存重试
API请求失败？
- 检查API Key是否正确
- 查看日志文件找错误信息
- 确认Claude账户状态正常
🛠️ 进阶
反向代理部署指南
在生产环境中，建议通过反向代理进行连接，以便使用自动 HTTPS、安全头部和性能优化。下面提供两种常用方案： Caddy 和 Nginx Proxy Manager (NPM)。
Caddy 方案
Caddy 是一款自动管理 HTTPS 证书的 Web 服务器，配置简单、性能优秀，很适合不需要 Docker 环境的部署方案。
1. 安装 Caddy
bash
# Ubuntu/Debian
sudo apt install -y debian-keyring debian-archive-keyring apt-transport-https
curl -1sLf 'https://dl.cloudsmith.io/public/caddy/stable/gpg.key' | sudo gpg --dearmor -o /usr/share/keyrings/caddy-stable-archive-keyring.gpg
curl -1sLf 'https://dl.cloudsmith.io/public/caddy/stable/debian.deb.txt' | sudo tee /etc/apt/sources.list.d/caddy-stable.list
sudo apt update
sudo apt install caddy
# CentOS/RHEL/Fedora
sudo yum install yum-plugin-copr
sudo yum copr enable @caddy/caddy
sudo yum install caddy2. Caddy 配置
编辑 /etc/caddy/Caddyfile ：
caddy
your-domain.com {
# 反向代理到本地服务
reverse_proxy 127.0.0.1:3000 {
# 支持流式响应或 SSE
flush_interval -1
# 传递真实 IP
header_up X-Real-IP {remote_host}
header_up X-Forwarded-For {remote_host}
header_up X-Forwarded-Proto {scheme}
# 长读/写超时配置
transport http {
read_timeout 300s
write_timeout 300s
dial_timeout 30s
}
}
# 安全头部
header {
Strict-Transport-Security "max-age=31536000; includeSubDomains"
X-Frame-Options "DENY"
X-Content-Type-Options "nosniff"
-Server
}
}3. 启动 Caddy
bash
sudo caddy validate --config /etc/caddy/Caddyfile
sudo systemctl start caddy
sudo systemctl enable caddy
sudo systemctl status caddy4. 服务配置
Caddy 会自动管理 HTTPS，因此可以将服务限制在本地进行监听：
javascript
// config/config.js
module.exports = {
server: {
port: 3000,
host: '127.0.0.1' // 只监听本地
}
}Caddy 特点
- 🔒 自动 HTTPS，零配置证书管理
- 🛡️ 安全默认配置，启用现代 TLS 套件
- ⚡ HTTP/2 和流式传输支持
- 🔧 配置文件简洁，易于维护
Nginx Proxy Manager (NPM) 方案
Nginx Proxy Manager 通过图形化界面管理反向代理和 HTTPS 证书，並以 Docker 容器部署。
1. 在 NPM 创建新的 Proxy Host
Details 配置如下：
| 项目 | 设置 |
|---|---|
| Domain Names | relay.example.com |
| Scheme | http |
| Forward Hostname / IP | 192.168.0.1 (docker 机器 IP) |
| Forward Port | 3000 |
| Block Common Exploits | ☑️ |
| Websockets Support | ❌ 关闭 |
| Cache Assets | ❌ 关闭 |
| Access List | Publicly Accessible |
注意：
- 请确保 Claude Relay Service 监听 host 为
0.0.0.0、容器 IP 或本机 IP，以便 NPM 实现内网连接。- Websockets Support 和 Cache Assets 必须关闭，否则会导致 SSE / 流式响应失败。
2. Custom locations
無需添加任何内容，保持为空。
3. SSL 设置
- SSL Certificate: Request a new SSL Certificate (Let's Encrypt) 或已有证书
- ☑️ Force SSL
- ☑️ HTTP/2 Support
- ☑️ HSTS Enabled
- ☑️ HSTS Subdomains
4. Advanced 配置
Custom Nginx Configuration 中添加以下内容：
nginx
# 传递真实用户 IP
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;
# 支持 WebSocket / SSE 等流式通信
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";
proxy_buffering off;
# 长连接 / 超时设置（适合 AI 聊天流式传输）
proxy_read_timeout 300s;
proxy_send_timeout 300s;
proxy_connect_timeout 30s;
# ---- 安全性设置 ----
# 严格 HTTPS 策略 (HSTS)
add_header Strict-Transport-Security "max-age=31536000; includeSubDomains" always;
# 阻挡点击劫持与内容嗅探
add_header X-Frame-Options "DENY" always;
add_header X-Content-Type-Options "nosniff" always;
# Referrer / Permissions 限制策略
add_header Referrer-Policy "no-referrer-when-downgrade" always;
add_header Permissions-Policy "camera=(), microphone=(), geolocation=()" always;
# 隐藏服务器信息（等效于 Caddy 的 `-Server`）
proxy_hide_header Server;
# ---- 性能微调 ----
# 关闭代理端缓存，确保即时响应（SSE / Streaming）
proxy_cache_bypass $http_upgrade;
proxy_no_cache $http_upgrade;
proxy_request_buffering off;4. 启动和验证
- 保存后等待 NPM 自动申请 Let's Encrypt 证书（如果有）。
- Dashboard 中查看 Proxy Host 状态，确保显示为 "Online"。
- 访问
https://relay.example.com，如果显示绿色锁图标即表示 HTTPS 正常。
NPM 特点
- 🔒 自动申请和续期证书
- 🔧 图形化界面，方便管理多服务
- ⚡ 原生支持 HTTP/2 / HTTPS
- 🚀 适合 Docker 容器部署
上述两种方案均可用于生产部署。
💡 使用建议
账户管理
- 定期检查: 每周看看账户状态，及时处理异常
- 合理分配: 可以给不同的人分配不同的apikey，可以根据不同的apikey来分析用量
安全建议
- 使用HTTPS: 强烈建议使用Caddy反向代理（自动HTTPS），确保数据传输安全
- 定期备份: 重要配置和数据要备份
- 监控日志: 定期查看异常日志
- 更新密钥: 定期更换JWT和加密密钥
- 防火墙设置: 只开放必要的端口（80, 443），隐藏直接服务端口
🆘 遇到问题怎么办？
自助排查
- 查看日志:
logs/目录下的日志文件 - 检查配置: 确认配置文件设置正确
- 测试连通性: 用 curl 测试API是否正常
- 重启服务: 有时候重启一下就好了
寻求帮助
- GitHub Issues: 提交详细的错误信息
- 查看文档: 仔细阅读错误信息和文档
- 社区讨论: 看看其他人是否遇到类似问题
📄 许可证
本项目采用 MIT许可证。
Overview (`docs/claude-code-gemini3-guide/README.md`)
Claude Code 调用 Gemini 3 模型指南
本文档介绍如何通过 claude-code-router (CCR) 在 Claude Code 中调用 Gemini 3 模型，其他模型也可以参照此教程尝试。
概述
通过 CCR 转换格式，你可以让 Claude Code 客户端无缝使用 Gemini 3 模型。
工作原理
text
Claude Code → CCR (模型路由) → CRS (账户调度) → Gemini API第一步：安装 claude-code-router
安装 CCR：
安装位置建议：
- 如果只是本地使用，可以只安装到使用 Claude Code 的电脑上
- 如果需要 CRS 项目接入 CCR，建议安装在与 CRS 同一台服务器上
bash
npm install @musistudio/claude-code-router验证安装：
bash
ccr -v第二步：配置 CCR
创建或编辑 CCR 配置文件（通常位于 ~/.claude-code-router/config.json）：
json
{
"APIKEY": "sk-c0e7fed7b-这里随便你自定义",
"LOG": true,
"HOST": "127.0.0.1",
"API_TIMEOUT_MS": 600000,
"NON_INTERACTIVE_MODE": false,
"Providers": [
{
"name": "gemini",
"api_base_url": "http://127.0.0.1:3000/gemini/v1beta/models/",
"api_key": "cr_xxxxxxxxxxxxxxxxxxxxx",
"models": ["gemini-2.5-flash", "gemini-2.5-pro", "gemini-3-pro-preview"],
"transformer": {
"use": ["gemini"]
}
}
],
"Router": {
"default": "gemini",
"background": "gemini,gemini-3-pro-preview",
"think": "gemini,gemini-3-pro-preview",
"longContext": "gemini,gemini-3-pro-preview",
"longContextThreshold": 60000,
"webSearch": "gemini,gemini-2.5-flash"
}
}配置说明
| 字段 | 说明 |
|---|---|
APIKEY |
CCR 自定义的 API Key，Claude Code 将使用这个 Key 访问 CCR |
api_base_url |
CRS 服务的 Gemini API 地址 |
api_key |
CRS 后台创建的 API Key（cr_ 开头），用于调度 OAuth、Gemini-API 账号 |
第三步：在 CRS 中配置 Gemini 账号
确保你的 CRS 服务已添加 Gemini 账号：
- 登录 CRS 管理界面
- 进入「Gemini 账户」页面
- 添加 Gemini OAuth 账号或 API Key 账号
- 确保账号状态为「活跃」
第四步：启动 CCR 服务
保存配置后，启动 CCR 服务：
bash
ccr start查看服务状态：
bash
ccr status输出示例：
text
API Endpoint: http://127.0.0.1:3456重要：每次修改配置后，需要重启 CCR 服务才能生效：
bash
ccr restart第五步：配置 Claude Code
现在需要让 Claude Code 连接到 CCR 服务。有两种方式：
方式一：本地直接使用
设置环境变量让 Claude Code 直接连接 CCR：
bash
export ANTHROPIC_BASE_URL="http://127.0.0.1:3456/"
export ANTHROPIC_AUTH_TOKEN="sk-c0e7fed7b-你的自定义Key"然后启动 Claude Code：
bash
claude方式二：通过 CRS 统一管理（推荐）
如果你希望通过 CRS 统一管理所有用户的访问，可以在 CRS 中添加 Claude Console 类型账号来代理 CCR。
1. 在 CRS 添加 Claude Console 账号
登录 CRS 管理界面，添加一个 Claude Console 类型的账号：
| 字段 | 值 |
|---|---|
| 账户名称 | CCR-Gemini3（或自定义名称） |
| 账户类型 | Claude Console |
| API 地址 | http://127.0.0.1:3456（CCR 服务地址） |
| API Key | sk-c0e7fed7b-你的自定义Key（CCR 配置中的 APIKEY） |
注意：如果 CCR 运行在其他服务器上，请将
127.0.0.1替换为实际的服务器地址，配置文件中需要修改HOST参数为0.0.0.0。
2. 配置模型映射
在 CRS 中配置模型映射，将 Claude 模型名映射到 Gemini 模型：
| Claude 模型 | 映射到 Gemini 模型 |
|---|---|
claude-opus-4-1-20250805 |
gemini-3-pro-preview |
claude-sonnet-4-5-20250929 |
gemini-3-pro-preview |
claude-haiku-4-5-20251001 |
gemini-2.5-flash |
配置界面示例：
说明：
- Opus 和 Sonnet 映射到性能更强的
gemini-3-pro-preview- Haiku 映射到响应更快的
gemini-2.5-flash
3. 用户使用方式
用户现在可以通过 CRS 统一入口使用 Claude Code：
bash
export ANTHROPIC_BASE_URL="http://你的CRS服务器:3000/api/"
export ANTHROPIC_AUTH_TOKEN="cr_用户的APIKey"Claude Code 会自动将请求路由到 CCR，再由 CCR 转发到 Gemini API。
常见问题
Q: CCR 配置修改后没有生效？
A: 配置修改后必须重启 CCR 服务：
bash
ccr restartQ: 连接超时怎么办？
A: 检查以下几点：
- CRS 服务是否正常运行
- CCR 配置中的
api_base_url是否正确 - 防火墙是否允许相应端口
- 尝试增加
API_TIMEOUT_MS的值
Q: 模型映射不生效？
A: 确保：
- CRS 中已正确配置 Claude Console 账号
- 模型映射配置已保存
- 重启 CRS 服务使配置生效
Q: 如何测试连接？
A: 使用 curl 测试 CCR 服务：
bash
curl -X POST http://127.0.0.1:3456/api/v1/messages \
-H "Content-Type: application/json" \
-H "x-api-key: sk-c0e7fed7b-你的自定义Key" \
-d '{
"model": "claude-sonnet-4-5-20250929",
"max_tokens": 100,
"messages": [{"role": "user", "content": "Hello"}]
}'最佳实践
- 生产环境：将 CCR 部署在与 CRS 相同的服务器上，减少网络延迟
- API Key 管理：为每个用户创建独立的 CRS API Key，便于使用统计
- 超时配置：对于长时间运行的任务，适当增加
API_TIMEOUT_MS
相关资源
Overview (`resources/model-pricing/README.md`)
Model Pricing Data
This directory contains a local copy of the mirrored model pricing data as a fallback mechanism.
Source
The original file is maintained by the LiteLLM project and mirrored into the price-mirror branch of this repository via GitHub Actions:
- Mirror branch (configurable via
PRICE_MIRROR_REPO): https://raw.githubusercontent.com//price-mirror/model_prices_and_context_window.json - Upstream source: https://raw.githubusercontent.com/BerriAI/litellm/main/model_prices_and_context_window.json
Purpose
This local copy serves as a fallback when the remote file cannot be downloaded due to:
- Network restrictions
- Firewall rules
- DNS resolution issues
- GitHub being blocked in certain regions
- Docker container network limitations
Update Process
The pricingService will:
- First attempt to download the latest version from GitHub
- If download fails, use this local copy as fallback
- Log a warning when using the fallback file
Manual Update
To manually update this file with the latest pricing data (if automation is unavailable):
bash
curl -s https://raw.githubusercontent.com/BerriAI/litellm/main/model_prices_and_context_window.json -o model_prices_and_context_window.jsonFile Format
The file contains JSON data with model pricing information including:
- Model names and identifiers
- Input/output token costs
- Context window sizes
- Model capabilities
Last updated: 2025-08-10
Overview (`web/admin-spa/README.md`)
Claude Relay Service 管理后台 SPA
这是 Claude Relay Service 管理后台的 Vue3 SPA 重构版本。
开发环境要求
- Node.js >= 16
- npm >= 7
安装和运行
1. 安装依赖
bash
cd web/admin-spa
npm install2. 开发模式运行
bash
npm run dev重要提示：
- 开发服务器启动后，会自动在浏览器中打开
- 必须访问完整路径：http://localhost:3001/web/admin/
- 不要访问 http://localhost:3001/ （会显示404）
- 首次访问会自动跳转到登录页面
3. 生产构建
bash
npm run build构建产物将输出到 dist 目录。
4. 预览生产构建
bash
npm run preview项目结构
text
web/admin-spa/
├── public/ # 静态资源
├── src/
│ ├── api/ # API 接口封装
│ ├── assets/ # 资源文件
│ ├── components/ # 组件
│ ├── composables/ # 组合式函数
│ ├── router/ # 路由配置
│ ├── stores/ # Pinia 状态管理
│ ├── utils/ # 工具函数
│ ├── views/ # 页面视图
│ ├── App.vue # 根组件
│ └── main.js # 入口文件
├── package.json
└── vite.config.js功能模块
- ✅ 登录认证
- ✅ 仪表板（系统统计、使用趋势、模型分布）
- 🚧 API Keys 管理
- 🚧 账户管理（Claude/Gemini）
- 🚧 使用教程
- 🚧 系统设置
技术栈
- Vue 3.3.4
- Vue Router 4
- Pinia（状态管理）
- Element Plus 2.4.4
- Tailwind CSS
- Chart.js 4.4.0
- Vite 5
开发注意事项
- 所有 API 请求都通过
/api目录下的模块进行封装 - 状态管理使用 Pinia，存放在
/stores目录 - 组件按功能模块组织在
/components目录下 - 保持与原版页面的功能和样式一致性
代理配置
如果你的后端服务器需要通过代理访问（例如服务器在国外），可以配置 HTTP 代理：
方法一：使用环境变量文件（推荐）
创建 .env.development.local 文件：
bash
# 后端服务器地址
VITE_API_TARGET=http://74.48.134.98:3000
# HTTP 代理配置
VITE_HTTP_PROXY=http://127.0.0.1:7890方法二：使用系统环境变量
bash
# Linux/Mac
export VITE_HTTP_PROXY=http://127.0.0.1:7890
npm run dev
# Windows
set VITE_HTTP_PROXY=http://127.0.0.1:7890
npm run dev注意：.env.development.local 文件不会被提交到版本控制，适合存放本地特定的配置。
部署
构建后的文件需要部署到 Claude Relay Service 的 web/admin/ 路径下。
常见问题
Q: 访问 localhost:3001 显示 404？
A: 这是正常的。应用配置在 /web/admin/ 路径下，必须访问完整路径：http://localhost:3001/web/admin/
Q: 登录时 API 请求失败（500错误）？
A:
- 确保主服务运行：Claude Relay Service 必须运行在 http://localhost:3000
- 检查代理配置：Vite 会自动代理
/admin和/api请求到 3000 端口 - 重启开发服务器：如果修改了配置，需要重启
npm run dev - 测试代理：运行
node test-proxy.js检查代理是否正常工作
Q: 如何处理开发和生产环境的 API 配置？
A:
- 开发环境：使用 Vite 代理，自动转发请求到 localhost:3000
- 生产环境：直接使用相对路径
/admin，无需配置 - 两种环境都使用相同的 API 路径，通过环境变量自动切换
Q: 如何部署到生产环境？
A:
- 运行
npm run build构建项目 - 将
dist目录内容复制到服务器的/web/admin/路径 - 确保服务器配置了 SPA 路由回退规则
--- METRICS ---
- Files Extracted: 4
- Estimated Token Budget: ~6768 tokens
- Canonical Reference: https://codewiki.google/github.com/Wei-Shaw/claude-relay-service