xue-y-su/clove-api-1.0.6

选用指南

AI 根据 README 整理 · 2026/10/22 02:11:21

适用场景

适用于需要私有化部署多模型 API 网关、统一管理上游渠道、API Key、用户额度和日志的组织。

查看 README 依据

# Clove API Clove API 是基于 New API `v1.0.0-rc.21` 集成的增强版 AI 网关，当前版本为 `v1.0.6`。这份源码已经把上游 RC21 合入，并保留 Clove 侧新增的合规、来源归属、余额查询、注册邀请控制、操练场附件、生产部署和安全加固能力。 仓库定位很直接：作为可私有化部署的多模型 API 网关，统一管理上游模型渠道、API Key、用户、额度、订阅、日志、合规确认和前端控制台。 ## 当前主线 - 版本：`v1.0.6` - 上游基线：New API `v1.0.0-rc.21` - 主分支：`main` - 默认服务端口：`3000` - 许可证：AGPL-3.0，详见 `LICENSE` ## 主要能力 ### 多模型网关 - OpenAI 兼容 Chat Completions、Responses、Realtime、图片和多模态请求。 - Claude Messages、Google Gemini、Rerank、AWS、Azure、DeepSeek、Qwen 等上游渠道适配。 - 支持渠道分组、模型映射、倍率、价格、上游同步、渠道健康检查和请求日志。 - 支持按用户、分组、模型、Token、订阅和钱包余额进行额度控制与计费。 ### Clove 增强功能

使用方式

通过 Docker Compose 进行生产部署，也可本地开发运行后端和前端。

查看 README 依据

- 默认使用 PostgreSQL、Redis、只读容器文件系统、非特权运行、`no-new-privileges`、最小 Linux capabilities、健康检查和日志滚动。 - 生产环境要求显式配置 `SESSION_SECRET`、`FRONTEND_BASE_URL`、`SESSION_COOKIE_TRUSTED_URL`、`CORS_ALLOW_ORIGINS` 和 `TRUSTED_PROXIES`。 - 会话 Cookie、CORS、请求体大小、关键接口限流、响应缓存、TLS/SMTP 不安全跳过开关均有明确生产默认值。 - 日志侧增加敏感字段脱敏，避免 API Key 等凭据进入 SQL 或错误日志。 ## 快速部署 ### Docker Compose 生产部署 完整的密钥生成、发布前门禁、备份恢复、回滚和监控流程见 [`docs/production-deployment.md`](docs/production-deployment.md)。 ```bash cp .env.production.example .env.production # 编辑 .env.production，设置所有 replace_with_* 和域名/代理配置 docker compose --env-file .env.production config

docker compose --env-file .env.production up -d --build ``` 部署完成后访问： ```text https://你的域名/ ``` 如果只是本机验证，默认应用端口为 `3000`。生产环境建议在可信反向代理后面终止 HTTPS，并保持应用只绑定内网或本机地址。 ### 本地开发 后端直接运行： ```bash go run main.go ``` 启动 Docker 开发依赖： ```bash make dev-api ``` 启动 Default 前端： ```bash make dev-web ``` 启动 Classic 前端： ```bash make dev-web-classic ``` 构建两套前端： ```bash make build-all-web ``` ## 常用入口 | 入口 | 说明 | | --- | --- | | `/` | Default 前端控制台 | | `/token-balance` | 公共 API Key 余额查询页 | | `/api/status` | 站点状态与公共配置 | | `/api/token-balance` | API Key 余额查询接口 | | `/api/compliance/statement` | 合规声明读取 |

部署要求

生产部署需要 PostgreSQL、Redis，并配置多个环境变量如 SESSION_SECRET、FRONTEND_BASE_URL 等。

查看 README 依据

- 默认使用 PostgreSQL、Redis、只读容器文件系统、非特权运行、`no-new-privileges`、最小 Linux capabilities、健康检查和日志滚动。 - 生产环境要求显式配置 `SESSION_SECRET`、`FRONTEND_BASE_URL`、`SESSION_COOKIE_TRUSTED_URL`、`CORS_ALLOW_ORIGINS` 和 `TRUSTED_PROXIES`。 - 会话 Cookie、CORS、请求体大小、关键接口限流、响应缓存、TLS/SMTP 不安全跳过开关均有明确生产默认值。 - 日志侧增加敏感字段脱敏，避免 API Key 等凭据进入 SQL 或错误日志。 ## 快速部署 ### Docker Compose 生产部署 完整的密钥生成、发布前门禁、备份恢复、回滚和监控流程见 [`docs/production-deployment.md`](docs/production-deployment.md)。 ```bash cp .env.production.example .env.production # 编辑 .env.production，设置所有 replace_with_* 和域名/代理配置 docker compose --env-file .env.production config

| `/api/compliance/confirm` | 合规声明确认 | | `/api/source-attribution/status` | 来源归属状态 | | `/api/source-attribution/confirm` | 来源归属确认 | | `/api/registration/settings` | 注册与邀请限制设置 | ## 配置说明 生产部署至少需要设置： - `POSTGRES_PASSWORD` - `REDIS_PASSWORD` - `SESSION_SECRET` - `CRYPTO_SECRET` - `TOKEN_HMAC_KEY` - `TOKEN_ENCRYPTION_KEYS` - `FRONTEND_BASE_URL` - `SESSION_COOKIE_TRUSTED_URL` - `CORS_ALLOW_ORIGINS` - `TRUSTED_PROXIES` - `CLOVE_API_IMAGE_TAG` Compose 默认把应用数据库连接池限制为 80 个打开连接和 20 个空闲连接，为 PostgreSQL 健康检查、迁移、备份与人工运维保留余量。多节点部署时应按 PostgreSQL `max_connections` 重新分配每个节点的上限。

已知限制

项目仅用于合法授权的 AI API 网关场景，运营方需自行确保合规。

查看 README 依据

go test -p 1 ./... -count=1 go vet ./... ``` Default 前端： ```bash cd web/default bun run format:check bun run lint bun run typecheck bun run test bun run build ``` Classic 前端： ```bash cd web/classic bun run lint bun run eslint bun run test bun run build ``` ## 合规提示 本项目仅用于合法授权的 AI API 网关、组织级认证、多模型管理、用量统计、成本核算和私有化部署场景。运营方需要自行确保上游 API Key、模型服务、支付、用户数据、内容安全、备案、许可、日志留存、税务和当地监管要求均已合规。