跳转到内容

快速开始

本页做一件事:按 默认推荐的 Cloudflare 路径 把 OctaFuse 跑起来,并能打开管理台。个人与小流量通常可在 Workers / D1 免费额度内完成部署与日常使用。

更细的供应商、路由和密钥配置方法见 使用指南。不用 Cloudflare 时见 Docker 部署

  • Node.js 20+、npm。
  • 无需 Cloudflare 账号。
Terminal window
git clone https://github.com/OctaFuse/octafuse-gateway.git
cd octafuse-gateway
npm install
npm run db:migrate
npm run dev:proxy

另开终端:

Terminal window
npm run dev:admin
服务地址 / 位置
代理服务(Proxy)http://127.0.0.1:8787
管理后台(Admin)http://127.0.0.1:8789
控制台登录admin / admin(本地默认;首次 dev:admin 会自动生成 packages/admin/.dev.vars
本地 D1./.wrangler/state
管理 API Bearer 密钥sk-dev-admin-key(管理 API,不是网页密码)

健康检查:

Terminal window
curl -sS http://127.0.0.1:8787/health

前置:Cloudflare 账号,本机已 npx wrangler login

Terminal window
npx wrangler login
npm run bootstrap:cloudflare

完成后按终端提示核对 GATEWAY_URL / GATEWAY_MASTER_URL,并用 GET $GATEWAY_URL/health 验证。完整步骤与发版见 Cloudflare Workers 部署

  1. 本地打开 http://127.0.0.1:8789(上云后使用管理后台地址)。
  2. 本地默认账号:admin / admin(仅本机;可改 packages/admin/.dev.vars)。上云时使用 bootstrap 设置的 ADMIN_PASSWORD。Docker 本地一键体验默认是 admin / changeme,见 Docker 部署
OctaFuse 管理后台仪表盘(Dashboard)登录后的总览页面。
登录成功后,仪表盘(Dashboard)会显示 API 密钥、账户、请求、Token、费用、延迟和最近错误等运行概况。

建议的下一步(使用指南顺序)

Section titled “建议的下一步(使用指南顺序)”
  1. 供应商(Providers)配置 — 接入上游模型服务
  2. 模型(Models)配置 — 维护网关识别的模型目录
  3. 路由(Routes)配置 — 用请求入口(Request Surface)→ 路由池(Route Pool)→ 上游目标(Upstream Target)把客户端 modeloperation 映射到上游
  4. 智能体工具(Agent Tools)(可选)— 配置网页搜索(Web Search)、网页抓取(Web Fetch)和深度搜索(Web Deep Search)的启用引擎
  5. 用户(Users)管理API 密钥(API Keys)管理 — 确定谁可以调用以及额度多少

在管理台里配好供应商、模型、请求入口、路由池、上游目标和 API 密钥后,将密钥与 model 换成真实值:

Terminal window
curl -sS http://127.0.0.1:8787/v1/chat/completions \
-H "Authorization: Bearer sk-your-api-key" \
-H "Content-Type: application/json" \
-d '{"model":"your-route-model","messages":[{"role":"user","content":"Hello"}]}'

上云后把主机换成你的代理服务地址。

Docker / Postgres / MySQL 等自托管路径见 Docker 部署。更多本地组合(Node + SQL、冒烟脚本)见 GitHub · 本地开发