跳转到内容
ProxAI

安装与升级

安装与升级

Section titled “安装与升级”

当你需要处理运维路径时使用本页：获取二进制、在本地运行、定位配置，并在不丢失本地状态的前提下升级。

安装路径

Section titled “安装路径”
  1. 1获取发布二进制下载适合当前平台的 ProxAI release，或从源码本地构建。
  2. 2放入 PATH把可执行文件放到 shell 和客户端启动器都能找到的位置。
  3. 3首次启动第一次运行会创建应用目录和本地示例文件。
  4. 4编辑 config.toml添加 provider、默认 provider 名称和路由。
  5. 5连接客户端把 OpenAI-compatible 客户端指向本地 ProxAI 监听地址。

第一次发请求的完整流程见快速开始。

应用目录

Section titled “应用目录”

ProxAI 会把本地运行状态放在应用目录。具体路径取决于平台和启动配置。

产物用途
`config.toml`本地运行时配置。应保持私有，不提交。
`config.example.toml`生成的本地参考示例。仓库中的副本仍是规范示例。
`captures/`可选的本地请求/响应调试产物，可能包含私有数据。
`logs/`配置后生成的本地诊断日志。

文件职责见环境与文件。

升级检查清单

Section titled “升级检查清单”
检查项为什么重要
阅读发布说明关注配置、路由、协议转换、流式或错误响应变化。
保留 config.toml不要用示例文件覆盖本地私有配置。
对比示例新增选项时以仓库中的 config.example.toml 作为单一示例来源。
跑一个小请求在处理大 prompt 或工具调用前，先验证默认 provider 路由。
如果使用流式则单独检查流式行为对用户可见，应该用真实客户端验证。

本地源码构建

Section titled “本地源码构建”

如果从源码构建，在替换工作中的二进制之前，优先运行仓库验证命令：

Terminal window
just check

只改站点时使用：

Terminal window
just site check

什么时候需要回看配置

Section titled “什么时候需要回看配置”
添加 provider添加带 protocol、base_url 和 api_key 的命名 provider。按模型路由当某个模型模式需要 provider 或协议覆盖时使用显式路由。修改错误格式面向人工调试使用 text，面向 SDK 风格客户端使用 JSON。捕获一个请求开启最窄阶段，复现一次，然后关闭捕获。

安全回滚

Section titled “安全回滚”

通常只需要把二进制替换回旧版本，同时保留同一个本地 config.toml。如果新版本引入了配置字段，只移除旧版本无法解析的字段。