Skip to content

Commit 7cc03d7

Browse files
committed
docs: 更新文档
1 parent 5c8a43f commit 7cc03d7

7 files changed

Lines changed: 119 additions & 128 deletions

File tree

.vitepress/config.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ export default defineConfig({
1010
description: "网页版 AI 服务转 OpenAI 兼容 API",
1111

1212
head: [
13-
['link', { rel: 'icon', href: '/favicon.png' }]
13+
['link', { rel: 'icon', href: '/WebAI2API/favicon.png' }]
1414
],
1515

1616
ignoreDeadLinks: [

docs/admin/linux.md

Lines changed: 33 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -1,81 +1,66 @@
11
# Linux 部署
22

3-
在 Linux 服务器上运行 WebAI2API 的特殊配置说明。
3+
【Docker用户可无视】在 Linux 服务器上运行 WebAI2API 的特殊配置说明。
44

5-
## 显示方式选择
5+
## 1.安装必要依赖
66

7-
Linux 服务器上运行非无头模式时,需要配置显示环境
7+
Linux 命令行模式下必要的依赖,他们可以让你在没有图形桌面的 Linux 环境下运行图形化应用
88

9-
### 方式一:Xvfb + VNC (推荐)
10-
11-
使用虚拟显示器运行程序,通过 VNC 远程查看。
12-
13-
#### 使用内置命令
9+
### Ubuntu/Debian
1410

1511
```bash
16-
npm start -- -xvfb -vnc
12+
sudo apt-get update
13+
sudo apt-get install xvfb x11vnc
1714
```
1815

19-
这会自动:
20-
- 启动 Xvfb 虚拟显示器
21-
- 启动 x11vnc 服务器
22-
- 可通过 WebUI 直接查看 VNC 画面
23-
24-
#### 手动配置
25-
26-
如果内置命令无法满足需求:
27-
28-
1. **启动虚拟显示器**
16+
### CentOS/RHEL
2917

3018
```bash
31-
xvfb-run --server-num=99 --server-args="-ac -screen 0 1920x1080x24" npm start
19+
sudo yum install xorg-x11-server-Xvfb x11vnc
3220
```
3321

34-
2. **映射到 VNC**
22+
### Arch Linux
3523

3624
```bash
37-
x11vnc -display :99 -localhost -nopw -forever -noxdamage
25+
sudo pacman -S xorg-server-xvfb x11vnc
3826
```
3927

40-
## VNC 连接
28+
## 2.运行程序
4129

42-
### 通过 SSH 隧道 (推荐)
30+
使用虚拟显示器运行程序,通过 VNC 远程查看。(程序会帮你处理好一切)
4331

4432
```bash
45-
# 本地终端
46-
ssh -L 5900:127.0.0.1:5900 root@服务器IP
33+
npm start -- -xvfb -vnc
4734
```
4835

49-
然后使用 VNC 客户端连接 `127.0.0.1:5900`
50-
51-
### 通过 WebUI
36+
这会自动:
37+
- 启动 Xvfb 虚拟显示器
38+
- 启动 x11vnc 服务器
39+
- 可通过 WebUI 直接查看 VNC 画面
5240

53-
服务启动后,访问 WebUI 的「VNC 显示」页面即可直接查看。
41+
## 3.连接程序
5442

55-
### 安装依赖
43+
### 通过 WebUI (推荐)
5644

57-
### Ubuntu/Debian
45+
服务启动后,访问 WebUI 的「VNC 显示」页面即可直接查看。
5846

59-
```bash
60-
sudo apt-get update
61-
sudo apt-get install xvfb x11vnc
62-
```
47+
### 通过 SSH 隧道
6348

64-
### CentOS/RHEL
49+
::: tip 小贴士
50+
实际运行不一定是5900端口,程序会自动在 5900-5999 中寻找可用的 VNC 端口
51+
:::
6552

6653
```bash
67-
sudo yum install xorg-x11-server-Xvfb x11vnc
54+
# 本地终端
55+
ssh -L 5900:127.0.0.1:5900 root@服务器IP
6856
```
6957

70-
### Arch Linux
58+
然后使用 VNC 客户端连接 `127.0.0.1:5900`
7159

72-
```bash
73-
sudo pacman -S xorg-server-xvfb x11vnc
74-
```
7560

76-
### 方式二:X11 转发
61+
## 额外方式:终端 X11 转发
7762

78-
适用于通过 SSH 连接服务器的场景
63+
不推荐该方式,除非你愿意自己配置运行环境
7964

8065
1. 在本地安装 X Server(如 VcXsrv、Xming)
8166
2. 使用支持 X11 转发的终端(如 WindTerm)
@@ -85,21 +70,6 @@ sudo pacman -S xorg-server-xvfb x11vnc
8570
ssh -X user@server
8671
```
8772

88-
## Docker 部署
89-
90-
Docker 镜像已内置 Xvfb 和 VNC 支持:
91-
92-
```bash
93-
docker run -d --name webai2api \
94-
-p 3000:3000 -p 5900:5900 \
95-
-v "$(pwd)/data:/app/data" \
96-
-e LOGIN_MODE=true \
97-
--shm-size=2gb \
98-
foxhui/lmarena-imagen-automator:latest
99-
```
100-
101-
通过 VNC 客户端连接 `localhost:5900` 完成登录。
102-
10373
## 常见问题
10474

10575
### 端口被占用
@@ -109,3 +79,7 @@ docker run -d --name webai2api \
10979
### 显示号冲突
11080

11181
Xvfb 会自动从 50 开始查找可用的显示号,避免与现有 X 服务器冲突。
82+
83+
### 无法连接至 VNC
84+
85+
请检查依赖是否被安装成功。

docs/admin/webui.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ WebUI 以及管理接口仅在握手阶段使用 API Token 验证,传输阶段
1212
http://localhost:3000
1313
```
1414

15-
首次访问需要输入配置文件中设置的 API Token 进行认证。
15+
首次访问需要输入配置文件中设置的 API Token 进行认证,API Token 即配置文件中`auth`所配置的鉴权密钥
1616

1717
## 功能模块
1818

docs/guide/deployment.md

Lines changed: 16 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -11,50 +11,39 @@ git clone https://github.com/foxhui/WebAI2API.git
1111
cd WebAI2API
1212
```
1313

14-
### 2. 复制配置文件
14+
### 2. 安装依赖
1515

1616
```bash
17-
cp config.example.yaml config.yaml
18-
```
19-
20-
### 3. 安装依赖
21-
22-
```bash
23-
# 安装 Node.js 依赖
17+
# 1. 安装 NPM 依赖
2418
pnpm install
25-
26-
# 初始化预编译依赖
27-
npm run init
19+
# 2. 安装浏览器等预编译依赖
20+
npm run init
21+
# 使用代理
22+
# 直接使用 -proxy 可交互式输入代理配置
23+
npm run init -- -proxy=http://username:passwd@host:port
2824
```
2925

3026
::: warning 注意
3127
`npm run init` 需要从 GitHub 下载文件,请确保网络畅通。
3228
:::
3329

34-
### 4. 编辑配置
35-
36-
编辑 `config.yaml` 文件,设置鉴权密钥等配置:
37-
38-
```yaml
39-
server:
40-
port: 3000
41-
auth: sk-your-secret-key # 修改为你的密钥
42-
```
43-
44-
### 5. 启动服务
30+
### 3. 启动服务
4531

4632
```bash
47-
# 标准运行
33+
# 标准启动
4834
npm start
49-
50-
# Linux 命令行启动
35+
# Linux 系统 - 虚拟显示启动
5136
npm start -- -xvfb -vnc
37+
# 登录模式 (会临时强行禁用无头模式和自动化)
38+
npm start -- -login (-xvfb -vnc)
5239
```
5340

5441
## Docker 部署
5542

56-
::: warning **特别说明**
57-
登录相关操作可以在 WebUI 的虚拟显示器板块进行,也可通过 RealVNC 等工具连接(需添加映射 VNC 端口,默认非被占用的情况下为 5900)
43+
::: warning **安全提醒**
44+
- Docker 镜像默认开启虚拟显示器 (Xvfb) 和 VNC 服务
45+
- 可通过 WebUI 的虚拟显示器板块连接
46+
- **WebUI 传输过程未加密, 公网环境请使用 SSH 隧道或 HTTPS**
5847
:::
5948

6049
### Docker CLI

docs/guide/first-use.md

Lines changed: 59 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -2,57 +2,81 @@
22

33
首次使用 WebAI2API 时,需要完成登录初始化才能正常使用。
44

5-
## 登录模式
6-
7-
### 启动登录模式
5+
## 1. 调整配置文件
86

9-
登录模式会强制关闭无头模式
7+
程序初次运行会从`config.example.yaml`复制配置文件到`data/config.yaml`
108

11-
```bash
12-
# 启动第一个 Worker 进行登录
13-
npm start -- -login
9+
::: tip 小贴士
10+
**配置文件的生效需要重启程序!**
11+
:::
1412

15-
# 启动指定 Worker 进行登录
16-
npm start -- -login=workerName
13+
```yaml
14+
server:
15+
# 监听端口
16+
port: 3000
17+
# 鉴权 API Token (可使用 npm run genkey 生成)
18+
# 该配置会对 API 接口和 WebUI 生效
19+
auth: sk-change-me-to-your-secure-key
1720
```
1821
19-
### Linux 用户特殊说明
22+
## 2. 访问 Web 管理界面
2023
21-
Linux 服务器用户可以使用 Xvfb + VNC 方式:
22-
23-
```bash
24-
npm start -- -xvfb -vnc
24+
服务启动后, 打开浏览器访问:
25+
```
26+
http://localhost:3000
2527
```
2628

27-
然后通过 VNC 客户端连接 `:5900` 端口进行操作(也可使用 WebUI 中的虚拟显示器板块)
29+
::: tip 小贴士
30+
**远程访问**: 将 `localhost` 替换为服务器 IP 地址即可远程访问。
31+
**API Token**: 配置文件中的`auth`所配置的鉴权密钥。
32+
**安全建议**: 公网环境建议使用 Nginx/Caddy 配置 HTTPS 或通过 SSH 隧道访问。
33+
:::
2834

29-
## 初始化步骤
3035

31-
1. **登录账号**
32-
- Linux 用户使用 `npm start -- -xvfb -vnc` 启动程序,然后使用 WebUI 或者第三方工具连接 VNC
33-
- 在打开的浏览器中登录相应平台的账号
34-
- 例如:Google 账号用于 Gemini,GitHub 账号用于 LMArena
36+
## 3. 初始化账号登录
3537

36-
2. **完成验证**
37-
- 在输入框发送任意消息
38-
- 触发并完成 CloudFlare/reCAPTCHA 验证
39-
- 同意服务条款
38+
> [!IMPORTANT]
39+
> **首次使用必须完成以下初始化步骤**:
4040
41-
3. **验证成功**
42-
- 确认可以正常发送消息和接收回复
43-
- 关闭浏览器或按 `Ctrl+C` 退出登录模式
41+
1. **连接虚拟显示器**:
42+
- Linux/Docker: 在 WebUI 的"虚拟显示器"板块连接
43+
- Windows: 直接在弹出的浏览器窗口中操作
4444

45+
2. **完成账号登录**:
46+
- 手动登录所需的 AI 网站账号
47+
- 在输入框发送任意消息, 触发并完成人机验证 (如需要)
48+
- 同意服务条款或者新手指引 (如需要)
49+
- 确保不再有初次使用相关内容的阻拦
4550

46-
::: tip 运行建议
47-
- 初始化完成后可使用无头模式运行,为降低风控风险,**强烈建议长期保持非无头模式运行**
48-
- **WebUI 和 VNC 传输过程均未加密,若在公网环境运行请走 SSH 隧道或者使用 Caddy/Nginx 为 WebUI 添加 HTTPS 连接**
51+
3. **SSH 隧道连接示例**(公网服务器推荐):
4952
```bash
50-
# SSH隧道方法:在本地终端运行,将服务器 5900 端口映射到本地
51-
ssh -L 5900:127.0.0.1:5900 root@服务器IP
53+
# 在本地终端运行,将服务器的 WebUI 映射到本地
54+
ssh -L 3000:127.0.0.1:3000 root@服务器IP
55+
56+
# 然后在本地访问
57+
# WebUI: http://localhost:3000
5258
```
59+
60+
::: tip 运行建议
61+
为降低风控, **强烈建议长期保持非无头模式运行**(或使用虚拟显示器 Xvfb)。
62+
63+
**关于有头/无头模式**:
64+
- **有头模式**(默认): 显示浏览器窗口, 便于调试和人工干预
65+
- **无头模式**: 后台运行, 节省资源但无法查看浏览器界面, 且可能会被网站检测
5366
:::
5467

55-
## 多 Worker 登录
68+
## 登录模式
69+
70+
登录模式会强制关闭无头模式
71+
72+
### 基础用法
73+
```bash
74+
# 启动第一个 Worker 进行登录
75+
npm start -- -login
76+
77+
```
78+
79+
### 多 Worker 登录
5680

5781
如果配置了多个 Worker,需要分别为每个 Worker 完成登录:
5882

@@ -66,7 +90,7 @@ npm start -- -login=worker2
6690
同一 Instance(浏览器实例)下的多个 Worker 共享登录状态。如果使用 Google OAuth 等统一登录方式,只需登录一次即可。
6791
:::
6892

69-
## WebUI 登录模式
93+
### WebUI 登录模式
7094

7195
服务运行后,也可以通过 WebUI 切换到登录模式:
7296

@@ -75,7 +99,7 @@ npm start -- -login=worker2
7599
3. 点击「重启」按钮的下拉箭头
76100
4. 选择「登录模式重启」或指定 Worker 登录
77101

78-
## 下一步
102+
## 4.下一步
79103

80104
登录完成后,请阅读以下内容:
81105

docs/guide/introduction.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,15 @@
2020
::: tip 实测环境表现
2121
**获取完整模型列表**: 通过 `GET /v1/models` 接口查看当前配置下所有可用模型及其详细信息。
2222

23-
✅目前支持;❌目前不支持,但未来可能会支持;🚫网站不支持,是否在支持看网站具体情况
23+
✅目前支持;❌目前不支持,但未来可能会支持;🚫网站不支持, 未来是否在支持看网站具体情况
2424
:::
2525

2626
## 项目截图
2727

2828
![Image](https://github.com/user-attachments/assets/296a518e-c42b-4e39-8ff6-9b4381ed4f6e)
2929

30-
![Image](https://github.com/user-attachments/assets/06f31024-ecd4-48d2-9789-eedc98c9c5b9)
30+
![Image](https://github.com/user-attachments/assets/bfa30ece-6947-4f18-b2c9-ccc8087b7e89)
31+
32+
![Image](https://github.com/user-attachments/assets/5b15ebd2-7593-4f0e-8561-83d6ba5d88ab)
33+
34+
![Image](https://github.com/user-attachments/assets/53deea29-4071-4a07-8a61-211761c5f2f7)

docs/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@ features:
2222
- icon: 🤖
2323
title: 拟人交互
2424
details: 模拟人类打字与鼠标轨迹,通过特征伪装规避自动化检测
25-
- icon: 🔄
26-
title: 接口兼容
27-
details: 提供标准 OpenAI 格式接口,支持流式响应与心跳保活
25+
- icon: 🎨
26+
title: 网页管理
27+
details: 提供可视化管理界面, 支持实时日志查看、VNC 连接、适配器管理等
2828
- icon: 🚀
2929
title: 并发隔离
3030
details: 支持多窗口并发执行,实现多账号浏览器实例级数据隔离

0 commit comments

Comments
 (0)