diff --git a/apps/cliproxyapi-plus/6.9.5-0/data.yml b/apps/cliproxyapi-plus/6.9.9-0/data.yml similarity index 65% rename from apps/cliproxyapi-plus/6.9.5-0/data.yml rename to apps/cliproxyapi-plus/6.9.9-0/data.yml index bb34142..2cf7d9e 100644 --- a/apps/cliproxyapi-plus/6.9.5-0/data.yml +++ b/apps/cliproxyapi-plus/6.9.9-0/data.yml @@ -2,49 +2,49 @@ additionalProperties: formFields: - default: 8317 edit: true - envKey: PANEL_APP_PORT_8317 - labelEn: Port 8317 - labelZh: 端口 8317 + envKey: PANEL_APP_PORT_HTTP + labelEn: Web UI Port + labelZh: Web界面端口 required: true rule: paramPort type: number - default: 8085 edit: true - envKey: PANEL_APP_PORT_8085 - labelEn: Port 8085 - labelZh: 端口 8085 + envKey: PANEL_APP_PORT_PROXY + labelEn: Proxy Port + labelZh: 代理端口 required: true rule: paramPort type: number - default: 1455 edit: true envKey: PANEL_APP_PORT_1455 - labelEn: Port 1455 - labelZh: 端口 1455 + labelEn: Additional Port 1455 + labelZh: 额外端口 1455 required: true rule: paramPort type: number - default: 54545 edit: true envKey: PANEL_APP_PORT_54545 - labelEn: Port 54545 - labelZh: 端口 54545 + labelEn: Additional Port 54545 + labelZh: 额外端口 54545 required: true rule: paramPort type: number - default: 51121 edit: true envKey: PANEL_APP_PORT_51121 - labelEn: Port 51121 - labelZh: 端口 51121 + labelEn: Additional Port 51121 + labelZh: 额外端口 51121 required: true rule: paramPort type: number - default: 11451 edit: true envKey: PANEL_APP_PORT_11451 - labelEn: Port 11451 - labelZh: 端口 11451 + labelEn: Additional Port 11451 + labelZh: 额外端口 11451 required: true rule: paramPort type: number @@ -54,4 +54,4 @@ additionalProperties: labelEn: Time Zone labelZh: 时区 required: true - type: text \ No newline at end of file + type: text diff --git a/apps/cliproxyapi-plus/6.9.9-0/data/.gitkeep b/apps/cliproxyapi-plus/6.9.9-0/data/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/apps/cliproxyapi-plus/6.9.5-0/data/config.yaml b/apps/cliproxyapi-plus/6.9.9-0/data/config.yaml similarity index 100% rename from apps/cliproxyapi-plus/6.9.5-0/data/config.yaml rename to apps/cliproxyapi-plus/6.9.9-0/data/config.yaml diff --git a/apps/cliproxyapi-plus/6.9.5-0/docker-compose.yml b/apps/cliproxyapi-plus/6.9.9-0/docker-compose.yml similarity index 55% rename from apps/cliproxyapi-plus/6.9.5-0/docker-compose.yml rename to apps/cliproxyapi-plus/6.9.9-0/docker-compose.yml index 4700d8b..7ed584d 100644 --- a/apps/cliproxyapi-plus/6.9.5-0/docker-compose.yml +++ b/apps/cliproxyapi-plus/6.9.9-0/docker-compose.yml @@ -1,17 +1,17 @@ services: cliproxyapi-plus: - image: eceasy/cli-proxy-api-plus:v6.9.5-0 + image: eceasy/cli-proxy-api-plus:v6.9.9-0 container_name: ${CONTAINER_NAME} restart: always networks: - 1panel-network ports: - - ${PANEL_APP_PORT_8317}:8317 - - ${PANEL_APP_PORT_8085}:8085 - - ${PANEL_APP_PORT_1455}:1455 - - ${PANEL_APP_PORT_54545}:54545 - - ${PANEL_APP_PORT_51121}:51121 - - ${PANEL_APP_PORT_11451}:11451 + - "${PANEL_APP_PORT_HTTP}:8317" + - "${PANEL_APP_PORT_PROXY}:8085" + - "${PANEL_APP_PORT_1455}:1455" + - "${PANEL_APP_PORT_54545}:54545" + - "${PANEL_APP_PORT_51121}:51121" + - "${PANEL_APP_PORT_11451}:11451" volumes: - ./data/config.yaml:/CLIProxyAPI/config.yaml - ./data/auths:/root/.cli-proxy-api @@ -23,4 +23,4 @@ services: networks: 1panel-network: - external: true \ No newline at end of file + external: true diff --git a/apps/cliproxyapi-plus/README.md b/apps/cliproxyapi-plus/README.md index 67ce9c9..afa1881 100644 --- a/apps/cliproxyapi-plus/README.md +++ b/apps/cliproxyapi-plus/README.md @@ -1,29 +1,105 @@ # CLIProxyAPI Plus -CLIProxyAPI Plus 代理API服务,基于主线项目添加第三方提供商支持。 +CLIProxyAPI Plus 是 CLIProxyAPI 的增强版本,在主线项目基础上添加了第三方提供商支持。所有第三方提供商支持由社区贡献者维护。 ## 功能特点 -- 支持多种代理协议 -- 支持第三方提供商 -- 高性能设计 -- 易于部署和使用 +- 支持多种 AI 模型提供商(Claude、Gemini、Codex、Qwen 等) +- 支持第三方提供商扩展 +- OAuth 认证支持 +- 高性能代理设计 +- Web 管理界面 +- 灵活的路由和负载均衡策略 ## 使用说明 ### 默认端口 -- Web 界面: 8317 -- API 端口: 8085 -- 其他端口: 1455, 54545, 51121, 11451 +- **Web UI 端口 (8317)**: 主要的 Web 管理界面和 API 端口 + - Web 管理界面: `http://localhost:8317/management.html` + - API 端点: `http://localhost:8317/v1` +- **代理端口 (8085)**: 代理服务端口 +- **额外端口**: 1455, 54545, 51121, 11451(用于特定功能扩展) -### 数据目录 +### Web 管理界面 + +部署后,访问 Web 管理界面需要以下步骤: + +1. **编辑配置文件** `./data/config.yaml` + - 将 `remote-management.allow-remote` 设置为 `true` 以允许远程访问 + - 设置 `remote-management.secret-key` 为您的管理密钥 + +2. **访问地址**(替换为您的服务器 IP): + +``` +http://your-server-ip:8317/management.html +``` + +**注意**:默认 `allow-remote` 为 `false`,仅允许本地访问。如需从其他机器访问,请务必设置为 `true` 并配置强密码。 + +### 配置文件 应用数据存储在 `./data` 目录,包含: -- `config.yaml` - 配置文件 -- `auths/` - 认证信息目录 -- `logs/` - 日志目录 + +- `config.yaml` - 主配置文件 + - API 密钥配置 + - 提供商设置 + - 路由策略 + - 代理设置 +- `auths/` - OAuth 认证信息存储目录 +- `logs/` - 应用日志目录 + +### 快速配置 + +1. 编辑 `./data/config.yaml` 文件 +2. 在 `api-keys` 部分添加您的 API 密钥 +3. 如需远程访问,设置 `remote-management.allow-remote: true` 和 `remote-management.secret-key` +4. 根据需要配置各个提供商(Claude、Gemini、Codex 等) +5. 重启应用使配置生效 + +### 主要配置项 + +```yaml +# API 密钥 +api-keys: + - 'your-api-key-1' + - 'your-api-key-2' + +# 管理界面设置 +remote-management: + allow-remote: false # 是否允许远程管理,true=允许,false=仅本地 + secret-key: '' # 管理密钥(首次启动后会被哈希) + disable-control-panel: false + +# 代理设置 +proxy-url: "" # 全局代理 URL + +# 路由策略 +routing: + strategy: 'round-robin' # round-robin 或 fill-first +``` + +## 版本说明 + +- **latest**: 最新开发版本 +- **6.9.9-0**: 最新稳定版本(推荐) ## 相关链接 -- GitHub: https://github.com/router-for-me/CLIProxyAPIPlus \ No newline at end of file +- 官方文档: https://help.router-for.me/cn/introduction/quick-start.html +- Web UI 文档: https://help.router-for.me/cn/management/webui.html +- GitHub: https://github.com/router-for-me/CLIProxyAPIPlus +- 问题反馈: https://github.com/router-for-me/CLIProxyAPIPlus/issues + +## 注意事项 + +1. 首次部署后请及时修改 `api-keys` 和管理密钥 +2. 如需远程访问,请设置 `allow-remote: true` 并配置强密码 +3. 生产环境建议在使用完毕后将 `allow-remote` 改回 `false` 以提高安全性 +4. 如需使用 OAuth 认证,请确保 `auths/` 目录有正确的读写权限 +5. 生产环境建议配置 TLS 加密 + +## 技术支持 + +- 主线项目问题: 请在主线仓库提交 Issue +- Plus 版本第三方提供商问题: 请联系相应的社区维护者 diff --git a/apps/cliproxyapi-plus/README_en.md b/apps/cliproxyapi-plus/README_en.md index 9dc3bc7..3602048 100644 --- a/apps/cliproxyapi-plus/README_en.md +++ b/apps/cliproxyapi-plus/README_en.md @@ -1,29 +1,105 @@ # CLIProxyAPI Plus -CLIProxyAPI Plus proxy API service with third-party provider support based on the mainline project. +CLIProxyAPI Plus is an enhanced version of CLIProxyAPI, adding support for third-party providers on top of the mainline project. All third-party provider support is maintained by community contributors. ## Features -- Support multiple proxy protocols -- Support third-party providers -- High performance design -- Easy to deploy and use +- Support for multiple AI model providers (Claude, Gemini, Codex, Qwen, etc.) +- Third-party provider extensions +- OAuth authentication support +- High-performance proxy design +- Web management interface +- Flexible routing and load balancing strategies ## Usage ### Default Ports -- Web UI: 8317 -- API Port: 8085 -- Other Ports: 1455, 54545, 51121, 11451 +- **Web UI Port (8317)**: Primary Web management interface and API port + - Web Management UI: `http://localhost:8317/management.html` + - API Endpoint: `http://localhost:8317/v1` +- **Proxy Port (8085)**: Proxy service port +- **Additional Ports**: 1455, 54545, 51121, 11451 (for specific feature extensions) -### Data Directory +### Web Management Interface + +To access the Web management interface after deployment: + +1. **Edit config file** `./data/config.yaml` + - Set `remote-management.allow-remote` to `true` to allow remote access + - Set `remote-management.secret-key` to your management secret + +2. **Access URL** (replace with your server IP): + +``` +http://your-server-ip:8317/management.html +``` + +**Note**: Default `allow-remote` is `false`, only local access is allowed. To access from other machines, please set to `true` and configure a strong password. + +### Configuration Files Application data is stored in the `./data` directory: -- `config.yaml` - Configuration file -- `auths/` - Authentication directory -- `logs/` - Logs directory + +- `config.yaml` - Main configuration file + - API key configuration + - Provider settings + - Routing strategy + - Proxy settings +- `auths/` - OAuth authentication storage directory +- `logs/` - Application logs directory + +### Quick Configuration + +1. Edit the `./data/config.yaml` file +2. Add your API keys in the `api-keys` section +3. For remote access, set `remote-management.allow-remote: true` and `remote-management.secret-key` +4. Configure providers as needed (Claude, Gemini, Codex, etc.) +5. Restart the application for changes to take effect + +### Key Configuration Items + +```yaml +# API Keys +api-keys: + - 'your-api-key-1' + - 'your-api-key-2' + +# Management interface settings +remote-management: + allow-remote: false # Allow remote management, true=allow, false=local only + secret-key: '' # Management key (will be hashed after first startup) + disable-control-panel: false + +# Proxy settings +proxy-url: "" # Global proxy URL + +# Routing strategy +routing: + strategy: 'round-robin' # round-robin or fill-first +``` + +## Version Information + +- **latest**: Latest development version +- **6.9.9-0**: Latest stable version (recommended) ## Links -- GitHub: https://github.com/router-for-me/CLIProxyAPIPlus \ No newline at end of file +- Official Documentation: https://help.router-for.me/cn/introduction/quick-start.html +- Web UI Documentation: https://help.router-for.me/cn/management/webui.html +- GitHub: https://github.com/router-for-me/CLIProxyAPIPlus +- Issue Tracker: https://github.com/router-for-me/CLIProxyAPIPlus/issues + +## Important Notes + +1. Please modify `api-keys` and management key promptly after first deployment +2. For remote access, set `allow-remote: true` and configure a strong password +3. In production, it's recommended to set `allow-remote` back to `false` after use for better security +4. For OAuth authentication, ensure the `auths/` directory has proper read/write permissions +5. TLS encryption is recommended for production environments + +## Support + +- Mainline project issues: Please submit issues to the mainline repository +- Plus version third-party provider issues: Please contact the corresponding community maintainer diff --git a/apps/cliproxyapi-plus/data.yml b/apps/cliproxyapi-plus/data.yml index aeebfeb..2181648 100644 --- a/apps/cliproxyapi-plus/data.yml +++ b/apps/cliproxyapi-plus/data.yml @@ -18,7 +18,7 @@ additionalProperties: recommend: 0 website: https://github.com/router-for-me/CLIProxyAPIPlus github: https://github.com/router-for-me/CLIProxyAPIPlus - document: https://github.com/router-for-me/CLIProxyAPIPlus + document: https://help.router-for.me/cn/introduction/quick-start.html architectures: - amd64 - - arm64 \ No newline at end of file + - arm64 diff --git a/apps/cliproxyapi-plus/latest/data.yml b/apps/cliproxyapi-plus/latest/data.yml index bb34142..23a05df 100644 --- a/apps/cliproxyapi-plus/latest/data.yml +++ b/apps/cliproxyapi-plus/latest/data.yml @@ -2,49 +2,49 @@ additionalProperties: formFields: - default: 8317 edit: true - envKey: PANEL_APP_PORT_8317 - labelEn: Port 8317 - labelZh: 端口 8317 + envKey: PANEL_APP_PORT_HTTP + labelEn: Web UI Port + labelZh: Web界面端口 required: true rule: paramPort type: number - default: 8085 edit: true - envKey: PANEL_APP_PORT_8085 - labelEn: Port 8085 - labelZh: 端口 8085 + envKey: PANEL_APP_PORT_PROXY + labelEn: Proxy Port + labelZh: 代理端口 required: true rule: paramPort type: number - default: 1455 edit: true envKey: PANEL_APP_PORT_1455 - labelEn: Port 1455 - labelZh: 端口 1455 + labelEn: Additional Port 1455 + labelZh: 额外端口 1455 required: true rule: paramPort type: number - default: 54545 edit: true envKey: PANEL_APP_PORT_54545 - labelEn: Port 54545 - labelZh: 端口 54545 + labelEn: Additional Port 54545 + labelZh: 额外端口 54545 required: true rule: paramPort type: number - default: 51121 edit: true envKey: PANEL_APP_PORT_51121 - labelEn: Port 51121 - labelZh: 端口 51121 + labelEn: Additional Port 51121 + labelZh: 额外端口 51121 required: true rule: paramPort type: number - default: 11451 edit: true envKey: PANEL_APP_PORT_11451 - labelEn: Port 11451 - labelZh: 端口 11451 + labelEn: Additional Port 11451 + labelZh: 额外端口 11451 required: true rule: paramPort type: number diff --git a/apps/cliproxyapi-plus/latest/docker-compose.yml b/apps/cliproxyapi-plus/latest/docker-compose.yml index e4f0ceb..d3ea0a9 100644 --- a/apps/cliproxyapi-plus/latest/docker-compose.yml +++ b/apps/cliproxyapi-plus/latest/docker-compose.yml @@ -6,12 +6,12 @@ services: networks: - 1panel-network ports: - - ${PANEL_APP_PORT_8317}:8317 - - ${PANEL_APP_PORT_8085}:8085 - - ${PANEL_APP_PORT_1455}:1455 - - ${PANEL_APP_PORT_54545}:54545 - - ${PANEL_APP_PORT_51121}:51121 - - ${PANEL_APP_PORT_11451}:11451 + - "${PANEL_APP_PORT_HTTP}:8317" + - "${PANEL_APP_PORT_PROXY}:8085" + - "${PANEL_APP_PORT_1455}:1455" + - "${PANEL_APP_PORT_54545}:54545" + - "${PANEL_APP_PORT_51121}:51121" + - "${PANEL_APP_PORT_11451}:11451" volumes: - ./data/config.yaml:/CLIProxyAPI/config.yaml - ./data/auths:/root/.cli-proxy-api