Skip to content

docs: update CPA compose deployment guide#263

Open
xinxingi wants to merge 1 commit into
seakee:mainfrom
xinxingi:xinxingi-patch-1
Open

docs: update CPA compose deployment guide#263
xinxingi wants to merge 1 commit into
seakee:mainfrom
xinxingi:xinxingi-patch-1

Conversation

@xinxingi

Copy link
Copy Markdown

Use bind-mounted CPA config, auth, and log paths for the CPA + CPAMP Compose example.

Add setup commands for required host directories and config.yaml, plus a minimal CPA Management API config needed before running docker compose.

If the following configuration is not performed, the following will be obtained:
image

Summary by CodeRabbit

  • Documentation
    • Updated the Docker Compose setup guide for deploying CPA and CPAMP together.
    • Added clearer pre-start steps to create required host folders and configuration files before running Compose.
    • Expanded the sample configuration with the minimum settings needed for API access.
    • Reworked the example to use explicit service names and host-mounted paths for easier setup and persistence.

Use bind-mounted CPA config, auth, and log paths for the CPA + CPAMP Compose example.

Add setup commands for required host directories and config.yaml, plus a minimal CPA Management API config needed before running docker compose.
Copilot AI review requested due to automatic review settings June 30, 2026 04:40

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the Compose deployment documentation for running CPA (CLIProxyAPI) together with CPA Manager Plus (CPAMP), switching from named volumes to bind-mounted host paths and adding pre-start setup/config steps so the stack boots cleanly and CPAMP can reach CPA’s management API.

Changes:

  • Updated the Compose example to use explicit service container names, depends_on, and bind-mounted host paths for CPA config/auth/logs and CPAMP data.
  • Added pre-start commands to create required host directories and ensure config.yaml exists as a file before running Compose.
  • Added a minimal config.yaml example enabling CPA remote management and API keys for CPAMP connectivity.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
README.md Updates the English Compose deployment guide with bind mounts + minimal CPA config and setup steps.
README_CN.md Mirrors the same Compose guide updates in Chinese.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md
Comment thread README_CN.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants