diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 376455af1..e3808e394 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -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, diff --git a/docs/assets/image/webui_intro_01.png b/docs/assets/image/webui_intro_01.png new file mode 100644 index 000000000..2a11303c5 Binary files /dev/null and b/docs/assets/image/webui_intro_01.png differ diff --git a/docs/assets/image/webui_settings_01.png b/docs/assets/image/webui_settings_01.png new file mode 100644 index 000000000..25f5e25f6 Binary files /dev/null and b/docs/assets/image/webui_settings_01.png differ diff --git a/docs/assets/image/webui_settings_02.png b/docs/assets/image/webui_settings_02.png new file mode 100644 index 000000000..0268da370 Binary files /dev/null and b/docs/assets/image/webui_settings_02.png differ diff --git a/docs/assets/image/webui_settings_03.png b/docs/assets/image/webui_settings_03.png new file mode 100644 index 000000000..157e9af36 Binary files /dev/null and b/docs/assets/image/webui_settings_03.png differ diff --git a/docs/assets/image/webui_settings_04.png b/docs/assets/image/webui_settings_04.png new file mode 100644 index 000000000..88e30481a Binary files /dev/null and b/docs/assets/image/webui_settings_04.png differ diff --git a/docs/assets/image/webui_settings_05.png b/docs/assets/image/webui_settings_05.png new file mode 100644 index 000000000..e34a1cbfc Binary files /dev/null and b/docs/assets/image/webui_settings_05.png differ diff --git a/docs/assets/image/webui_system_02.png b/docs/assets/image/webui_system_02.png new file mode 100644 index 000000000..c96e2a8a3 Binary files /dev/null and b/docs/assets/image/webui_system_02.png differ diff --git a/docs/assets/image/webui_system_03.png b/docs/assets/image/webui_system_03.png new file mode 100644 index 000000000..a60fe981b Binary files /dev/null and b/docs/assets/image/webui_system_03.png differ diff --git a/docs/assets/image/webui_system_04.png b/docs/assets/image/webui_system_04.png new file mode 100644 index 000000000..029b441a9 Binary files /dev/null and b/docs/assets/image/webui_system_04.png differ diff --git a/docs/webui/intro.md b/docs/webui/intro.md new file mode 100644 index 000000000..f34a1ef9b --- /dev/null +++ b/docs/webui/intro.md @@ -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 编辑器。 +- 消息平台管理页:现在仅支持在 设置 页修改消息平台,后续将把消息平台的修改、重载、统计整合到单独一页。 +- 元数据文件编辑:目前暂不支持元数据编辑,请先根据文档修改文件内容来编辑。 +- 模型数据更改:动态编辑模型元数据、所使用的模型、各会话区分模型等功能将在元数据编辑支持后规划,目前请先根据文档手动编辑文件。 + diff --git a/docs/webui/settings.md b/docs/webui/settings.md new file mode 100644 index 000000000..41c9b9d4f --- /dev/null +++ b/docs/webui/settings.md @@ -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)以生效 +::: \ No newline at end of file diff --git a/docs/webui/system.md b/docs/webui/system.md new file mode 100644 index 000000000..7a4e42e9d --- /dev/null +++ b/docs/webui/system.md @@ -0,0 +1,17 @@ +# 系统操作 + +## 任务列表 + +任务列表中跟踪了`插件更新`、`插件安装`、`插件删除`等耗时任务的进度。 +点击侧栏下方的任务列表按钮,在任务列表对话框,可以查看任务执行步骤、日志等信息。 + +![任务列表对话框](/assets/image/webui_system_02.png) + +![任务日志](/assets/image/webui_system_03.png) + +## 热重载 + +目前支持热重载 消息平台 和 插件,点击侧栏下方的系统信息中的对应按钮即可。 +在修改了 `消息平台适配器配置` 之后需要手动热重载,插件更改则会自动热重载。 + +![热重载](/assets/image/webui_system_04.png) \ No newline at end of file