从一行安装命令,
到完成首次调用。
支持在 Linux 或 macOS 上自托管。零门槛上手,不需要先找销售。
选择部署环境
准备 Linux amd64 / arm64 或 macOS Intel / Apple silicon,以及 Docker、Compose v2(支持 up --wait)、Buildx、Bash、OpenSSL、curl 和 tar。Mac 先启动 Docker 运行环境,安装命令不要加 sudo。安装器检查依赖,不自动安装 Docker。
安装网关
先从官方仓库获取完整应用源码。在 BOS API 应用源码根目录运行下方命令,由 Go 提供前端与 API,无需 Nginx。需要公网访问时放行服务器入方向 TCP 18080;仅本机访问时省略 --public。
获取开源代码 ↗./install.sh --local --public --port 18080此命令直接复用安装指南的同一内容源。更新前备份配置和数据、先取得目标版本源码,再重跑同一命令;--local 不会自动拉取代码。
查看完整安装与访问验证完成管理初始化
按安装输出找到控制台和首次登录信息。在自己的网关完成管理员登录与验证设置,再在“设置 > API 地址”保存客户端实际可访问的入口。官网不会索取你的管理员凭据。
查看操作指南接入上游与模型
准备自己的供应商账号或渠道,配置 Provider、Base URL、协议与凭据,添加可用模型并核对状态。自托管软件不包含上游模型账号或调用额度。
查看操作指南配置组织与 API Key
为组织分配模型和渠道访问范围,为应用创建 Key,设置模型限制、QPS 与滚动额度。保存连接信息,不将上游凭据分发给客户端。
查看操作指南一个连续任务,
完成第一次模型调用。
上游渠道 → 组织 → API Key → 验证调用。所有数据均为虚构演示,不连接真实网关。
连接供应商与模型
- Provider
- Demo provider
- Base URL
- https://provider.example.com/v1
- 模型
- demo-model
- 上游凭据
- [DEMO ONLY]
在供应商与模型管理中配置渠道、接入协议和模型,核对可用状态。
阅读操作文档分配明确的访问范围
- 组织
- Demo Engineering
- 授权渠道
- Demo provider
- 授权模型
- demo-model
创建 Demo Engineering 组织,分配刚配置的渠道与模型;未授权的资源不在访问范围内。
阅读操作文档为应用创建受限 Key
- 名称
- demo-workspace
- 归属组织
- Demo Engineering
- 模型限制
- demo-model
- QPS
- 5
- 滚动额度
- 10,000 tokens / 24h
- Key
- sk-demo-••••
选择该组织,设置名称、模型限制、QPS 和滚动额度,再查看连接参数。这里的额度仅为演示配置。
阅读操作文档从配置走到首次调用
- 请求标识
- req_demo_01
- 模型
- demo-model
- 归属 Key
- demo-workspace
- 结果
- 200 OK · 128 tokens
使用该 Key 调用已授权模型,再到用量和调用记录核对请求标识、状态与 Token。
阅读操作文档
演示数据与界面结构示意;实际操作以当前版本后台与对应文档为准。
完成首次请求
在终端设置你自己的网关入口、Key 和已授权模型;下面只包含占位符。官网域名不是你部署的模型 API 地址。
export BOS_BASE_URL='https://gateway.example.com/v1'
export BOS_API_KEY='<YOUR_GATEWAY_KEY>'
export BOS_MODEL='<YOUR_ALLOWED_MODEL_ID>'
curl "$BOS_BASE_URL/chat/completions" \
-H "Authorization: Bearer $BOS_API_KEY" \
-H 'Content-Type: application/json' \
-d '{"model":"'"$BOS_MODEL"'","messages":[{"role":"user","content":"Hello"}]}'成功后检查响应内容,并到网关的用量与调用记录核对模型、Key、请求状态和 Token。错误时按状态码检查下方项目。
查看 API 接入与请求示例连接你的客户端
先查看 CC Switch 导入流程,也可使用 Vary AI 管理客户端配置。
排查常见问题
- 环境不满足 / 安装失败
- 检查 Docker、Compose、Buildx 和端口。按安装输出修复依赖,不重复创建默认实例。
- 渠道无可用模型
- 核对渠道启用状态、模型 ID、上游凭据和协议。
- 401 / 403 权限不足
- 核对网关 Key、组织授权、允许模型和供应商范围。
- 429 额度或频率限制
- 检查 Key / 组织的 QPS、滚动额度及上游余额。
- 安全规则阻断
- 通过请求标识关联安全事件,核对规则、检测范围和处置;不要通过关闭保护来绕过问题。