diff --git a/README.md b/README.md index 0542c9ed..82625103 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ [![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) [![Docker Pulls](https://img.shields.io/docker/pulls/weishaw/claude-relay-service)](https://hub.docker.com/r/weishaw/claude-relay-service) -**🔐 自行搭建Claude API中转服务，支持多账户管理** +**🔐 自行搭建Claude API中转服务，支持多账户管理** [English](#english) • [中文文档](#中文文档) • [📸 界面预览](docs/preview.md) • [📢 公告频道](https://t.me/claude_relay_service) @@ -35,11 +35,11 @@ --- > 💡 **感谢 [@vista8](https://x.com/vista8) 的推荐！** -> +> > 如果你对Vibe coding感兴趣，推荐关注： -> +> > - 🐦 **X**: [@vista8](https://x.com/vista8) - 分享前沿技术动态 -> - 📱 **公众号**: 向阳乔木推荐看 +> - 📱 **公众号**: 向阳乔木推荐看 --- @@ -62,14 +62,14 @@ ✅ **隐私敏感**: 不想让第三方镜像看到你的对话内容 ✅ **技术折腾**: 有基本的技术基础，愿意自己搭建和维护 ✅ **稳定需求**: 需要长期稳定的Claude访问，不想受制于镜像站 -✅ **地区受限**: 无法直接访问Claude官方服务 +✅ **地区受限**: 无法直接访问Claude官方服务 ### 不适合的场景 ❌ **纯小白**: 完全不懂技术，连服务器都不会买 ❌ **偶尔使用**: 一个月用不了几次，没必要折腾 ❌ **注册问题**: 无法自行注册Claude账号 -❌ **支付问题**: 没有支付渠道订阅Claude Code +❌ **支付问题**: 没有支付渠道订阅Claude Code **如果你只是普通用户，对隐私要求不高，随便玩玩、想快速体验 Claude，那选个你熟知的镜像站会更合适。** @@ -77,7 +77,6 @@ ## 💭 为什么要自己搭？ - ### 现有镜像站可能的问题 - 🕵️ **隐私风险**: 你的对话内容都被人家看得一清二楚，商业机密什么的就别想了 @@ -98,11 +97,13 @@ > 📸 **[点击查看界面预览](docs/preview.md)** - 查看Web管理界面的详细截图 ### 基础功能 + - ✅ **多账户管理**: 可以添加多个Claude账户自动轮换 - ✅ **自定义API Key**: 给每个人分配独立的Key - ✅ **使用统计**: 详细记录每个人用了多少token ### 高级功能 + - 🔄 **智能切换**: 账户出问题自动换下一个 - 🚀 **性能优化**: 连接池、缓存，减少延迟 - 📊 **监控面板**: Web界面查看所有数据 @@ -114,6 +115,7 @@ ## 📋 部署要求 ### 硬件要求（最低配置） + - **CPU**: 1核心就够了 - **内存**: 512MB（建议1GB） - **硬盘**: 30GB可用空间 @@ -122,11 +124,13 @@ - **经验**: 阿里云、腾讯云的海外主机经测试会被Cloudflare拦截，无法直接访问claude api ### 软件要求 + - **Node.js** 18或更高版本 - **Redis** 6或更高版本 - **操作系统**: 建议Linux ### 费用估算 + - **服务器**: 轻量云服务器，一个月30-60块 - **Claude订阅**: 看你怎么分摊了 - **其他**: 域名（可选） @@ -174,11 +178,11 @@ crs uninstall # 卸载服务 $ crs install # 会依次询问： -安装目录 (默认: ~/claude-relay-service): +安装目录 (默认: ~/claude-relay-service): 服务端口 (默认: 3000): 8080 -Redis 地址 (默认: localhost): -Redis 端口 (默认: 6379): -Redis 密码 (默认: 无密码): +Redis 地址 (默认: localhost): +Redis 端口 (默认: 6379): +Redis 密码 (默认: 无密码): # 安装完成后自动启动并显示： 服务已成功安装并启动！ @@ -203,6 +207,7 @@ Redis 密码 (默认: 无密码): ### 第一步：环境准备 **Ubuntu/Debian用户：** + ```bash # 安装Node.js curl -fsSL https://deb.nodesource.com/setup_18.x | sudo -E bash - @@ -215,6 +220,7 @@ sudo systemctl start redis-server ``` **CentOS/RHEL用户：** + ```bash # 安装Node.js curl -fsSL https://rpm.nodesource.com/setup_18.x | sudo bash - @@ -243,6 +249,7 @@ cp .env.example .env ### 第三步：配置文件设置 **编辑 `.env` 文件：** + ```bash # 这两个密钥随便生成，但要记住 JWT_SECRET=你的超级秘密密钥 @@ -252,19 +259,26 @@ ENCRYPTION_KEY=32位的加密密钥随便写 REDIS_HOST=localhost REDIS_PORT=6379 REDIS_PASSWORD= + +# Webhook通知配置（可选） +WEBHOOK_ENABLED=true +WEBHOOK_URLS=https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=your-key +WEBHOOK_TIMEOUT=10000 +WEBHOOK_RETRIES=3 ``` **编辑 `config/config.js` 文件：** + ```javascript module.exports = { server: { - port: 3000, // 服务端口，可以改 - host: '0.0.0.0' // 不用改 + port: 3000, // 服务端口，可以改 + host: '0.0.0.0' // 不用改 }, redis: { - host: '127.0.0.1', // Redis地址 - port: 6379 // Redis端口 - }, + host: '127.0.0.1', // Redis地址 + port: 6379 // Redis端口 + } // 其他配置保持默认就行 } ``` @@ -372,6 +386,7 @@ docker-compose up -d ### Docker Compose 配置 docker-compose.yml 已包含： + - ✅ 自动初始化管理员账号 - ✅ 数据持久化（logs和data目录自动挂载） - ✅ Redis数据库 @@ -382,10 +397,12 @@ docker-compose.yml 已包含： ### 环境变量说明 #### 必填项 + - `JWT_SECRET`: JWT密钥，至少32个字符 - `ENCRYPTION_KEY`: 加密密钥，必须是32个字符 #### 可选项 + - `ADMIN_USERNAME`: 管理员用户名（不设置则自动生成） - `ADMIN_PASSWORD`: 管理员密码（不设置则自动生成） - `LOG_LEVEL`: 日志级别（默认：info） @@ -394,11 +411,13 @@ docker-compose.yml 已包含： ### 管理员凭据获取方式 1. **查看容器日志** + ```bash docker logs claude-relay-service ``` 2. **查看挂载的文件** + ```bash cat ./data/init.json ``` @@ -419,6 +438,7 @@ docker-compose.yml 已包含： 浏览器访问：`http://你的服务器IP:3000/web` 管理员账号： + - 自动生成：查看 data/init.json - 环境变量预设：通过 ADMIN_USERNAME 和 ADMIN_PASSWORD 设置 - Docker 部署：查看容器日志 `docker logs claude-relay-service` @@ -456,12 +476,14 @@ docker-compose.yml 已包含： 现在你可以用自己的服务替换官方API了： **Claude Code 设置环境变量：** + ```bash export ANTHROPIC_BASE_URL="http://127.0.0.1:3000/api/" # 根据实际填写你服务器的ip地址或者域名 export ANTHROPIC_AUTH_TOKEN="后台创建的API密钥" ``` **Gemini CLI 设置环境变量：** + ```bash export CODE_ASSIST_ENDPOINT="http://127.0.0.1:3000/gemini" # 根据实际填写你服务器的ip地址或者域名 export GOOGLE_CLOUD_ACCESS_TOKEN="后台创建的API密钥" # 使用相同的API密钥即可 @@ -469,43 +491,49 @@ export GOOGLE_GENAI_USE_GCA="true" ``` **使用 Claude Code：** + ```bash claude ``` **使用 Gemini CLI：** + ```bash gemini # 或其他 Gemini CLI 命令 ``` **Codex 设置环境变量：** + ```bash export OPENAI_BASE_URL="http://127.0.0.1:3000/openai" # 根据实际填写你服务器的ip地址或者域名 export OPENAI_API_KEY="后台创建的API密钥" # 使用后台创建的API密钥 ``` - ### 5. 第三方工具API接入 本服务支持多种API端点格式，方便接入不同的第三方工具（如Cherry Studio等）： **Claude标准格式：** + ``` # 如果工具支持Claude标准格式，请使用该接口 -http://你的服务器:3000/claude/ +http://你的服务器:3000/claude/ ``` **OpenAI兼容格式：** + ``` # 适用于需要OpenAI格式的第三方工具 http://你的服务器:3000/openai/claude/v1/ ``` **接入示例：** + - **Cherry Studio**: 使用OpenAI格式 `http://你的服务器:3000/openai/claude/v1/` 使用Codex cli API `http://你的服务器:3000/openai/responses` - **其他支持自定义API的工具**: 根据工具要求选择合适的格式 **重要说明：** + - 所有格式都支持相同的功能，仅是路径不同 - `/api/v1/messages` = `/claude/v1/messages` = `/openai/claude/v1/messages` - 选择适合你使用工具的格式即可 @@ -513,6 +541,67 @@ http://你的服务器:3000/openai/claude/v1/ --- +## 📢 Webhook 通知功能 + +### 功能说明 + +当系统检测到账号异常时，会自动发送 webhook 通知，支持企业微信、钉钉、Slack 等平台。 + +### 通知触发场景 + +- **Claude OAuth 账户**: token 过期或未授权时 +- **Claude Console 账户**: 系统检测到账户被封锁时 +- **Gemini 账户**: token 刷新失败时 +- **手动禁用账户**: 管理员手动禁用账户时 + +### 配置方法 + +**1. 环境变量配置** + +```bash +# 启用 webhook 通知 +WEBHOOK_ENABLED=true + +# 企业微信 webhook 地址（替换为你的实际地址） +WEBHOOK_URLS=https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=your-key + +# 多个地址用逗号分隔 +WEBHOOK_URLS=https://webhook1.com,https://webhook2.com + +# 请求超时时间（毫秒，默认10秒） +WEBHOOK_TIMEOUT=10000 + +# 重试次数（默认3次） +WEBHOOK_RETRIES=3 +``` + +**2. 企业微信设置** + +1. 在企业微信群中添加「群机器人」 +2. 获取 webhook 地址：`https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=xxx` +3. 将地址配置到 `WEBHOOK_URLS` 环境变量 + +### 通知内容格式 + +系统会发送结构化的通知消息： + +``` +账户名称 账号异常，异常代码 ERROR_CODE +平台：claude-oauth +时间：2025-08-14 17:30:00 +原因：Token expired +``` + +### 测试 Webhook + +可以通过管理后台测试 webhook 连通性： + +1. 登录管理后台：`http://你的服务器:3000/web` +2. 访问：`/admin/webhook/test` +3. 发送测试通知确认配置正确 + +--- + ## 🔧 日常维护 ### 服务管理 @@ -567,6 +656,7 @@ npm run service:status ``` **注意事项：** + - 升级前建议备份重要配置文件（.env, config/config.js） - 查看更新日志了解是否有破坏性变更 - 如果有数据库结构变更，会自动迁移 @@ -615,12 +705,14 @@ clientRestrictions: { ### 日志示例 认证成功时的日志： + ``` 🔓 Authenticated request from key: 测试Key (key-id) in 5ms User-Agent: "claude-cli/1.0.58 (external, cli)" ``` 客户端限制检查日志： + ``` 🔍 Checking client restriction for key: key-id (测试Key) User-Agent: "Mozilla/5.0 (Windows NT 10.0; Win64; x64)" @@ -631,6 +723,7 @@ clientRestrictions: { ### 常见问题处理 **Redis连不上？** + ```bash # 检查Redis是否启动 redis-cli ping @@ -639,11 +732,13 @@ redis-cli ping ``` **OAuth授权失败？** + - 检查代理设置是否正确 - 确保能正常访问 claude.ai - 清除浏览器缓存重试 **API请求失败？** + - 检查API Key是否正确 - 查看日志文件找错误信息 - 确认Claude账户状态正常 @@ -652,7 +747,6 @@ redis-cli ping ## 🛠️ 进阶 - ### 生产环境部署建议（重要！） **强烈建议使用Caddy反向代理（自动HTTPS）** @@ -660,6 +754,7 @@ redis-cli ping 建议使用Caddy作为反向代理，它会自动申请和更新SSL证书，配置更简单： **1. 安装Caddy** + ```bash # Ubuntu/Debian sudo apt install -y debian-keyring debian-archive-keyring apt-transport-https @@ -677,18 +772,19 @@ sudo yum install caddy **2. Caddy配置（超简单！）** 编辑 `/etc/caddy/Caddyfile`： + ``` 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 @@ -696,7 +792,7 @@ your-domain.com { dial_timeout 30s } } - + # 安全头部 header { Strict-Transport-Security "max-age=31536000; includeSubDomains" @@ -708,6 +804,7 @@ your-domain.com { ``` **3. 启动Caddy** + ```bash # 测试配置 sudo caddy validate --config /etc/caddy/Caddyfile @@ -723,34 +820,37 @@ sudo systemctl status caddy **4. 更新服务配置** 修改你的服务配置，让它只监听本地： + ```javascript // config/config.js module.exports = { server: { port: 3000, - host: '127.0.0.1' // 只监听本地，通过nginx代理 + host: '127.0.0.1' // 只监听本地，通过nginx代理 } // ... 其他配置 } ``` **Caddy优势：** + - 🔒 **自动HTTPS**: 自动申请和续期Let's Encrypt证书，零配置 - 🛡️ **安全默认**: 默认启用现代安全协议和加密套件 - 🚀 **流式支持**: 原生支持SSE/WebSocket等流式传输 - 📊 **简单配置**: 配置文件极其简洁，易于维护 - ⚡ **HTTP/2**: 默认启用HTTP/2，提升传输性能 - --- ## 💡 使用建议 ### 账户管理 + - **定期检查**: 每周看看账户状态，及时处理异常 - **合理分配**: 可以给不同的人分配不同的apikey，可以根据不同的apikey来分析用量 ### 安全建议 + - **使用HTTPS**: 强烈建议使用Caddy反向代理（自动HTTPS），确保数据传输安全 - **定期备份**: 重要配置和数据要备份 - **监控日志**: 定期查看异常日志 @@ -762,12 +862,14 @@ module.exports = { ## 🆘 遇到问题怎么办？ ### 自助排查 + 1. **查看日志**: `logs/` 目录下的日志文件 2. **检查配置**: 确认配置文件设置正确 3. **测试连通性**: 用 curl 测试API是否正常 4. **重启服务**: 有时候重启一下就好了 ### 寻求帮助 + - **GitHub Issues**: 提交详细的错误信息 - **查看文档**: 仔细阅读错误信息和文档 - **社区讨论**: 看看其他人是否遇到类似问题 @@ -775,6 +877,7 @@ module.exports = { --- ## 📄 许可证 + 本项目采用 [MIT许可证](LICENSE)。 --- @@ -785,4 +888,4 @@ module.exports = { **🤝 有问题欢迎提Issue，有改进建议欢迎PR** - \ No newline at end of file + diff --git a/src/services/claudeAccountService.js b/src/services/claudeAccountService.js index da512f97..6560cabe 100644 --- a/src/services/claudeAccountService.js +++ b/src/services/claudeAccountService.js @@ -468,6 +468,26 @@ class ClaudeAccountService { updatedData.updatedAt = new Date().toISOString() + // 检查是否手动禁用了账号，如果是则发送webhook通知 + if (updates.isActive === 'false' && accountData.isActive === 'true') { + try { + const webhookNotifier = require('../utils/webhookNotifier') + await webhookNotifier.sendAccountAnomalyNotification({ + accountId, + accountName: updatedData.name || 'Unknown Account', + platform: 'claude-oauth', + status: 'disabled', + errorCode: 'CLAUDE_OAUTH_MANUALLY_DISABLED', + reason: 'Account manually disabled by administrator' + }) + } catch (webhookError) { + logger.error( + 'Failed to send webhook notification for manual account disable:', + webhookError + ) + } + } + await redis.setClaudeAccount(accountId, updatedData) logger.success(`📝 Updated Claude account: ${accountId}`) diff --git a/src/services/claudeConsoleAccountService.js b/src/services/claudeConsoleAccountService.js index 6cc5d092..3963c10b 100644 --- a/src/services/claudeConsoleAccountService.js +++ b/src/services/claudeConsoleAccountService.js @@ -261,6 +261,26 @@ class ClaudeConsoleAccountService { updatedData.updatedAt = new Date().toISOString() + // 检查是否手动禁用了账号，如果是则发送webhook通知 + if (updates.isActive === false && existingAccount.isActive === true) { + try { + const webhookNotifier = require('../utils/webhookNotifier') + await webhookNotifier.sendAccountAnomalyNotification({ + accountId, + accountName: updatedData.name || existingAccount.name || 'Unknown Account', + platform: 'claude-console', + status: 'disabled', + errorCode: 'CLAUDE_CONSOLE_MANUALLY_DISABLED', + reason: 'Account manually disabled by administrator' + }) + } catch (webhookError) { + logger.error( + 'Failed to send webhook notification for manual account disable:', + webhookError + ) + } + } + logger.debug(`[DEBUG] Final updatedData to save: ${JSON.stringify(updatedData, null, 2)}`) logger.debug(`[DEBUG] Updating Redis key: ${this.ACCOUNT_KEY_PREFIX}${accountId}`) diff --git a/src/services/geminiAccountService.js b/src/services/geminiAccountService.js index 179116b3..ee8d2b60 100644 --- a/src/services/geminiAccountService.js +++ b/src/services/geminiAccountService.js @@ -455,6 +455,23 @@ async function updateAccount(accountId, updates) { } } + // 检查是否手动禁用了账号，如果是则发送webhook通知 + if (updates.isActive === 'false' && existingAccount.isActive !== 'false') { + try { + const webhookNotifier = require('../utils/webhookNotifier') + await webhookNotifier.sendAccountAnomalyNotification({ + accountId, + accountName: updates.name || existingAccount.name || 'Unknown Account', + platform: 'gemini', + status: 'disabled', + errorCode: 'GEMINI_MANUALLY_DISABLED', + reason: 'Account manually disabled by administrator' + }) + } catch (webhookError) { + logger.error('Failed to send webhook notification for manual account disable:', webhookError) + } + } + await client.hset(`${GEMINI_ACCOUNT_KEY_PREFIX}${accountId}`, updates) logger.info(`Updated Gemini account: ${accountId}`) diff --git a/src/utils/webhookNotifier.js b/src/utils/webhookNotifier.js index 1015f581..c95f3156 100644 --- a/src/utils/webhookNotifier.js +++ b/src/utils/webhookNotifier.js @@ -125,15 +125,18 @@ class WebhookNotifier { const errorCodes = { 'claude-oauth': { unauthorized: 'CLAUDE_OAUTH_UNAUTHORIZED', - error: 'CLAUDE_OAUTH_ERROR' + error: 'CLAUDE_OAUTH_ERROR', + disabled: 'CLAUDE_OAUTH_MANUALLY_DISABLED' }, 'claude-console': { blocked: 'CLAUDE_CONSOLE_BLOCKED', - error: 'CLAUDE_CONSOLE_ERROR' + error: 'CLAUDE_CONSOLE_ERROR', + disabled: 'CLAUDE_CONSOLE_MANUALLY_DISABLED' }, gemini: { error: 'GEMINI_ERROR', - unauthorized: 'GEMINI_UNAUTHORIZED' + unauthorized: 'GEMINI_UNAUTHORIZED', + disabled: 'GEMINI_MANUALLY_DISABLED' } }