更新说明

Author: su-kaka

.env.example

@@ -37,7 +37,26 @@ PASSWORD=pwd
 # 存储配置
 # ================================================================
 
-# MongoDB 分布式存储模式配置
+# 存储后端优先级: Redis > MongoDB > 本地文件存储
+# 系统会自动选择可用的最高优先级存储后端
+
+# Redis 分布式存储模式配置 (最高优先级)
+# 设置 REDIS_URI 后自动启用 Redis 模式，性能最佳
+
+# Redis 连接字符串 (设置后启用 Redis 分布式存储模式)
+# 本地 Redis: redis://localhost:6379
+# 带密码: redis://:password@localhost:6379
+# SSL 连接: rediss://default:password@host:6380
+# Upstash Redis: rediss://default:token@host:6379
+# 默认: 无 (尝试下一个存储后端)
+REDIS_URI=redis://localhost:6379
+
+# Redis 数据库索引 (仅在启用 Redis 模式时有效)
+# 可选范围: 0-15
+# 默认: 0
+REDIS_DATABASE=0
+
+# MongoDB 分布式存储模式配置 (第二优先级)
 # 设置 MONGODB_URI 后自动启用 MongoDB 模式，不再使用本地文件存储
 
 # MongoDB 连接字符串 (设置后启用 MongoDB 分布式存储模式)
@@ -78,18 +97,6 @@ AUTO_LOAD_ENV_CREDS=false
 # 默认: 100
 CALLS_PER_ROTATION=100
 
-# ================================================================
-# 网络配置
-# ================================================================
-
-# HTTP 请求超时时间 (秒)
-# 默认: 30.0
-HTTP_TIMEOUT=30.0
-
-# 最大连接数
-# 默认: 100
-MAX_CONNECTIONS=100
-
 # 代理配置 (可选)
 # 支持 http, https, socks5 代理
 # 格式: http://proxy:port, https://proxy:port, socks5://proxy:port
@@ -167,15 +174,16 @@ ANTI_TRUNCATION_MAX_ATTEMPTS=3
 # 环境变量使用说明
 # ================================================================
 
-# 1. 存储模式配置:
-#    - 文件存储模式 (默认): 不设置 MONGODB_URI，数据存储在本地 creds/ 目录
-#    - MongoDB 分布式模式: 设置 MONGODB_URI，数据存储在 MongoDB 数据库
-#    - 自动切换: 系统根据 MONGODB_URI 是否设置自动选择存储模式
+# 1. 存储模式配置 (按优先级自动选择):
+#    - Redis 分布式模式 (最高优先级): 设置 REDIS_URI，数据存储在 Redis 数据库，性能最佳
+#    - MongoDB 分布式模式 (第二优先级): 设置 MONGODB_URI，数据存储在 MongoDB 数据库
+#    - 文件存储模式 (默认): 不设置上述 URI，数据存储在本地 creds/ 目录
+#    - 自动切换: 系统根据可用的存储配置自动选择最高优先级的存储后端
 
 # 2. 凭证配置方式 (三选一):
 #    a) 将 Google 凭证 JSON 文件放在 CREDENTIALS_DIR 目录中 (仅文件模式)
-#    b) 通过 GOOGLE_CREDENTIALS 等环境变量直接提供
-#    c) 设置 AUTO_LOAD_ENV_CREDS=true 自动从环境变量加载
+#    b) 设置 AUTO_LOAD_ENV_CREDS=true，通过 GOOGLE_CREDENTIALS 等环境变量直接提供
+#    c) 通过面板导入
 
 # 3. 密码配置优先级:
 #    a) PASSWORD 环境变量 (最高优先级，设置后覆盖其他密码)
@@ -205,25 +213,13 @@ ANTI_TRUNCATION_MAX_ATTEMPTS=3
 #    - 假流式/gemini-2.5-pro-maxthinking
 #    - 流式抗截断/gemini-2.5-flash-search
 
-# 8. MongoDB 分布式存储模式:
-#    - 启用方法: 设置 MONGODB_URI 环境变量
-#    - 数据迁移: 使用 python mongodb_setup.py migrate 命令
-#    - 管理工具: 使用 python mongodb_setup.py 交互式界面
-#    - 适用场景: 多实例部署、集群环境、大规模凭证管理
-#    - 性能优势: 查询速度提升40-70%，支持高并发访问
-
 # ================================================================
 # 配置文件说明
 # ================================================================
 
 # 除了环境变量，你还可以使用 TOML 配置文件进行配置
 # 配置文件位置: {CREDENTIALS_DIR}/config.toml
 # 
-# 示例 config.toml 内容:
-# # MongoDB 分布式存储配置
-# mongodb_uri = "mongodb://localhost:27017"     # MongoDB 连接字符串
-# mongodb_database = "gcli2api"                 # MongoDB 数据库名称
-# 
 # # 密码配置
 # api_password = "your_api_password"        # 聊天API密码
 # panel_password = "your_panel_password"    # 控制面板密码

README.md

@@ -290,11 +290,45 @@ docker run -d --name gcli2api --network host -e API_PASSWORD=api_pwd -e PANEL_PA
      - `x-goog-api-key: your_api_password` 
      - URL 参数：`?key=your_api_password`
 
-## 🍃 MongoDB 分布式存储模式
+## 💾 分布式存储模式
 
-### 🌟 新增功能
+### 🌟 存储后端优先级
 
-gcli2api 现已支持 **MongoDB 存储模式**，
+gcli2api 支持多种存储后端，按优先级自动选择：**Redis > MongoDB > 本地文件**
+
+### ⚡ Redis 分布式存储模式
+
+### ⚙️ 启用 Redis 模式
+
+**步骤 1: 配置 Redis 连接**
+```bash
+# 本地 Redis
+export REDIS_URI="redis://localhost:6379"
+
+# 带密码的 Redis
+export REDIS_URI="redis://:password@localhost:6379"
+
+# SSL 连接（推荐生产环境）
+export REDIS_URI="rediss://default:password@host:6380"
+
+# Upstash Redis（免费云服务）
+export REDIS_URI="rediss://default:token@your-host.upstash.io:6379"
+
+# 可选：自定义数据库索引（默认: 0）
+export REDIS_DATABASE="1"
+```
+
+**步骤 2: 启动应用**
+```bash
+# 应用会自动检测 Redis 配置并优先使用 Redis 存储
+python web.py
+```
+
+### 🍃 MongoDB 分布式存储模式
+
+### 🌟 备选存储方案
+
+如果未配置 Redis，gcli2api 将尝试使用 **MongoDB 存储模式**，
 
 ### ⚙️ 启用 MongoDB 模式
 
@@ -319,22 +353,6 @@ export MONGODB_DATABASE="my_gcli_db"
 python web.py
 ```
 
-### 🔄 数据迁移
-
-提供完整的数据迁移工具，支持本地文件与 MongoDB 之间的双向迁移：
-
-**使用管理脚本（推荐）**
-```bash
-# 启动交互式管理界面
-python mongodb_setup.py
-
-# 直接命令行操作
-python mongodb_setup.py status    # 查看当前存储状态
-python mongodb_setup.py check     # 检查 MongoDB 连接
-python mongodb_setup.py migrate   # 迁移数据到 MongoDB
-python mongodb_setup.py export    # 从 MongoDB 导出数据
-```
-
 **Docker 环境使用 MongoDB**
 ```bash
 # 单机 MongoDB 部署
@@ -562,7 +580,16 @@ export MONGODB_URI="mongodb://localhost:27017/gcli2api?readPreference=secondaryP
 - `LOG_LEVEL`: 日志级别（DEBUG/INFO/WARNING/ERROR，默认：INFO）
 - `LOG_FILE`: 日志文件路径（默认：gcli2api.log）
 
-**MongoDB 配置**
+**存储配置（按优先级）**
+
+**Redis 配置（最高优先级）**
+- `REDIS_URI`: Redis 连接字符串（设置后启用 Redis 模式）
+  - 本地：`redis://localhost:6379`
+  - 带密码：`redis://:password@host:6379`
+  - SSL：`rediss://default:password@host:6380`
+- `REDIS_DATABASE`: Redis 数据库索引（0-15，默认：0）
+
+**MongoDB 配置（第二优先级）**
 - `MONGODB_URI`: MongoDB 连接字符串（设置后启用 MongoDB 模式）
 - `MONGODB_DATABASE`: MongoDB 数据库名称（默认：gcli2api）
 

docs/README_EN.md

@@ -2,9 +2,12 @@
 
 **Convert GeminiCLI to OpenAI and GEMINI API interfaces**
 
----
+[中文](../README.md) | English
+
+## 🚀 Quick Deploy
 
-[![Deploy on Zeabur](https://zeabur.com/button.svg)](https://zeabur.com/templates/FIBY1S?referralCode=su-kaka)
+[![Deploy on Zeabur](https://zeabur.com/button.svg)](https://zeabur.com/templates/2QLQC2?referralCode=su-kaka)
+---
 
 ## ⚠️ License Declaration
 
@@ -287,6 +290,173 @@ docker run -d --name gcli2api --network host -e API_PASSWORD=api_pwd -e PANEL_PA
      - `x-goog-api-key: your_api_password` 
      - URL parameter: `?key=your_api_password`
 
+## 💾 Distributed Storage Mode
+
+### 🌟 Storage Backend Priority
+
+gcli2api supports multiple storage backends, automatically selecting by priority: **Redis > MongoDB > Local Files**
+
+### ⚡ Redis Distributed Storage Mode
+
+### ⚙️ Enable Redis Mode
+
+**Step 1: Configure Redis Connection**
+```bash
+# Local Redis
+export REDIS_URI="redis://localhost:6379"
+
+# Redis with password
+export REDIS_URI="redis://:password@localhost:6379"
+
+# SSL connection (recommended for production)
+export REDIS_URI="rediss://default:password@host:6380"
+
+# Upstash Redis (free cloud service)
+export REDIS_URI="rediss://default:token@your-host.upstash.io:6379"
+
+# Optional: Custom database index (default: 0)
+export REDIS_DATABASE="1"
+```
+
+**Step 2: Start Application**
+```bash
+# Application will automatically detect Redis configuration and prioritize Redis storage
+python web.py
+```
+
+### 🍃 MongoDB Distributed Storage Mode
+
+### 🌟 Alternative Storage Solution
+
+If Redis is not configured, gcli2api will attempt to use **MongoDB storage mode**.
+
+### ⚙️ Enable MongoDB Mode
+
+**Step 1: Configure MongoDB Connection**
+```bash
+# Local MongoDB
+export MONGODB_URI="mongodb://localhost:27017"
+
+# MongoDB Atlas cloud service
+export MONGODB_URI="mongodb+srv://username:password@cluster.mongodb.net"
+
+# MongoDB with authentication
+export MONGODB_URI="mongodb://admin:password@localhost:27017/admin"
+
+# Optional: Custom database name (default: gcli2api)
+export MONGODB_DATABASE="my_gcli_db"
+```
+
+**Step 2: Start Application**
+```bash
+# Application will automatically detect MongoDB configuration and use MongoDB storage
+python web.py
+```
+
+**Docker Environment using MongoDB**
+```bash
+# Single MongoDB deployment
+docker run -d --name gcli2api \
+  -e MONGODB_URI="mongodb://mongodb:27017" \
+  -e API_PASSWORD=your_password \
+  --network your_network \
+  ghcr.io/su-kaka/gcli2api:latest
+
+# Using MongoDB Atlas
+docker run -d --name gcli2api \
+  -e MONGODB_URI="mongodb+srv://user:pass@cluster.mongodb.net/gcli2api" \
+  -e API_PASSWORD=your_password \
+  -p 7861:7861 \
+  ghcr.io/su-kaka/gcli2api:latest
+```
+
+**Docker Compose Example**
+```yaml
+version: '3.8'
+
+services:
+  mongodb:
+    image: mongo:7
+    container_name: gcli2api-mongodb
+    restart: unless-stopped
+    environment:
+      MONGO_INITDB_ROOT_USERNAME: admin
+      MONGO_INITDB_ROOT_PASSWORD: password123
+    volumes:
+      - mongodb_data:/data/db
+    ports:
+      - "27017:27017"
+
+  gcli2api:
+    image: ghcr.io/su-kaka/gcli2api:latest
+    container_name: gcli2api
+    restart: unless-stopped
+    depends_on:
+      - mongodb
+    environment:
+      - MONGODB_URI=mongodb://admin:password123@mongodb:27017/admin
+      - MONGODB_DATABASE=gcli2api
+      - API_PASSWORD=your_api_password
+      - PORT=7861
+    ports:
+      - "7861:7861"
+
+volumes:
+  mongodb_data:
+```
+
+### 🛠️ Troubleshooting
+
+**Common Issue Solutions**
+
+```bash
+# Check MongoDB connection
+python mongodb_setup.py check
+
+# View detailed status information
+python mongodb_setup.py status
+
+# Verify data migration results
+python -c "
+import asyncio
+from src.storage_adapter import get_storage_adapter
+
+async def test():
+    storage = await get_storage_adapter()
+    info = await storage.get_backend_info()
+    print(f'Current mode: {info[\"backend_type\"]}')
+    if info['backend_type'] == 'mongodb':
+        print(f'Database: {info.get(\"database_name\", \"Unknown\")}')
+
+asyncio.run(test())
+"
+```
+
+**Migration Failure Handling**
+```bash
+# If migration is interrupted, re-run
+python mongodb_setup.py migrate
+
+# To rollback to file mode, remove MONGODB_URI environment variable
+unset MONGODB_URI
+# Then export data from MongoDB
+python mongodb_setup.py export
+```
+
+### 🔧 Advanced Configuration
+
+**MongoDB Connection Optimization**
+```bash
+# Connection pool and timeout configuration
+export MONGODB_URI="mongodb://localhost:27017?maxPoolSize=10&serverSelectionTimeoutMS=5000"
+
+# Replica set configuration
+export MONGODB_URI="mongodb://host1:27017,host2:27017,host3:27017/gcli2api?replicaSet=myReplicaSet"
+
+# Read-write separation configuration
+export MONGODB_URI="mongodb://localhost:27017/gcli2api?readPreference=secondaryPreferred"
+```
+
 ## 🏗️ Technical Architecture
 
 ### Core Module Description
@@ -378,6 +548,19 @@ docker run -d --name gcli2api --network host -e API_PASSWORD=api_pwd -e PANEL_PA
 - `LOG_LEVEL`: Log level (DEBUG/INFO/WARNING/ERROR, default: INFO)
 - `LOG_FILE`: Log file path (default: gcli2api.log)
 
+**Storage Configuration (by priority)**
+
+**Redis Configuration (Highest Priority)**
+- `REDIS_URI`: Redis connection string (enables Redis mode when set)
+  - Local: `redis://localhost:6379`
+  - With password: `redis://:password@host:6379`
+  - SSL: `rediss://default:password@host:6380`
+- `REDIS_DATABASE`: Redis database index (0-15, default: 0)
+
+**MongoDB Configuration (Second Priority)**
+- `MONGODB_URI`: MongoDB connection string (enables MongoDB mode when set)
+- `MONGODB_DATABASE`: MongoDB database name (default: gcli2api)
+
 **Credential Configuration**
 
 Support importing multiple credentials using `GCLI_CREDS_*` environment variables: