Skip to content

Commit 1f2e653

Browse files
committed
docs: 更新文档
1 parent 6b54c35 commit 1f2e653

5 files changed

Lines changed: 77 additions & 13 deletions

File tree

docs/admin/webui.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ http://localhost:3000
3333
- 登录模式重启
3434
- 指定 Worker 登录
3535
- 停止服务
36+
- 适配器设置 (适配器描述,模型管理,功能开关)
3637

3738
- **缓存管理**
3839
- 查看临时文件

docs/api/overview.md

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -24,18 +24,6 @@ Content-Type: application/json
2424
| GET | `/v1/models` | 获取模型列表 |
2525
| GET | `/v1/cookies` | 获取 Cookie |
2626

27-
### 管理接口
28-
29-
| 方法 | 端点 | 说明 |
30-
| --- | --- | --- |
31-
| GET | `/admin/status` | 服务状态 |
32-
| GET | `/admin/stats` | 统计信息 |
33-
| GET | `/admin/queue` | 队列状态 |
34-
| POST | `/admin/restart` | 重启服务 |
35-
| POST | `/admin/stop` | 停止服务 |
36-
| GET | `/admin/vnc/status` | VNC 状态 |
37-
| POST | `/admin/cache/clear` | 清理缓存 |
38-
3927
## 错误响应
4028

4129
所有 API 错误返回统一格式:

docs/config/instances.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,51 @@ backend:
7474
| `nanobananafree_ai` | Nano Banana Free |
7575
| `merge` | 聚合模式(单标签多后端) |
7676

77+
## 模型过滤器 (Model Filter)
78+
79+
每个适配器都可以配置专属的模型黑白名单,用于控制该适配器可以使用的模型列表。
80+
81+
### 配置方式
82+
83+
模型过滤器配置在 `backend.adapter.<适配器ID>` 下:
84+
85+
```yaml
86+
backend:
87+
adapter:
88+
lmarena:
89+
returnUrl: false
90+
modelFilter:
91+
mode: whitelist # 白名单whitelist 黑名单blacklist
92+
list: # 仅启用和仅禁用的模型列表
93+
- gemini-3-pro-image-preview
94+
- gemini-3-pro-image-preview-2k
95+
- gemini-2.5-flash-image-preview
96+
```
97+
98+
### 配置项说明
99+
100+
| 配置项 | 类型 | 必填 | 说明 |
101+
| --- | --- | --- | --- |
102+
| `mode` | string | ✅ | 过滤模式:`whitelist` 或 `blacklist` |
103+
| `list` | array | ✅ | 模型ID列表 |
104+
105+
### 过滤模式
106+
107+
- **whitelist (白名单模式)**:仅允许列表中指定的模型,其他模型将被过滤掉
108+
- **blacklist (黑名单模式)**:禁用列表中指定的模型,其他模型可正常使用
109+
110+
### 使用建议
111+
112+
::: tip 推荐使用 WebUI 配置
113+
推荐使用 WebUI 的适配器设置界面进行模型过滤器配置,可视化操作更加便捷。
114+
:::
115+
116+
::: warning 注意事项
117+
- 模型 ID 必须与适配器实际支持的模型 ID 完全匹配
118+
- 白名单模式下,如果列表为空或没有匹配的模型,将无法使用该适配器
119+
- 每个适配器的模型过滤器配置相互独立
120+
:::
121+
77122
## 聚合模式 (Merge)
78123

79124
聚合模式允许在单个标签页中支持多个后端,实现故障转移:

docs/config/overview.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,36 @@ browser:
8484
| `headless` | boolean | `false` | 是否启用无头模式 |
8585
| `proxy` | object | - | 全局代理配置 |
8686

87+
### 适配器配置 (backend.adapter)
88+
89+
每个适配器都可以配置专属的模型黑白名单,用于控制该适配器可以使用的模型列表。
90+
91+
| 配置项 | 类型 | 默认值 | 说明 |
92+
| --- | --- | --- | --- |
93+
| `modelFilter.mode` | string | - | 过滤模式:`whitelist` (白名单) 或 `blacklist` (黑名单) |
94+
| `modelFilter.list` | array | - | 模型列表(根据 mode 决定是启用列表还是禁用列表) |
95+
96+
::: tip 模型过滤说明
97+
- **whitelist (白名单模式)**:仅允许列表中的模型
98+
- **blacklist (黑名单模式)**:禁用列表中的模型,其他模型可用
99+
- 推荐使用 WebUI 进行配置
100+
:::
101+
102+
配置示例:
103+
104+
```yaml
105+
backend:
106+
adapter:
107+
lmarena:
108+
returnUrl: false
109+
modelFilter:
110+
mode: whitelist # 白名单模式
111+
list: # 仅启用以下模型
112+
- gemini-3-pro-image-preview
113+
- gemini-3-pro-image-preview-2k
114+
- gemini-2.5-flash-image-preview
115+
```
116+
87117
## 相关文档
88118

89119
- [实例配置](/config/instances) - 浏览器实例和 Worker 详细配置

docs/guide/first-use.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ http://localhost:3000
4343
- Windows: 直接在弹出的浏览器窗口中操作
4444

4545
2. **完成账号登录**:
46-
- 手动登录所需的 AI 网站账号
46+
- 手动登录所需的 AI 网站账号 (账号要求可进入 WebUI 的适配器管理中查看)
4747
- 在输入框发送任意消息, 触发并完成人机验证 (如需要)
4848
- 同意服务条款或者新手指引 (如需要)
4949
- 确保不再有初次使用相关内容的阻拦

0 commit comments

Comments
 (0)