跳转到内容
OctaFuse OctaFuse

GitHub 技术参考

以下入口由 sync/contract.json 生成，指向 octafuse-gateway 仓库内的权威技术文档。官网只维护面向使用者的轻量指南；API、部署、迁移、架构和行为语义以 gateway 仓库为准。

快速开始 Docker 与 Cloudflare 本地 D1 的最小启动路径。
用户侧 API OpenAI / Anthropic / Gemini、Images、Audio、Agent Tools、模型列表与预算状态。
Admin HTTP API Provider、模型、路由、Tools、用户、密钥、计费配置、日志与分析接口。
Docker / 自托管 Docker 镜像、Compose、GHCR、Postgres / MySQL 和 Zeabur 注意事项。

读者入口

Section titled “读者入口”
Doc内容
文档总入口按使用者、开发者、运维者和维护者组织的入口。
快速开始Docker 与 Cloudflare 本地 D1 的最小启动路径。
Admin 配置指南部署后配置 Provider、模型路由、Agent Tools、用户和 API Key。
功能地图协议、Agent Tools、路由策略、计费、管理能力与部署方式总览。

开发者与集成

Section titled “开发者与集成”
Doc内容
系统集成指南门户、后台或 SaaS 接入 Gateway 的边界、Key 类型和常见流程。
API 总览Proxy / Admin 的 Base URL、认证方式和错误形态。
用户侧 APIOpenAI / Anthropic / Gemini、Images、Audio、Agent Tools、模型列表与预算状态。
Admin HTTP APIProvider、模型、路由、Tools、用户、密钥、计费配置、日志与分析接口。
本地开发与测试D1、Node + Postgres、Node + MySQL、Docker 和冒烟脚本组合。

架构与行为语义

Section titled “架构与行为语义”
Doc内容
运行时与数据存储架构Cloudflare / Node 与 D1 / Postgres / MySQL 的组合矩阵。
Route 拓扑Request Surface → Route Pool → Upstream Target 的关系、operation、Provider Sticky 与故障转移边界。
路由策略hash_affinity、weighted_random、weight_priority、weighted_round_robin 的算法、按层覆盖与 Provider Sticky。
Proxy 请求生命周期鉴权、Surface / Pool / Target 解析、四策略、Provider Sticky、熔断、failover 和异步记账。
用户与 API Key 数据模型User、API Key、预算、请求日志和审计日志的关系与约束。
流式计费与取消流式 Chat、客户端取消、usage 解析和扣费状态。
文生图模型gpt-image-2 与 Seedream：端点、参数、计费折算与运营验收。
时间与时区UTC 存储、API 输出、Admin 显示和业务日界。

部署与运维

Section titled “部署与运维”
Doc内容
部署模式索引Cloudflare、Hybrid、Full self-hosted、MySQL 和 Zeabur 模式总览。
Cloudflare 部署Worker、Admin、D1、Build variables、Workers Builds 和迁移顺序。
Docker / 自托管Docker 镜像、Compose、GHCR、Postgres / MySQL 和 Zeabur 注意事项。
Gemini models.generate 迁移迁移 0017：合并流式与非流式 Surface、处理冲突 Pool，并校验 Gemini 出站 action。
按 priority 层路由策略迁移迁移 0018：新增 Route Pool tier_strategies、发布顺序与验收步骤。
Canonical 路由策略 ID 迁移迁移 0019：2.2.0 历史策略 ID 硬切换与持久化配置校验。
Provider Sticky 迁移迁移 0020：新增 Route Pool Sticky 配置与共享绑定表；包含 v2.3.0 部署顺序和运维语义。
路由策略展示 ID 迁移迁移 0021：cache_affinity / fixed_order 硬切换为 hash_affinity / weight_priority，无旧 ID 别名。
D1 ↔ Postgres 切换ETL、对账、灰度、切换和回滚要点。
Cloudflare 命令速查Cloudflare 本地、dev 演示和生产 Git 自动部署命令清单。

维护者与规范

Section titled “维护者与规范”
Doc内容
版本治理与发版Changesets、Version PR、tag、GitHub Release 和 GHCR 镜像。
文档边界与敏感信息规范仓内文档分层、官网边界、占位符和禁止值。
curl 最小示例健康检查、用户推理、Agent Tool 与 Admin 鉴权探针的最小 curl。