v2 Beta — 预发布版本文档。 查看 1.x 稳定版文档
Skip to content

CPAMP 轻量面板 ​

CPAMP 轻量面板由 CPA 直接托管,用 CPA Manager Plus 的界面替换官方 Management Center。它不需要 Manager Server、SQLite、额外容器或新的端口,适合希望保持轻量部署但更换管理 UI 的用户。

最短安装流程 ​

  1. 在 CPA config.yaml 中设置 panel-github-repository。
  2. 确认管理面板没有被禁用。
  3. 重启或重新加载 CPA。
  4. 打开 http://<cpa-host>:8317/management.html。
  5. 使用 CPA Management Key 登录。

下面给出完整配置和安全说明;已经熟悉 CPA 配置的用户只需要完成以上步骤。

text
浏览器
  -> CPA :8317/management.html
      -> CPAMP 单文件面板
      -> CPA Management API

适合什么场景 ​

  • 已经运行 CPA / CLIProxyAPI。
  • 不喜欢官方面板的界面或信息组织。
  • 希望继续只维护一个 CPA 进程和一个管理端口。
  • 主要管理 Provider、凭证与账号状态、OAuth、API Key、日志、插件和配置。
  • 暂时不需要持久化请求历史、成本分析或服务端自动化。

前置条件 ​

  • 1.x Stable 面板保留原 CPA 兼容范围;v2 Beta 面板按固定官方 CPA v8.0.55 验收,External 完整模式最低也要求 v8.0.55,不能将旧 README 的 CPA 推荐版本当成 Beta 资格证明。
  • CPA 必须配置 remote-management.secret-key,否则 Management API 和面板无法使用。
  • remote-management.disable-control-panel 必须为 false。
  • CPA 需要能够访问 GitHub Release,或通过它已经配置的代理下载 management.html。
  • CPA v8 可用:v2 Beta 的轻量面板通过 CPA v8 仍然提供的 /v0/management 工作,详见下文「v2 Beta 与轻量面板的连续性」。

配置 CPA ​

编辑 CPA 的 config.yaml:

yaml
remote-management:
  # 安全默认值。只有需要从非 localhost 访问时才改为 true。
  allow-remote: false

  # CPA Management Key。不要把真实密钥提交到 Git。
  secret-key: 'replace-with-your-management-key'

  # 必须允许 CPA 托管管理面板。
  disable-control-panel: false

  # false 表示允许 CPA 定期检查并更新面板。
  disable-auto-update-panel: false

  # 让 CPA 从 CPAMP Release 下载 management.html。
  panel-github-repository: 'https://github.com/seakee/CPA-Manager-Plus'

allow-remote: true 会开放远程 Management API。只在可信网络、VPN 或受保护的反向代理后使用,不要把管理端口和密钥暴露到不可信网络。

CPA v8 也读取新的配置布局:config-version: 8 加顶层 management:,字段与上面的 remote-management 相同。两种写法都已在 CPA v8 上验证。

启动和登录 ​

  1. 保存配置并重启或重载 CPA。
  2. 打开:
text
http://<cpa-host>:8317/management.html
  1. 使用 CPA Management Key 登录。
  2. 确认 Dashboard、配置中心、Provider、凭证管理、OAuth 和日志能够正常读取。

CPA 会从指定 GitHub 仓库的 releases/latest(最新的正式 Release,不含预发布)查找名为 management.html 的资源,并缓存为 CPA config.yaml 所在目录旁的 static/management.html(即 config.yaml 同级的 static/ 文件夹;设置了 MANAGEMENT_STATIC_PATH 或 WRITABLE_PATH 时以它们为准)。

更新与缓存 ​

当 disable-auto-update-panel: false 时,CPA 会定期检查最新面板。升级后仍显示旧界面时:

  1. 确认 panel-github-repository 仍指向 CPA Manager Plus。
  2. 停止 CPA。
  3. 删除 CPA config.yaml 同级 static/ 文件夹中的面板缓存:
bash
rm static/management.html
  1. 重新启动 CPA 并访问 /management.html。

如果启用了 disable-auto-update-panel: true,CPA 只会在缓存文件不存在时下载面板,不会定期自动更新。

v2 Beta 与轻量面板的连续性 ​

以下是 CPAMP v2 Beta 对轻量面板的发布约定;首个 v2 Beta 预发布发布之前,Releases 页面上还没有对应文件。

  • releases/latest 继续指向 1.x。 v2 Beta 以 GitHub 预发布(prerelease)发布,而 GitHub 的 releases/latest 不包含预发布。CPA 只读取 releases/latest,所以按本页配置了 panel-github-repository 的 CPA 在 Beta 期间继续下载并更新 1.x 轻量面板,不会被自动切换到 v2。
  • 预发布附带 management.html。 每个 v2 Beta 预发布同样附带单文件 management.html(npm run build:panel 的产物,不引用任何 assets/ 资源)。CPA 不会自动下载它。
  • 管理接口仍是 /v0/management。 v2 Beta 的轻量面板通过 CPA v8 继续提供的 /v0/management 读写配置,使用 CPA v8 的 Management Key 登录。改用 /v8/management 属于 Stable 之后的工作,不在首个 Beta 范围内。
  • 发布前验收。 bin/ci/panel-lite-cpa-v8.mjs 在固定版本的 CPA v8 上验证:CPA 取得的 static/management.html 与构建产物逐字节一致,/management.html 返回 200,用 Management Key 访问 /v0/management/config 并修改一个配置字段后写入 config.yaml,disable-control-panel: true 时 /management.html 返回 404。

在 CPA 上试用 v2 Beta 面板 ​

CPA 的 panel-github-repository 自动更新入口面向 releases/latest,不用于选择 Beta Prerelease。不要把预发布 Tag URL 填入该字段来切换通道:

  • api.github.com 形式:地址如果不以 /releases/latest 结尾,CPA 会追加该后缀;因此 .../releases/tags/<tag> 会变成 .../releases/tags/<tag>/releases/latest,而不是获取指定预发布。
  • 浏览器形式:github.com/<owner>/<repo>/releases/tag/<tag> 只取前两段,解析为仓库的 repos/<owner>/<repo>/releases/latest,取得的仍是 1.x 面板,不会选中网页 Tag。
  • 获取失败的备用来源:如果下载失败且本地没有缓存文件,CPA 会尝试安装来自 cpamc.router-for.me 的上游备用面板;它不是所选 CPAMP Beta 文件。不能把能够打开 /management.html 本身视为已安装目标 Beta。

要试用 v2 Beta 面板,手动放置文件,并保留下述缓存位置与自动更新设置:

  1. 从实际已发布的 v2 Beta 预发布页面下载 management.html,并核对同版 checksums.txt。Stable 地址为 https://github.com/seakee/CPA-Manager-Plus/releases/latest/download/management.html;Beta 模板为 https://github.com/seakee/CPA-Manager-Plus/releases/download/v2.0.0-beta.X/management.html,其中 X 必须替换成真实已发布编号。
  2. 在 CPA config.yaml 中设置 disable-auto-update-panel: true。否则 CPA 会用 releases/latest 的 1.x 面板覆盖手动放置的文件。
  3. 停止 CPA,把文件复制为 CPA config.yaml 同级 static/ 文件夹中的 management.html,再启动 CPA。
  4. 打开 http://<cpa-host>:8317/management.html,使用 CPA Management Key 登录。

回到 1.x 面板:删除 static/management.html,把 disable-auto-update-panel 改回 false,重启 CPA。

External 完整模式不是这个无后端的轻量面板:它需要 Manager,并由操作者独立运行、升级及备份外部 CPA;CPAMP 不接管其宿主机生命周期,见 运行模型。v2 Embedded 则必须使用同版三镜像 Compose/配对记录,不能只复制 management.html 升级 Full Web。项目当前 MIT、官方 CPA MIT 与镜像第三方声明的核验路径见 发布与许可证。

轻量面板支持什么 ​

能力CPAMP 轻量面板
CPA 配置、Provider、凭证管理、OAuth 和日志支持
API Key、模型别名、优先级和插件管理支持,取决于 CPA API 与插件路径
浏览器本地账号检查支持页面提供的本地能力
SQLite 请求历史与请求监控不支持
用量与成本分析、模型价格、API Key 别名不支持
服务端账号巡检、配额冷却和账号处理队列不支持
完整模式的备份、迁移和维护工具不支持

轻量面板不会连接或读取独立运行的 Manager Server。启动 Manager Server 不会让 :8317/management.html 自动获得完整能力。

升级到 CPAMP 完整模式 ​

需要请求历史、成本分析或服务端自动化时:

  1. 按 Docker 部署 或 原生包部署 启动 Manager Server。
  2. 打开完整模式入口:v2 Beta 是安装时设置的控制台地址(默认 http://<cpamp-host>:18317/console),1.x Stable 是 http://<cpamp-host>:18317/management.html。
  3. 使用 CPAMP Admin Key 完成 setup 或登录。
  4. 配置 CPA 地址、CPA Management Key 和请求采集。

v2 Beta 不提供 /management.html,访问返回 404,它不是 v2 入口。

CPA 端口上的轻量面板可以继续保留,但完整功能只从 Manager Server 面板入口使用。

常见问题 ​

  • 打不开面板:确认 secret-key 非空且 disable-control-panel 为 false。
  • 仍显示官方面板:检查 panel-github-repository 拼写并清理缓存。
  • 远程访问返回拒绝:检查 allow-remote、防火墙和反向代理。
  • 安装 v2 Beta 面板后又变回 1.x 界面:确认 disable-auto-update-panel: true;否则 CPA 会用 releases/latest 的 1.x 面板覆盖手动放置的文件。
  • 没有请求监控:这是轻量模式的预期行为;使用 Manager Server 面板。

Released under the MIT License.