docs: 添加 webui 说明

This commit is contained in:
Junyan Qin
2024-11-17 00:09:19 +08:00
parent e34850b7fa
commit 1913f8c7fb
13 changed files with 77 additions and 0 deletions
+8
View File
@@ -134,6 +134,14 @@ export default defineConfig({
{ text: "技术信息", link: "/plugin/tech-info" },
],
},
{
text: "管理面板(Beta测试)",
items: [
{ text: "介绍 & 使用", link: "/webui/intro" },
{ text: "系统操作", link: "/webui/system" },
{ text: "设置项管理", link: "/webui/settings" },
]
},
// {
// text: "规模化和商用",
// // collapsed: true,
Binary file not shown.

After

Width:  |  Height:  |  Size: 187 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 186 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 320 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 99 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 73 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 80 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 75 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 134 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 65 KiB

+21
View File
@@ -0,0 +1,21 @@
# 管理面板(Beta测试)
管理面板(WebUI)将在 v3.4.0 版本开始 Beta 测试,有任何问题或建议欢迎反馈到:https://github.com/RockChinQ/LangBot/issues
![WebUI](/assets/image/webui_intro_01.png)
## 部署 WebUI
依据本文档所述的部署方式新部署的实例,均自带 WebUI,默认启用。
### 从低于 3.4.0 版本升级的实例?
若是使用 Docker 拉取最新的镜像,也自带有 WebUI;若是手动部署的实例,请从 [Releases](https://github.com/RockChinQ/LangBot) 页面下载最新版的 `langbot-xxx-all.zip` 文件,解压覆盖之前部署的代码目录。
## 未实现功能
- Prompt 编辑器:单独一页,实现一个直观、便捷的 Prompt 编辑器。
- 消息平台管理页:现在仅支持在 设置 页修改消息平台,后续将把消息平台的修改、重载、统计整合到单独一页。
- 元数据文件编辑:目前暂不支持元数据编辑,请先根据文档修改文件内容来编辑。
- 模型数据更改:动态编辑模型元数据、所使用的模型、各会话区分模型等功能将在元数据编辑支持后规划,目前请先根据文档手动编辑文件。
+31
View File
@@ -0,0 +1,31 @@
# 设置项管理
设置项编辑页的内容均对应[功能配置页](/config/function/platform.html)中各个配置文件的内容。目前支持`可视化编辑`和`JSON编辑`两种,JSON 编辑器与功能配置页中的配置文件内容一致,可直接编辑。
## 可视化编辑
### 基本字段
基本的字段直接编辑或者选择即可。
![开关](/assets/image/webui_settings_01.png)
![文本框](/assets/image/webui_settings_02.png)
### 字符串数组
输入要添加的字符串,按回车键即可添加。
![字符串数组](/assets/image/webui_settings_03.png)
### 对象数组
例如消息平台适配器,数组内均为对象,可以点击下方`添加`按钮,添加新的适配器,选择类型后会展示对应需要填写的参数,按照文档所述填写。
![对象数组](/assets/image/webui_settings_04.png)
![添加对象](/assets/image/webui_settings_05.png)
::: tip
消息平台适配器更改之后需要手动进行[`热重载`](/webui/system.html#%E7%83%AD%E9%87%8D%E8%BD%BD)以生效
:::
+17
View File
@@ -0,0 +1,17 @@
# 系统操作
## 任务列表
任务列表中跟踪了`插件更新`、`插件安装`、`插件删除`等耗时任务的进度。
点击侧栏下方的任务列表按钮,在任务列表对话框,可以查看任务执行步骤、日志等信息。
![任务列表对话框](/assets/image/webui_system_02.png)
![任务日志](/assets/image/webui_system_03.png)
## 热重载
目前支持热重载 消息平台 和 插件,点击侧栏下方的系统信息中的对应按钮即可。
在修改了 `消息平台适配器配置` 之后需要手动热重载,插件更改则会自动热重载。
![热重载](/assets/image/webui_system_04.png)