v2 Beta — prerelease documentation. Read 1.x Stable documentation
Skip to content

Quick Start ​

Choose a path based on what you need. Both use the CPAMP interface, but installation and available capabilities differ.

Your situationRecommended path
CPA already runs and you only want a clearer management UICPAMP Lightweight Panel
You need request history, cost analytics, inspection, or automationCPAMP Full Mode
You are not sureRead Choosing A Panel

Path 1: Install Lightweight Panel ​

Use this when CPA already runs and you only want to replace the official Management Center. It needs no additional service, database, or port.

  1. Set CPA panel-github-repository to seakee/CPA-Manager-Plus.
  2. Restart or reload CPA.
  3. Open:
text
http://<cpa-host>:8317/management.html

Log in with the CPA Management Key. See Install Lightweight Panel for the complete configuration and update instructions.

Path 2: Install Full Mode ​

Full Mode runs Manager Server for request history, cost analytics, server-side inspection, and automation. The installer is the recommended path for most users:

bash
curl -fsSLO https://raw.githubusercontent.com/seakee/CPA-Manager-Plus/main/bin/install-cpamp.sh
bash install-cpamp.sh

In the installer:

  1. Install scope: choose “CPA + CPAMP” if CPA is not installed, or “CPAMP only” if CPA already runs.
  2. Deployment method: prefer Docker, or choose a native package when Docker is not used.
  3. Review the summary and confirm deployment.

After installation, open (1.x Stable):

text
http://<host>:18317/management.html

Log in with the CPAMP Admin Key saved or printed by the installer. See Install Full Mode for details.

bin/install-cpamp.sh installs 1.x Stable by default, and its entry is the :18317/management.html URL above. For v2 Beta, install from v2 Docker or the linux/amd64 native package; the v2 browser entry is the control base path chosen at installation (the wizard defaults to /console, for example http://<host>:18317/console), and :18317/management.html returns 404 in v2.

First CPA Connection ​

If the installer did not save a CPA connection, enter these values when Full Mode opens for the first time:

  1. CPAMP Admin Key.
  2. CPA URL, for example http://cli-proxy-api:8317.
  3. CPA Management Key.
  4. Keep request monitoring in the default automatic mode.

Confirm That It Works ​

Lightweight Panel ​

  • You can log in with the CPA Management Key.
  • CPA management features such as providers, Accounts, OAuth, logs, and plugins load normally.
  • The page remains on CPA :8317/management.html.

Full Mode ​

  • 1.x Stable: you can log in to :18317/management.html with the CPAMP Admin Key.
  • v2 Beta: you can open the control base path shown on the wizard's completion page (default /console, for example http://<host>:18317/console) and log in; :18317/management.html returning 404 is expected.
  • Dashboard shows that CPA is connected.
  • Monitoring shows an event after a real request passes through CPA.
  • Usage Analytics shows the corresponding tokens and estimated cost.

If Full Mode opens but has no request data, see Monitoring Has No Data.

What To Do Next ​

Released under the MIT License.