forked from boos/BoosAPI
Full internal rename: metapi → boosapi
Rename all remaining internal protocol identifiers: - x-metapi-* headers → x-boosapi-* - metapi: reasoning prefix → boosapi: - __metapi* runtime markers → __boosapi* - file-metapi-* → file-boosapi-* - METAPI_* env vars → BOOSAPI_* - metapi_turn_state/metapi_mcp_item__ etc. → boosapi_* - package.json name → boosapi - Docker/deploy/k3s/docs references 46 files changed, 168 insertions, 170 deletions. typecheck:web passes (0 new errors). Signed-off-by: Boos4721 <boos4721@icloud.com>
This commit is contained in:
@@ -72,7 +72,7 @@ export default withMermaid(
|
||||
{ text: 'OAuth 管理', link: '/oauth' },
|
||||
{ text: 'FAQ', link: '/faq' },
|
||||
{ text: '文档维护', link: '/README' },
|
||||
{ text: '项目主页', link: 'https://github.com/cita-777/metapi' },
|
||||
{ text: '项目主页', link: 'https://github.com/cita-777/boosapi' },
|
||||
],
|
||||
sidebar: [
|
||||
{
|
||||
@@ -106,7 +106,7 @@ export default withMermaid(
|
||||
},
|
||||
],
|
||||
socialLinks: [
|
||||
{ icon: 'github', link: 'https://github.com/cita-777/metapi' },
|
||||
{ icon: 'github', link: 'https://github.com/cita-777/boosapi' },
|
||||
],
|
||||
outline: {
|
||||
level: [2, 3],
|
||||
|
||||
@@ -105,10 +105,10 @@ Metapi 暴露标准 OpenAI / Claude 兼容接口,下游客户端通常只需
|
||||
|
||||
```toml
|
||||
model = "gpt-5"
|
||||
model_provider = "metapi"
|
||||
model_provider = "boosapi"
|
||||
|
||||
[model_providers.metapi]
|
||||
name = "metapi"
|
||||
[model_providers.boosapi]
|
||||
name = "boosapi"
|
||||
base_url = "https://your-domain.com/v1"
|
||||
```
|
||||
|
||||
|
||||
+2
-2
@@ -161,7 +161,7 @@ Render 免费实例在 15 分钟无流量后会自动休眠。使用 UptimeRobot
|
||||
### 标准步骤
|
||||
|
||||
```bash
|
||||
mkdir metapi && cd metapi
|
||||
mkdir boosapi && cd boosapi
|
||||
|
||||
# 创建 docker-compose.yml(参见快速上手)
|
||||
# 设置环境变量
|
||||
@@ -193,7 +193,7 @@ docker compose --env-file .env up -d
|
||||
## Docker 命令部署
|
||||
|
||||
```bash
|
||||
docker run -d --name metapi \
|
||||
docker run -d --name boosapi \
|
||||
-p 4000:4000 \
|
||||
-e AUTH_TOKEN=your-admin-token \
|
||||
-e PROXY_TOKEN=your-proxy-sk-token \
|
||||
|
||||
@@ -26,7 +26,7 @@
|
||||
### 1. 创建项目目录
|
||||
|
||||
```bash
|
||||
mkdir metapi && cd metapi
|
||||
mkdir boosapi && cd boosapi
|
||||
```
|
||||
|
||||
### 2. 创建 `docker-compose.yml`
|
||||
@@ -34,7 +34,7 @@ mkdir metapi && cd metapi
|
||||
```yaml
|
||||
services:
|
||||
metapi:
|
||||
image: 1467078763/metapi:latest
|
||||
image: 1467078763/boosapi:latest
|
||||
ports:
|
||||
- "4000:4000"
|
||||
volumes:
|
||||
@@ -111,7 +111,7 @@ Linux 安装包选择建议:
|
||||
|
||||
```bash
|
||||
git clone https://github.com/cita-777/metapi.git
|
||||
cd metapi
|
||||
cd boosapi
|
||||
npm install
|
||||
npm run db:migrate
|
||||
npm run dev
|
||||
|
||||
+21
-21
@@ -37,7 +37,7 @@ K3s 更新中心的日常入口位于:
|
||||
| Deploy Helper URL | UI:设置 → 更新中心 | 例如集群内 Service 地址 |
|
||||
| Namespace / Release Name / Chart Ref / Image Repository | UI:设置 → 更新中心 | 都是页面里直接填的部署配置 |
|
||||
| GitHub Releases / Docker Hub / 默认部署来源 | UI:设置 → 更新中心 | 属于页面里的版本来源策略 |
|
||||
| 主 Metapi 到 helper 的认证 token | 主 Metapi 环境变量 | `DEPLOY_HELPER_TOKEN` 或 `UPDATE_CENTER_HELPER_TOKEN` |
|
||||
| 主 BoosAPI 到 helper 的认证 token | 主 BoosAPI 环境变量 | `DEPLOY_HELPER_TOKEN` 或 `UPDATE_CENTER_HELPER_TOKEN` |
|
||||
| helper 自己监听在哪个地址和端口 | helper 环境变量 / manifest | `DEPLOY_HELPER_HOST` / `DEPLOY_HELPER_PORT` |
|
||||
| helper 自己的 Bearer Token | helper 环境变量 / manifest | `DEPLOY_HELPER_TOKEN`,且必须与主服务一致 |
|
||||
| chart 是否真的支持 digest 部署 | chart 文件本身 | 这不是 UI,也不是普通 env,要看 chart 模板 |
|
||||
@@ -151,7 +151,7 @@ docker compose up -d
|
||||
- `image.tag`
|
||||
- `image.digest`
|
||||
- 目标 Deployment 带有 `app.kubernetes.io/instance=<releaseName>` 标签
|
||||
- 主 Metapi 服务可以访问:
|
||||
- 主 BoosAPI 服务可以访问:
|
||||
- GitHub API
|
||||
- Docker Hub API
|
||||
- Deploy Helper 的集群内地址
|
||||
@@ -160,7 +160,7 @@ docker compose up -d
|
||||
|
||||
## helper 是什么
|
||||
|
||||
Deploy Helper 是一个跑在集群里的小服务。它不负责对外提供 Metapi 功能,只负责接受主 Metapi 发来的部署请求,然后在集群里执行:
|
||||
Deploy Helper 是一个跑在集群里的小服务。它不负责对外提供 Metapi 功能,只负责接受主 BoosAPI 发来的部署请求,然后在集群里执行:
|
||||
|
||||
- `helm history`
|
||||
- `helm get values`
|
||||
@@ -202,7 +202,7 @@ Deploy Helper 是一个跑在集群里的小服务。它不负责对外提供 Me
|
||||
|
||||
仓库里带了一个最小示例清单:
|
||||
|
||||
- `deploy/k3s/metapi-deploy-helper.yaml`
|
||||
- `deploy/k3s/boosapi-deploy-helper.yaml`
|
||||
- `deploy/k3s/chart`
|
||||
|
||||
使用前至少要改这些值:
|
||||
@@ -213,8 +213,8 @@ Deploy Helper 是一个跑在集群里的小服务。它不负责对外提供 Me
|
||||
|
||||
如果你准备直接按仓库示例接入,推荐把它们放到这两个路径:
|
||||
|
||||
- `/opt/metapi-k3s/metapi-deploy-helper.yaml`
|
||||
- `/opt/metapi-k3s/chart`
|
||||
- `/opt/boosapi-k3s/boosapi-deploy-helper.yaml`
|
||||
- `/opt/boosapi-k3s/chart`
|
||||
|
||||
这里有一个很容易漏掉、但会直接决定更新中心是否真的可靠的约束:
|
||||
|
||||
@@ -223,16 +223,16 @@ Deploy Helper 是一个跑在集群里的小服务。它不负责对外提供 Me
|
||||
|
||||
这两个值必须指向同一份 chart。
|
||||
|
||||
如果你在设置页把 `Chart Ref` 填成 `/opt/metapi-k3s/chart`,但 helper Pod 里根本没有把那份 chart 挂进去,那么更新中心即使能看到版本,也无法稳定把 digest 部署到真正运行中的 Pod。
|
||||
如果你在设置页把 `Chart Ref` 填成 `/opt/boosapi-k3s/chart`,但 helper Pod 里根本没有把那份 chart 挂进去,那么更新中心即使能看到版本,也无法稳定把 digest 部署到真正运行中的 Pod。
|
||||
|
||||
最小部署命令示例:
|
||||
|
||||
```bash
|
||||
kubectl create namespace ai
|
||||
mkdir -p /opt/metapi-k3s/chart
|
||||
cp -R deploy/k3s/chart/. /opt/metapi-k3s/chart/
|
||||
cp deploy/k3s/metapi-deploy-helper.yaml /opt/metapi-k3s/metapi-deploy-helper.yaml
|
||||
kubectl apply -f /opt/metapi-k3s/metapi-deploy-helper.yaml
|
||||
mkdir -p /opt/boosapi-k3s/chart
|
||||
cp -R deploy/k3s/chart/. /opt/boosapi-k3s/chart/
|
||||
cp deploy/k3s/boosapi-deploy-helper.yaml /opt/boosapi-k3s/boosapi-deploy-helper.yaml
|
||||
kubectl apply -f /opt/boosapi-k3s/boosapi-deploy-helper.yaml
|
||||
```
|
||||
|
||||
### 1.1 首次接入前一定要做的自检
|
||||
@@ -255,8 +255,8 @@ kubectl apply -f /opt/metapi-k3s/metapi-deploy-helper.yaml
|
||||
你可以在接入前先跑一次自检:
|
||||
|
||||
```bash
|
||||
helm template metapi /opt/metapi-k3s/chart \
|
||||
--set image.repository=1467078763/metapi \
|
||||
helm template boosapi /opt/boosapi-k3s/chart \
|
||||
--set image.repository=1467078763/boosapi \
|
||||
--set image.tag=latest \
|
||||
--set-string image.digest=sha256:0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef \
|
||||
| grep -n 'image:'
|
||||
@@ -264,17 +264,17 @@ helm template metapi /opt/metapi-k3s/chart \
|
||||
|
||||
你期望看到的是:
|
||||
|
||||
- `image: "1467078763/metapi@sha256:..."`
|
||||
- `image: "1467078763/boosapi@sha256:..."`
|
||||
|
||||
如果输出仍然是:
|
||||
|
||||
- `image: "1467078763/metapi:latest"`
|
||||
- `image: "1467078763/boosapi:latest"`
|
||||
|
||||
那说明这份 chart 还是 tag 语义,先不要继续配置更新中心。
|
||||
|
||||
### 2. 让主 Metapi 和 helper 用同一个 token
|
||||
### 2. 让主 BoosAPI 和 helper 用同一个 token
|
||||
|
||||
主 Metapi 端支持这两个环境变量,设置一个即可:
|
||||
主 BoosAPI 端支持这两个环境变量,设置一个即可:
|
||||
|
||||
- `DEPLOY_HELPER_TOKEN`
|
||||
- `UPDATE_CENTER_HELPER_TOKEN`
|
||||
@@ -295,11 +295,11 @@ helper 端使用:
|
||||
|
||||
| 字段 | 怎么理解 | 典型示例 |
|
||||
|------|--------|----------|
|
||||
| `Deploy Helper URL` | 主 Metapi 访问 helper 的地址 | `http://metapi-deploy-helper.ai.svc.cluster.local:9850` |
|
||||
| `Deploy Helper URL` | 主 BoosAPI 访问 helper 的地址 | `http://boosapi-deploy-helper.ai.svc.cluster.local:9850` |
|
||||
| `Namespace` | 目标 release 所在命名空间 | `ai` |
|
||||
| `Release Name` | Helm release 名 | `metapi` |
|
||||
| `Chart Ref` | helper Pod 能访问到的 chart 引用 | `/opt/metapi-k3s/chart` |
|
||||
| `Image Repository` | 升级时写入 chart 的镜像仓库 | `1467078763/metapi` |
|
||||
| `Chart Ref` | helper Pod 能访问到的 chart 引用 | `/opt/boosapi-k3s/chart` |
|
||||
| `Image Repository` | 升级时写入 chart 的镜像仓库 | `1467078763/boosapi` |
|
||||
| `默认部署来源` | 默认从 GitHub 还是 Docker Hub 取版本 | `GitHub Releases` |
|
||||
|
||||
另外还有 3 个开关:
|
||||
@@ -395,7 +395,7 @@ About 页里的“更新提醒”更像一个轻量入口:
|
||||
如果你是第一次接入,最稳妥的方式就是直接从仓库自带的:
|
||||
|
||||
- `deploy/k3s/chart`
|
||||
- `deploy/k3s/metapi-deploy-helper.yaml`
|
||||
- `deploy/k3s/boosapi-deploy-helper.yaml`
|
||||
|
||||
开始,不要自己先抄一份简化版再改。
|
||||
|
||||
|
||||
Reference in New Issue
Block a user