跳到主要内容

47 篇文档带有标签「guide」

查看所有标签

CLI 命令

不带子命令时等同于 omnigate start。

Fedora GNOME 桌面必备工具与配置

Fedora Workstation 装完能跑,但日常用起来还差一层:托盘图标、最小化按钮、电池百分比、剪贴板历史都在 GNOME 默认之外;Flatpak 应用的权限管理和残留清理也需要专门工具。

HTTP API

代理面、管理面与门户面的 HTTP 端点清单。管理面需要管理台会话或 Basic 凭据;代理面与门户面使用虚拟密钥。

MD文档转PDF

在vscode扩展商店中,搜索 Markdown PDF,作者为 yzane

Nebula Notify 模块

本目录用于说明 nebula-notify 模块的定位、通道模型、业务能力、接入方式、配置与建表结构。

Nebula Notify 模板语法与变量

本文是通知模板的完整参考:渲染引擎、模板语法、内置变量、自定义字段约束、各渠道差异与存量迁移。

Nebula Notify 设计与实现

本文说明 nebula-notify 的关键设计:模板/变体/记录三层数据关系、渠道分发结构、站内信与推送的关系、订阅偏好判定优先级、推送扇出。

Nebula 移动端基座

本目录说明 nebula 仓库 mobile/ 目录下的移动端基座工程(React Native 新架构 + TypeScript,一套代码输出 iOS / Android / 鸿蒙),以及与之配套的端无关共享契约包 packages/client-sdk/。

SELinux 是什么

SELinux(Security-Enhanced Linux)是 Linux 内核里的强制访问控制(MAC)。传统的用户/组/其他权限只能回答「这个进程的属主能不能读写这个文件」;SELinux 在这之上再问一层:「这个进程的类型,按策略,允不允许对这个类型的对象做这个操作」。

tmux 使用指南

tmux 是终端复用器(terminal multiplexer):它在终端里再套一层「服务端 + 会话」,程序跑在会话里而不是直接挂在 SSH 连接或终端窗口上。所以断线不丢任务、一个窗口里能分屏、多台客户端能接到同一个会话。

五分钟上手

这篇从空配置走到第一个成功的 /v1/chat/completions 请求。示例用智谱作为上游,换成任意 OpenAI 兼容端点都可以。

使用指南

本目录按「配置 → 调用 → 自助服务」的顺序组织日常使用说明。

其他

本目录收录不属于特定技术分类的安装、设备与软件问题排查文档。

其他

本目录收录开发环境、命令行工具和跨平台基础知识相关文档。

协议转换

跨协议调用时的字段映射、端点策略与已知限制。日常使用建议走 OpenAI 兼容端点;需要厂商独有参数时再用原生端点。

参考

本目录是查表用的:命令、环境变量、配置项、HTTP 端点和术语。

发布管理(npm 与 Maven Central)

个人开发者向 npm 与 Maven Central 两大公共仓库发布包的完整链路:账号注册、命名空间验证、发布凭证、首次发布与撤回规则。

定时探测与自动解禁

状态:设计中 / 实现中。 这一页是设计稿,描述定时探测被自动禁用的 模型×密钥 组合并自动解禁的机制。配置与行为以当前版本代码为准。

对话测试页

管理台内置 Playground,用来在发凭证之前验证「模型 + 参数 + 工具」是否可用。

应用版本与升级检查

nebula-frontend 提供应用版本发布管理与客户端升级检查能力,覆盖「发布新版本 → 客户端冷启动判定是否升级 / 强制升级 → 管理端撤回」的闭环。

开发与发布

本目录面向贡献者与维护者:本地环境、代码结构、测试、发布和调试。

快速开始

本目录帮助你在最短时间内把 OmniGate 跑起来,并从自己的应用里发出第一个请求。

总体架构

这一页说明 OmniGate 的目标、非目标与整体结构。设计稿面向贡献者,但其中的取舍对部署和排障也有帮助。

接入客户端

OmniGate 对下游暴露 OpenAI 兼容接口,绝大多数支持自定义 Base URL 的 SDK 和 AI 工具都能直接接入。

数据模型

实体关系与建表 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 对应命令:

移动端共享契约 client-sdk

packages/client-sdk/ 是端无关的纯 TypeScript 契约包,供 mobile/(以及后续小程序)与 web/ 共用,避免 token 与 401 语义各写一份而漂移。

移动端基座使用方式

本文说明三件事:如何在基座之上写业务工程、如何构建三端、模板仓如何拿到 mobile/。

统计口径

请求记录哪些维度、费用如何折算、隐私默认是什么。

设计与架构

本目录收录内部实现与设计取舍。它们不影响日常使用,但能解释「为什么行为是这样」,也是排障和二次开发的参考。

调试模式

调试模式会记录每次出站请求、响应头和每个 SSE 块,用来定位上游、协议转换和流式问题。

运行设置

管理台 设置 页改的是运行层:熔断、重试、流式、日志捕获、会话亲和、计费、通知与探测。保存后对下一个请求立即生效,不用改 config.yaml,也不用重启。监听地址、登录账号和数据库仍在 启动层配置。

通知与告警

OmniGate 有两条提醒通道:外发通知(Webhook / 飞书 / 钉钉 / 企业微信 / Slack)和站内通知中心。它们只负责提醒,不改变请求是否放行。

部署与运维

本目录面向长期运行与团队使用:部署形态、数据库、开机自启、版本更新、通知与排障。

配置项总表

启动层与运行层的完整配置项。启动层改完要重启;运行层保存即热生效。

门户权限与通知受众

通知是一份事实,谁能看见由受众决定;已读状态按受众分开保存。这一页也说明配额告警的档位与去重。