Sub2API

Sub2API 是一个 AI API 网关平台，用于分发和管理 AI 产品订阅的额度。用户通过平台签发的 API Key 访问上游服务，网关负责认证、计费、负载均衡与请求转发。

本模板会部署完整的一套服务：

• sub2api：Go 后端 + 内置 Vue 管理后台，通过你的域名对外提供服务。
• postgresql：PostgreSQL 18，持久化存储上游账号、密钥、用量与账单数据。
• redis：Redis 8，持久化存储缓存、队列与分布式调度状态。

开始使用

1. 部署完成后访问 https://<你的域名>。
2. 使用 Sub2API 服务「操作指南」中显示的邮箱与密码登录（默认邮箱 admin@sub2api.local，密码为该服务自动生成的 ADMIN_PASSWORD，两者也可在服务的变量列表中查看）。
3. 在「账号」中添加上游账号（Claude、OpenAI、Gemini、Grok），加入分组，然后为用户创建 API Key。
4. 客户端接入地址：
   • OpenAI / Codex 兼容：https://<你的域名>/v1
   • Anthropic / Claude Code 兼容：https://<你的域名>
   • Gemini 兼容：https://<你的域名>

说明

• 数据库与缓存只能通过项目内网访问：本模板关闭了 TCP 端口转发。若需要用本地客户端连接，可在对应服务的「网络」页面开启。
• 重要信息位置：
  • PostgreSQL 与 Redis 的连接串可在各自服务的「操作指南」中查看。
  • Sub2API 服务的 /app/data 保存着 AUTO_SETUP 生成的 config.yaml 和应用日志，必须保持挂载，否则生成的 JWT_SECRET 会在重启后丢失。
  • 更新镜像（weishaw/sub2api:latest）不会丢数据：应用会检测到已有配置，不再执行一次安装流程。也可以直接在后台点击「检查更新」在线升级。
• 两步验证默认关闭。需要启用时，请在 Sub2API 服务中设置 TOTP_ENCRYPTION_KEY 为固定的 64 位 hex 字符串（openssl rand -hex 32）；写入非法值会导致服务无法启动。
• JWT_SECRET 会在首次启动时生成并保存在数据卷中。如需自行管理密钥，请显式设置 JWT_SECRET（至少 32 字节，openssl rand -hex 32）。
• 生产环境建议把 Sub2API 服务的 SECURITY_URL_ALLOWLIST_ALLOW_INSECURE_HTTP 设为 false，只允许 HTTPS 上游地址。
• RUN_MODE=simple 会隐藏 SaaS 计费相关功能，适合内部自用；在生产环境还需同时设置 SIMPLE_MODE_CONFIRM=true。

重要提醒

使用本项目可能违反 Anthropic 等上游服务商的用户协议。请遵守所在国家或地区的法律法规使用；账号封禁、服务中断、数据丢失等风险由使用者自行承担。上游项目未授权任何形式的商业运营。

上游项目：https://github.com/Wei-Shaw/sub2api