更新README文件

This commit is contained in:
lintsinghua 2025-10-26 14:14:02 +08:00
parent b4e111a574
commit ecfee09ad4
2 changed files with 72 additions and 18 deletions

View File

@ -66,25 +66,55 @@
### 🐳 Docker 部署(推荐)
使用 Docker 一键部署,无需配置 Node.js 环境:
#### 方式一:使用发布的镜像(最简单)⭐
直接使用最新发布的 Docker 镜像,支持 x86、ARM64Mac M系列、ARMv7 架构:
```bash
# 1. 拉取最新版本镜像
docker pull ghcr.io/lintsinghua/xcodereviewer:latest
# 2. 运行容器
docker run -d \
-p 8888:80 \
--name xcodereviewer \
--restart unless-stopped \
ghcr.io/lintsinghua/xcodereviewer:latest
# 3. 访问应用
# 浏览器打开 http://localhost:8888
```
**使用特定版本**
```bash
# 拉取指定版本(如 v1.1.0
docker pull ghcr.io/lintsinghua/xcodereviewer:v1.1.0
# 运行
docker run -d -p 8888:80 --name xcodereviewer ghcr.io/lintsinghua/xcodereviewer:v1.1.0
```
#### 方式二:本地构建(可选)
如果需要自定义构建:
```bash
# 1. 克隆项目
git clone https://github.com/lintsinghua/XCodeReviewer.git
cd XCodeReviewer
# 2. 构建并启动(无需预先配置)
# 2. 使用 Docker Compose 构建并启动
docker-compose up -d
# 3. 访问应用
# 浏览器打开 http://localhost:5174
# 浏览器打开 http://localhost:8888
```
**✨ 运行时配置**
**✨ 运行时配置(推荐)**
Docker 部署后,您可以直接在浏览器中配置所有设置,无需重新构建镜像:
1. 访问 `http://localhost:5174/admin`(系统管理页面)
1. 访问 `http://localhost:8888/admin`(系统管理页面)
2. 在"系统配置"标签页中配置 LLM API Keys 和其他参数
3. 点击保存并刷新页面即可使用
@ -171,7 +201,7 @@ VITE_LLM_GAP_MS=1000 # 增加请求间隔
**方式一:浏览器配置(推荐)**
1. 访问 `http://localhost:5174/admin` 系统管理页面
1. 访问 `http://localhost:8888/admin` 系统管理页面
2. 在"系统配置"标签页选择不同的 LLM 提供商
3. 填入对应的 API Key
4. 保存并刷新页面

View File

@ -66,34 +66,58 @@ In the fast-paced world of software development, ensuring code quality is crucia
### 🐳 Docker Deployment (Recommended)
One-click deployment with Docker, no Node.js environment required:
#### Method 1: Use Published Image (Easiest) ⭐
Directly use the latest published Docker image, supports x86, ARM64 (Mac M-series), and ARMv7 architectures:
```bash
# 1. Pull the latest image
docker pull ghcr.io/lintsinghua/xcodereviewer:latest
# 2. Run container
docker run -d \
-p 8888:80 \
--name xcodereviewer \
--restart unless-stopped \
ghcr.io/lintsinghua/xcodereviewer:latest
# 3. Access the application
# Open http://localhost:8888 in your browser
```
**Use specific version**:
```bash
# Pull specific version (e.g., v1.1.0)
docker pull ghcr.io/lintsinghua/xcodereviewer:v1.1.0
# Run
docker run -d -p 8888:80 --name xcodereviewer ghcr.io/lintsinghua/xcodereviewer:v1.1.0
```
#### Method 2: Local Build (Optional)
If you need custom build:
```bash
# 1. Clone the project
git clone https://github.com/lintsinghua/XCodeReviewer.git
cd XCodeReviewer
# 2. Build and start (no pre-configuration needed)
# 2. Build and start with Docker Compose
docker-compose up -d
# 3. Access the application
# Open http://localhost:5174 in your browser
# Open http://localhost:8888 in your browser
```
**✨ New Feature: Runtime Configuration**
**✨ Runtime Configuration (Recommended)**
After Docker deployment, you can configure all settings directly in the browser without rebuilding the image:
1. Visit `http://localhost:5174/admin` (System Management page)
1. Visit `http://localhost:8888/admin` (System Management page)
2. Configure LLM API Keys and other parameters in the "System Configuration" tab
3. Click save and refresh the page to use
Benefits:
- ✅ No need to hardcode API Keys in Docker images (more secure)
- ✅ Modify configuration anytime without rebuilding
- ✅ Support for API relay services
- ✅ Quickly switch between different LLM platforms
> 📖 **For detailed configuration instructions, see**: [System Configuration Guide](#system-configuration-first-time-setup)
### 💻 Local Development Deployment
@ -177,7 +201,7 @@ VITE_LLM_GAP_MS=1000 # Increase request interval
**Method 1: Browser Configuration (Recommended)**
1. Visit `http://localhost:5174/admin` System Management page
1. Visit `http://localhost:8888/admin` System Management page
2. Select different LLM provider in the "System Configuration" tab
3. Enter the corresponding API Key
4. Save and refresh the page