docs: 移除代码文件,初始化文档专用分支

This commit is contained in:
foxhui
2025-12-20 20:02:24 +08:00
Unverified
parent e8123cca5d
commit 28cac21641
123 changed files with 28258 additions and 18637 deletions
+106
View File
@@ -0,0 +1,106 @@
# 快速部署
本项目支持 **手动部署(推荐)****Docker 容器化部署** 两种方式。
## 手动部署
### 1. 克隆项目
```bash
git clone https://github.com/foxhui/WebAI2API.git
cd WebAI2API
```
### 2. 复制配置文件
```bash
cp config.example.yaml config.yaml
```
### 3. 安装依赖
```bash
# 安装 Node.js 依赖
pnpm install
# 初始化预编译依赖
npm run init
```
::: warning 注意
`npm run init` 需要从 GitHub 下载文件,请确保网络畅通。
:::
### 4. 编辑配置
编辑 `config.yaml` 文件,设置鉴权密钥等配置:
```yaml
server:
port: 3000
auth: sk-your-secret-key # 修改为你的密钥
```
### 5. 启动服务
```bash
# 标准运行
npm start
# Linux 命令行启动
npm start -- -xvfb -vnc
```
## Docker 部署
::: warning 首次运行说明
首次运行需通过 VNC 客户端连接 `localhost:5900` 完成网页登录验证。
:::
### Docker CLI
```bash
docker run -d --name webai2api \
-p 3000:3000 -p 5900:5900 \
-v "$(pwd)/data:/app/data" \
-v "$(pwd)/config.yaml:/app/config.yaml" \
-e LOGIN_MODE=true \
--shm-size=2gb \
foxhui/lmarena-imagen-automator:latest
```
### Docker Compose
```yaml
version: '3.8'
services:
webai2api:
image: foxhui/lmarena-imagen-automator:latest
ports:
- "3000:3000"
- "5900:5900"
volumes:
- ./data:/app/data
- ./config.yaml:/app/config.yaml
environment:
- LOGIN_MODE=true
shm_size: 2gb
restart: unless-stopped
```
启动服务:
```bash
docker compose up -d
```
## 验证安装
服务启动后,访问以下地址验证:
- **Web 管理界面**: http://localhost:3000
- **API 接口测试**: http://localhost:3000/v1/chat/completions
## 下一步
部署完成后,请阅读 [首次使用](/guide/first-use) 完成登录初始化。
+82
View File
@@ -0,0 +1,82 @@
# 首次使用
首次使用 WebAI2API 时,需要完成登录初始化才能正常使用。
## 登录模式
### 启动登录模式
```bash
# 启动第一个 Worker 进行登录
npm start -- -login
# 启动指定 Worker 进行登录
npm start -- -login=workerName
```
### Linux 用户特殊说明
Linux 服务器用户可以使用 Xvfb + VNC 方式:
```bash
npm start -- -xvfb -vnc
```
然后通过 VNC 客户端连接 `:5900` 端口进行操作(也可使用 WebUI 中的虚拟显示器板块)
## 初始化步骤
1. **登录账号**
- 在打开的浏览器中登录相应平台的账号
- 例如:Google 账号用于 GeminiGitHub 账号用于 LMArena
2. **完成验证**
- 在输入框发送任意消息
- 触发并完成 CloudFlare/reCAPTCHA 验证
- 同意服务条款
3. **验证成功**
- 确认可以正常发送消息和接收回复
- 关闭浏览器或按 `Ctrl+C` 退出登录模式
## 切换到标准模式
初始化完成后,使用标准命令启动服务:
```bash
npm start
```
::: tip 运行建议
为降低风控风险,**强烈建议长期保持非无头模式运行**。
:::
## 多 Worker 登录
如果配置了多个 Worker,需要分别为每个 Worker 完成登录:
```bash
# 依次登录各个 Worker
npm start -- -login=worker1
npm start -- -login=worker2
```
::: info 共享登录状态
同一 Instance(浏览器实例)下的多个 Worker 共享登录状态。如果使用 Google OAuth 等统一登录方式,只需登录一次即可。
:::
## WebUI 登录模式
服务运行后,也可以通过 WebUI 切换到登录模式:
1. 访问 http://localhost:3000
2. 进入「系统管理」页面
3. 点击「重启」按钮的下拉箭头
4. 选择「登录模式重启」或指定 Worker 登录
## 下一步
登录完成后,请阅读以下内容:
- [配置文件](/config/overview) - 了解完整配置选项
- [API 参考](/api/overview) - 开始使用 API
+79
View File
@@ -0,0 +1,79 @@
# 环境要求
在开始部署 WebAI2API 之前,请确保您的环境满足以下要求。
## 系统要求
### 操作系统
- **Windows**: Windows 10/11 或 Windows Server 2016+
- **Linux**: Ubuntu 18.04+, Debian 10+, CentOS 7+ 或其他主流发行版
- **macOS**: macOS 10.15 (Catalina) 或更高版本
### 硬件配置
| 资源 | 最低配置 | 推荐配置(单实例) | 推荐配置(多实例) |
| :--- | :--- | :--- | :--- |
| **CPU** | 1 核 | 2 核及以上 | 2 核及以上 |
| **内存** | 1 GB | 2 GB 及以上 | 4 GB 及以上 |
| **磁盘** | 2 GB 可用空间 | 5 GB 及以上 | 7 GB 及以上 |
::: tip 实测环境表现
- **Oracle 免费机** (1C1G, Debian 12):资源紧张,比较卡顿,仅供尝鲜或轻度使用
- **阿里云轻量云** (2C2G, Debian 11):运行流畅,项目开发测试所用机型
:::
## 软件依赖
### Node.js
- **版本要求**: v20.0.0 或更高版本 (ABI 115+)
- **包管理器**: pnpm (推荐) 或 npm
```bash
# 检查 Node.js 版本
node --version
# 安装 pnpm (如未安装)
npm install -g pnpm
```
### Camoufox
Camoufox 是本项目的核心依赖,会在安装过程中自动下载。
::: warning 网络要求
安装过程需要从 GitHub 下载 Camoufox 等预编译依赖,请确保网络能够正常访问 GitHub。
:::
## Docker 环境 (可选)
如果选择 Docker 部署方式,需要安装:
- **Docker**: 20.10.0 或更高版本
- **Docker Compose**: 2.0.0 或更高版本 (可选)
```bash
# 检查 Docker 版本
docker --version
docker compose version
```
## Linux 特殊依赖
在 Linux 环境下运行非无头模式时,可能需要额外安装:
```bash
# Ubuntu/Debian
sudo apt-get install xvfb x11vnc
# CentOS/RHEL
sudo yum install xorg-x11-server-Xvfb x11vnc
# Arch Linux
sudo pacman -S xorg-server-xvfb x11vnc
```
## 下一步
环境准备就绪后,请继续阅读 [快速部署](/guide/deployment) 开始安装。