CLI 命令
不带子命令时等同于 omnigate start。
不带子命令时等同于 omnigate start。
代理面、管理面与门户面的 HTTP 端点清单。管理面需要管理台会话或 Basic 凭据;代理面与门户面使用虚拟密钥。
OpenAI 兼容的 AI 网关。把多个模型提供方聚合成一个端点,提供加权负载均衡、模型内密钥权重、阶梯熔断、虚拟密钥、密钥门户和多维统计,内嵌管理控制台——全部打包在一个静态二进制里。
这篇从空配置走到第一个成功的 /v1/chat/completions 请求。示例用智谱作为上游,换成任意 OpenAI 兼容端点都可以。
仓库目录、模块职责与构建产物。
本目录按「配置 → 调用 → 自助服务」的顺序组织日常使用说明。
跨协议调用时的字段映射、端点策略与已知限制。日常使用建议走 OpenAI 兼容端点;需要厂商独有参数时再用原生端点。
本目录是查表用的:命令、环境变量、配置项、HTTP 端点和术语。
跨平台产物、npm 包与 GitHub Release 的发布步骤。面向维护者。
OmniGate 把配置分成两层:
除对话外,OmniGate 还代理 Embedding、Rerank、生图、语音、视频,并把多个 MCP Server 聚合成一个工具网关。所有端点都走同一套虚拟密钥鉴权、失败转移、熔断和统计。
OmniGate 默认本地运行,但也会被放到局域网或反向代理后面。下面是你需要知道的边界。
通过 npm 安装
状态:设计中 / 实现中。 这一页是设计稿,描述定时探测被自动禁用的 模型×密钥 组合并自动解禁的机制。配置与行为以当前版本代码为准。
管理员在管理台创建虚拟密钥后,把密钥交给使用者。使用者访问 /portal,用这把密钥登录,只能查看自己的信息,全站没有写入口。
管理台内置 Playground,用来在发凭证之前验证「模型 + 参数 + 工具」是否可用。
本目录面向贡献者与维护者:本地环境、代码结构、测试、发布和调试。
omnigate autostart 与管理台「设置 → 开机自启」共用同一套实现,支持 Linux、macOS、Windows 三端用户级自启。
本目录帮助你在最短时间内把 OmniGate 跑起来,并从自己的应用里发出第一个请求。
这一页说明 OmniGate 的目标、非目标与整体结构。设计稿面向贡献者,但其中的取舍对部署和排障也有帮助。
OmniGate 对下游暴露 OpenAI 兼容接口,绝大多数支持自定义 Base URL 的 SDK 和 AI 工具都能直接接入。
默认使用 SQLite(纯 Go 驱动,无 CGO)。需要多个入口共享一套状态时,切换到 MySQL 或 PostgreSQL。
实体关系与建表 DDL。SQLite 为基准,MySQL / Postgres 由 GORM AutoMigrate 翻译,方言差异收口在 internal/store/dialect.go。
日志位置
前置:Go 1.27+、Node 18+(仅 web 构建需要)。
| 术语 | 含义 |
项目没有配置外部 linter,质量门槛是 go test 与 go vet。
熔断粒度是 模型×密钥 组合。这一页说明失败分类、阶梯冷却、模型可达性的派生口径与全部不可用时的兜底。
OmniGate 会检查 GitHub 最新 Release,管理台顶栏显示当前版本,发现新版本打红点。CLI 对应命令:
环境变量覆盖启动层配置,优先级低于 CLI flag、高于 config.yaml。
请求记录哪些维度、费用如何折算、隐私默认是什么。
/v1 调用用虚拟密钥鉴权,不是提供商那把上游 key。在管理台 虚拟密钥 页创建,创建时弹窗给出完整 vk-...,列表默认脱敏,可再查看或复制。
本目录收录内部实现与设计取舍。它们不影响日常使用,但能解释「为什么行为是这样」,也是排障和二次开发的参考。
从入口到上游的一次完整请求,以及失败后如何在模型与密钥之间转移。
/v1 调用使用虚拟密钥鉴权,在管理台「虚拟密钥」页面创建,说明见 虚拟密钥。调用前需要先在 配置中心 配好提供商和模型,再在 路由 挂上逻辑名。
调试模式会记录每次出站请求、响应头和每个 SSE 块,用来定位上游、协议转换和流式问题。
配置中心解决「上游是谁」;这一页解决「客户端看到什么名字、请求怎么落到上游」。客户端请求里的 model 填路由的模型别名。
一次请求如何从逻辑模型走到物理模型,再走到具体密钥。
管理台 设置 页改的是运行层:熔断、重试、流式、日志捕获、会话亲和、计费、通知与探测。保存后对下一个请求立即生效,不用改 config.yaml,也不用重启。监听地址、登录账号和数据库仍在 启动层配置。
OmniGate 有两条提醒通道:外发通知(Webhook / 飞书 / 钉钉 / 企业微信 / Slack)和站内通知中心。它们只负责提醒,不改变请求是否放行。
本目录面向长期运行与团队使用:部署形态、数据库、开机自启、版本更新、通知与排障。
OmniGate 是单进程、单二进制服务,管理台与代理共用一个端口(默认 17777)。
管理台左侧 配置中心 是日常使用的入口:先配提供商和密钥,再挂模型,最后到 路由 对外暴露逻辑模型名。保存后即时生效,不必重启进程。
启动层与运行层的完整配置项。启动层改完要重启;运行层保存即热生效。
通知是一份事实,谁能看见由受众决定;已读状态按受众分开保存。这一页也说明配额告警的档位与去重。