From f69eb3acae52c14508d4012f8216466d835bd999 Mon Sep 17 00:00:00 2001 From: hex2077 Date: Sat, 3 Jan 2026 19:30:25 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E6=9B=B4=E6=96=B0=E5=A4=9A=E8=AF=AD?= =?UTF-8?q?=E8=A8=80README=E6=96=87=E4=BB=B6=E7=BB=93=E6=9E=84=E5=92=8C?= =?UTF-8?q?=E5=AF=BC=E8=88=AA=E5=86=85=E5=AE=B9?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 重构README文件结构，优化导航菜单并添加新章节 统一各语言版本的高级配置标题层级 添加授权配置指南和Ollama协议使用示例等新内容 --- README-JA.md | 18 ++++++++++++------ README-ZH.md | 18 ++++++++++++------ README.md | 18 ++++++++++++------ 3 files changed, 36 insertions(+), 18 deletions(-) diff --git a/README-JA.md b/README-JA.md index 4ebd9c7..06e2b50 100644 --- a/README-JA.md +++ b/README-JA.md @@ -78,8 +78,14 @@ ## 📑 クイックナビゲーション -- [🐳 Docker デプロイ](https://hub.docker.com/r/justlikemaki/aiclient-2-api) -- [🔧 使用方法](#-使用方法) +- [💡 コアアドバンテージ](#-コアアドバンテージ) +- [🚀 クイックスタート](#-クイックスタート) + - [🐳 Docker デプロイ](https://hub.docker.com/r/justlikemaki/aiclient-2-api) + - [📋 コア機能](#-コア機能) +- [🔐 認証設定ガイド](#-認証設定ガイド) +- [⚙️ 高度な設定](#高度な設定) +- [📁 認証ファイル保存パス](#-認証ファイル保存パス) +- [🦙 Ollamaプロトコル使用例](#-ollamaプロトコル使用例) - [❓ よくある質問](#-よくある質問) - [📄 オープンソースライセンス](#-オープンソースライセンス) - [🙏 謝辞](#-謝辞) @@ -224,9 +230,9 @@ Web UI管理インターフェースでは、極めて迅速に認証設定を 3. **起動パラメータ設定**：`--provider-pools-file ` パラメータを使用してプール設定ファイルのパスを指定します 4. **ヘルスチェック**：システムは定期的にヘルスチェックを自動実行し、健全でないプロバイダーを使用しません -#### 高度な設定 +### 高度な設定 -##### 1. プロキシ設定 +#### 1. プロキシ設定 本プロジェクトは柔軟なプロキシ設定をサポートしており、異なるプロバイダーに統一プロキシを設定したり、プロバイダー独自のプロキシ済みエンドポイントを使用したりできます。 @@ -280,7 +286,7 @@ Web UI管理インターフェースでは、極めて迅速に認証設定を - プロキシサービスが安定して利用可能であることを確認してください。そうでない場合、サービス品質に影響する可能性があります - SOCKS5プロキシは通常、HTTPプロキシよりもパフォーマンスが優れています -##### 2. モデルフィルタリング設定 +#### 2. モデルフィルタリング設定 `notSupportedModels` 設定を通じてサポートされていないモデルを除外でき、システムは自動的にこれらのプロバイダーをスキップします。 @@ -306,7 +312,7 @@ Web UI管理インターフェースでは、極めて迅速に認証設定を - 一部のアカウントは割り当てまたは権限の制限により特定のモデルにアクセスできない - 異なるアカウントに異なるモデルアクセス権限を割り当てる必要がある -##### 3. クロスタイプフォールバック設定 +#### 3. クロスタイプフォールバック設定 あるProvider Type（例：`gemini-cli-oauth`）のすべてのアカウントが429割り当て制限により枯渇したり、unhealthyとマークされた場合、システムは直接エラーを返すのではなく、互換性のある別のProvider Type（例：`gemini-antigravity`）に自動的にフォールバックできます。 diff --git a/README-ZH.md b/README-ZH.md index 75e8939..b9d5408 100644 --- a/README-ZH.md +++ b/README-ZH.md @@ -77,8 +77,14 @@ ## 📑 快速导航 -- [🐳 Docker 部署](https://hub.docker.com/r/justlikemaki/aiclient-2-api) -- [🔧 使用说明](#-使用说明) +- [💡 核心优势](#-核心优势) +- [🚀 快速启动](#-快速启动) + - [🐳 Docker 部署](https://hub.docker.com/r/justlikemaki/aiclient-2-api) + - [📋 核心功能](#-核心功能) +- [🔐 授权配置指南](#-授权配置指南) +- [⚙️ 高级配置](#高级配置) +- [📁 授权文件存储路径](#-授权文件存储路径) +- [🦙 Ollama 协议使用示例](#-ollama-协议使用示例) - [❓ 常见问题](#-常见问题) - [📄 开源许可](#-开源许可) - [🙏 致谢](#-致谢) @@ -223,9 +229,9 @@ docker run -d -p 3000:3000 -p 8085:8085 -p 8086:8086 -p 19876-19880:19876-19880 3. **启动参数配置**：使用 `--provider-pools-file ` 参数指定号池配置文件路径 4. **健康检查**：系统会定期自动执行健康检查，不使用不健康的提供商 -#### 高级配置 +### 高级配置 -##### 3. 代理配置 +#### 1. 代理配置 本项目支持灵活的代理配置，可以为不同的提供商配置统一代理或使用提供商自带的已代理端点。 @@ -279,7 +285,7 @@ docker run -d -p 3000:3000 -p 8085:8085 -p 8086:8086 -p 19876-19880:19876-19880 - 确保代理服务稳定可用，否则可能影响服务质量 - SOCKS5 代理通常比 HTTP 代理性能更好 -##### 2. 模型过滤配置 +#### 2. 模型过滤配置 支持通过 `notSupportedModels` 配置排除不支持的模型，系统会自动跳过这些提供商。 @@ -305,7 +311,7 @@ docker run -d -p 3000:3000 -p 8085:8085 -p 8086:8086 -p 19876-19880:19876-19880 - 某些账号因配额或权限限制无法访问特定模型 - 需要为不同账号分配不同的模型访问权限 -##### 3. 跨类型 Fallback 配置 +#### 3. 跨类型 Fallback 配置 当某一 Provider Type（如 `gemini-cli-oauth`）下的所有账号都因 429 配额耗尽或被标记为 unhealthy 时，系统能够自动 fallback 到另一个兼容的 Provider Type（如 `gemini-antigravity`），而不是直接返回错误。 diff --git a/README.md b/README.md index 7c9813e..44fef34 100644 --- a/README.md +++ b/README.md @@ -78,8 +78,14 @@ ## 📑 Quick Navigation -- [🐳 Docker Deployment](https://hub.docker.com/r/justlikemaki/aiclient-2-api) -- [🔧 Usage Instructions](#-usage-instructions) +- [💡 Core Advantages](#-core-advantages) +- [🚀 Quick Start](#-quick-start) + - [🐳 Docker Deployment](https://hub.docker.com/r/justlikemaki/aiclient-2-api) + - [📋 Core Features](#-core-features) +- [🔐 Authorization Configuration Guide](#-authorization-configuration-guide) +- [⚙️ Advanced Configuration](#advanced-configuration) +- [📁 Authorization File Storage Paths](#-authorization-file-storage-paths) +- [🦙 Ollama Protocol Usage Examples](#-ollama-protocol-usage-examples) - [❓ FAQ](#-faq) - [📄 Open Source License](#-open-source-license) - [🙏 Acknowledgements](#-acknowledgements) @@ -224,9 +230,9 @@ In the Web UI management interface, you can complete authorization configuration 3. **Startup Parameter Configuration**: Use the `--provider-pools-file ` parameter to specify the pool configuration file path 4. **Health Check**: The system will automatically perform periodic health checks and avoid using unhealthy providers -#### Advanced Configuration +### Advanced Configuration -##### 1. Proxy Configuration +#### 1. Proxy Configuration This project supports flexible proxy configuration, allowing you to configure a unified proxy for different providers or use provider-specific proxied endpoints. @@ -280,7 +286,7 @@ This project supports flexible proxy configuration, allowing you to configure a - Ensure the proxy service is stable and available, otherwise it may affect service quality - SOCKS5 proxy usually performs better than HTTP proxy -##### 2. Model Filtering Configuration +#### 2. Model Filtering Configuration Support excluding unsupported models through `notSupportedModels` configuration, the system will automatically skip these providers. @@ -306,7 +312,7 @@ Support excluding unsupported models through `notSupportedModels` configuration, - Some accounts cannot access specific models due to quota or permission restrictions - Need to assign different model access permissions to different accounts -##### 3. Cross-Type Fallback Configuration +#### 3. Cross-Type Fallback Configuration When all accounts under a Provider Type (e.g., `gemini-cli-oauth`) are exhausted due to 429 quota limits or marked as unhealthy, the system can automatically fallback to another compatible Provider Type (e.g., `gemini-antigravity`) instead of returning an error directly.