mirror of
https://github.com/router-for-me/CLIProxyAPIPlus.git
synced 2026-04-26 15:55:16 +00:00
docs: update README with new features and Docker deployment guide
This commit is contained in:
61
README.md
61
README.md
@@ -13,6 +13,67 @@ The Plus release stays in lockstep with the mainline features.
|
|||||||
- Added GitHub Copilot support (OAuth login), provided by [em4go](https://github.com/em4go/CLIProxyAPI/tree/feature/github-copilot-auth)
|
- Added GitHub Copilot support (OAuth login), provided by [em4go](https://github.com/em4go/CLIProxyAPI/tree/feature/github-copilot-auth)
|
||||||
- Added Kiro (AWS CodeWhisperer) support (OAuth login), provided by [fuko2935](https://github.com/fuko2935/CLIProxyAPI/tree/feature/kiro-integration), [Ravens2121](https://github.com/Ravens2121/CLIProxyAPIPlus/)
|
- Added Kiro (AWS CodeWhisperer) support (OAuth login), provided by [fuko2935](https://github.com/fuko2935/CLIProxyAPI/tree/feature/kiro-integration), [Ravens2121](https://github.com/Ravens2121/CLIProxyAPIPlus/)
|
||||||
|
|
||||||
|
## New Features (Plus Enhanced)
|
||||||
|
|
||||||
|
- **OAuth Web Authentication**: Browser-based OAuth login for Kiro with beautiful web UI
|
||||||
|
- **Rate Limiter**: Built-in request rate limiting to prevent API abuse
|
||||||
|
- **Background Token Refresh**: Automatic token refresh in background to avoid expiration
|
||||||
|
- **Metrics & Monitoring**: Request metrics collection for monitoring and debugging
|
||||||
|
- **Device Fingerprint**: Device fingerprint generation for enhanced security
|
||||||
|
- **Cooldown Management**: Smart cooldown mechanism for API rate limits
|
||||||
|
- **Usage Checker**: Real-time usage monitoring and quota management
|
||||||
|
- **Model Converter**: Unified model name conversion across providers
|
||||||
|
- **UTF-8 Stream Processing**: Improved streaming response handling
|
||||||
|
|
||||||
|
## Quick Deployment with Docker
|
||||||
|
|
||||||
|
### One-Command Deployment
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Create deployment directory
|
||||||
|
mkdir -p ~/cli-proxy && cd ~/cli-proxy
|
||||||
|
|
||||||
|
# Create docker-compose.yml
|
||||||
|
cat > docker-compose.yml << 'EOF'
|
||||||
|
services:
|
||||||
|
cli-proxy-api:
|
||||||
|
image: 17600006524/cli-proxy-api-plus:latest
|
||||||
|
container_name: cli-proxy-api-plus
|
||||||
|
ports:
|
||||||
|
- "8317:8317"
|
||||||
|
volumes:
|
||||||
|
- ./config.yaml:/CLIProxyAPI/config.yaml
|
||||||
|
- ./auths:/root/.cli-proxy-api
|
||||||
|
- ./logs:/CLIProxyAPI/logs
|
||||||
|
restart: unless-stopped
|
||||||
|
EOF
|
||||||
|
|
||||||
|
# Download example config
|
||||||
|
curl -o config.yaml https://raw.githubusercontent.com/linlang781/CLIProxyAPIPlus/main/config.example.yaml
|
||||||
|
|
||||||
|
# Pull and start
|
||||||
|
docker compose pull && docker compose up -d
|
||||||
|
```
|
||||||
|
|
||||||
|
### Configuration
|
||||||
|
|
||||||
|
Edit `config.yaml` before starting:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
# Basic configuration example
|
||||||
|
server:
|
||||||
|
port: 8317
|
||||||
|
|
||||||
|
# Add your provider configurations here
|
||||||
|
```
|
||||||
|
|
||||||
|
### Update to Latest Version
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cd ~/cli-proxy
|
||||||
|
docker compose pull && docker compose up -d
|
||||||
|
```
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
This project only accepts pull requests that relate to third-party provider support. Any pull requests unrelated to third-party provider support will be rejected.
|
This project only accepts pull requests that relate to third-party provider support. Any pull requests unrelated to third-party provider support will be rejected.
|
||||||
|
|||||||
61
README_CN.md
61
README_CN.md
@@ -13,6 +13,67 @@
|
|||||||
- 新增 GitHub Copilot 支持(OAuth 登录),由[em4go](https://github.com/em4go/CLIProxyAPI/tree/feature/github-copilot-auth)提供
|
- 新增 GitHub Copilot 支持(OAuth 登录),由[em4go](https://github.com/em4go/CLIProxyAPI/tree/feature/github-copilot-auth)提供
|
||||||
- 新增 Kiro (AWS CodeWhisperer) 支持 (OAuth 登录), 由[fuko2935](https://github.com/fuko2935/CLIProxyAPI/tree/feature/kiro-integration)、[Ravens2121](https://github.com/Ravens2121/CLIProxyAPIPlus/)提供
|
- 新增 Kiro (AWS CodeWhisperer) 支持 (OAuth 登录), 由[fuko2935](https://github.com/fuko2935/CLIProxyAPI/tree/feature/kiro-integration)、[Ravens2121](https://github.com/Ravens2121/CLIProxyAPIPlus/)提供
|
||||||
|
|
||||||
|
## 新增功能 (Plus 增强版)
|
||||||
|
|
||||||
|
- **OAuth Web 认证**: 基于浏览器的 Kiro OAuth 登录,提供美观的 Web UI
|
||||||
|
- **请求限流器**: 内置请求限流,防止 API 滥用
|
||||||
|
- **后台令牌刷新**: 自动后台刷新令牌,避免过期
|
||||||
|
- **监控指标**: 请求指标收集,用于监控和调试
|
||||||
|
- **设备指纹**: 设备指纹生成,增强安全性
|
||||||
|
- **冷却管理**: 智能冷却机制,应对 API 速率限制
|
||||||
|
- **用量检查器**: 实时用量监控和配额管理
|
||||||
|
- **模型转换器**: 跨供应商的统一模型名称转换
|
||||||
|
- **UTF-8 流处理**: 改进的流式响应处理
|
||||||
|
|
||||||
|
## Docker 快速部署
|
||||||
|
|
||||||
|
### 一键部署
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 创建部署目录
|
||||||
|
mkdir -p ~/cli-proxy && cd ~/cli-proxy
|
||||||
|
|
||||||
|
# 创建 docker-compose.yml
|
||||||
|
cat > docker-compose.yml << 'EOF'
|
||||||
|
services:
|
||||||
|
cli-proxy-api:
|
||||||
|
image: 17600006524/cli-proxy-api-plus:latest
|
||||||
|
container_name: cli-proxy-api-plus
|
||||||
|
ports:
|
||||||
|
- "8317:8317"
|
||||||
|
volumes:
|
||||||
|
- ./config.yaml:/CLIProxyAPI/config.yaml
|
||||||
|
- ./auths:/root/.cli-proxy-api
|
||||||
|
- ./logs:/CLIProxyAPI/logs
|
||||||
|
restart: unless-stopped
|
||||||
|
EOF
|
||||||
|
|
||||||
|
# 下载示例配置
|
||||||
|
curl -o config.yaml https://raw.githubusercontent.com/linlang781/CLIProxyAPIPlus/main/config.example.yaml
|
||||||
|
|
||||||
|
# 拉取并启动
|
||||||
|
docker compose pull && docker compose up -d
|
||||||
|
```
|
||||||
|
|
||||||
|
### 配置说明
|
||||||
|
|
||||||
|
启动前请编辑 `config.yaml`:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
# 基本配置示例
|
||||||
|
server:
|
||||||
|
port: 8317
|
||||||
|
|
||||||
|
# 在此添加你的供应商配置
|
||||||
|
```
|
||||||
|
|
||||||
|
### 更新到最新版本
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cd ~/cli-proxy
|
||||||
|
docker compose pull && docker compose up -d
|
||||||
|
```
|
||||||
|
|
||||||
## 贡献
|
## 贡献
|
||||||
|
|
||||||
该项目仅接受第三方供应商支持的 Pull Request。任何非第三方供应商支持的 Pull Request 都将被拒绝。
|
该项目仅接受第三方供应商支持的 Pull Request。任何非第三方供应商支持的 Pull Request 都将被拒绝。
|
||||||
|
|||||||
Reference in New Issue
Block a user