docs: update CPA compose deployment guide#263
Open
xinxingi wants to merge 1 commit into
Open
Conversation
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.
There was a problem hiding this comment.
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.yamlexists as a file before running Compose. - Added a minimal
config.yamlexample 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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:

Summary by CodeRabbit