chore: initialize clean metapi repository

2026-02-28 00:36:28 +08:00
commit 2ecc23730d
199 changed files with 46078 additions and 0 deletions
@@ -0,0 +1,124 @@
+# 🚀 快速上手
+
+本文档帮助你在 10 分钟内完成 Metapi 的首次部署。
+
+[返回文档中心](./README.md)
+
+---
+
+## 前置条件
+
+- Docker 与 Docker Compose（推荐）
+- 或 Node.js 20+ 与 npm（本地开发）
+
+## 方式一：Docker Compose 部署（推荐）
+
+### 1. 创建项目目录
+
+```bash
+mkdir metapi && cd metapi
+```
+
+### 2. 创建 `docker-compose.yml`
+
+```yaml
+services:
+  metapi:
+    image: 1467078763/metapi:latest
+    ports:
+      - "4000:4000"
+    volumes:
+      - ./data:/app/data
+    environment:
+      AUTH_TOKEN: ${AUTH_TOKEN:?AUTH_TOKEN is required}
+      PROXY_TOKEN: ${PROXY_TOKEN:?PROXY_TOKEN is required}
+      CHECKIN_CRON: "0 8 * * *"
+      BALANCE_REFRESH_CRON: "0 * * * *"
+      PORT: ${PORT:-4000}
+      DATA_DIR: /app/data
+      TZ: ${TZ:-Asia/Shanghai}
+    restart: unless-stopped
+```
+
+### 3. 设置令牌并启动
+
+```bash
+export AUTH_TOKEN=your-admin-token
+export PROXY_TOKEN=your-proxy-sk-token
+docker compose up -d
+```
+
+### 4. 访问管理后台
+
+打开 `http://localhost:4000`，使用 `AUTH_TOKEN` 的值登录。
+
+## 方式二：本地开发启动
+
+```bash
+git clone https://github.com/cita-777/metapi.git
+cd metapi
+npm install
+npm run db:migrate
+npm run dev
+```
+
+- 前端地址：`http://localhost:5173`（Vite dev server）
+- 后端地址：`http://localhost:4000`
+
+## 首次使用流程
+
+完成部署后，按以下顺序配置：
+
+### 步骤 1：添加站点
+
+进入 **站点管理**，添加你使用的上游中转站：
+
+- 填写站点名称和 URL
+- 选择平台类型（New API / One API / OneHub 等）
+- 填写站点的管理员 API Key（可选，部分功能需要）
+
+### 步骤 2：添加账号
+
+进入 **账号管理**，为每个站点添加已注册的账号：
+
+- 填入用户名和访问凭证
+- 系统会自动登录并获取余额信息
+- 启用自动签到（如站点支持）
+
+### 步骤 3：同步 Token
+
+进入 **Token 管理**：
+
+- 点击「同步」从上游账号拉取 API Key
+- 或手动添加已有的 API Key
+
+### 步骤 4：检查路由
+
+进入 **路由管理**：
+
+- 系统会自动发现模型并生成路由规则
+- 可以手动调整通道的优先级和权重
+
+### 步骤 5：验证代理
+
+使用 curl 快速验证：
+
+```bash
+# 检查模型列表
+curl -sS http://localhost:4000/v1/models \
+  -H "Authorization: Bearer your-proxy-sk-token"
+
+# 测试对话
+curl -sS http://localhost:4000/v1/chat/completions \
+  -H "Authorization: Bearer your-proxy-sk-token" \
+  -H "Content-Type: application/json" \
+  -d '{"model":"gpt-4o-mini","messages":[{"role":"user","content":"hi"}]}'
+```
+
+返回正常响应，说明一切就绪。
+
+## 下一步
+
+- [部署指南](./deployment.md) — 反向代理、HTTPS、升级策略
+- [配置说明](./configuration.md) — 详细环境变量与路由参数
+- [客户端接入](./client-integration.md) — 对接 Open WebUI、Cherry Studio 等