Skip to content

Neo-MoFox WebUI / Plugin UI

Neo-MoFox WebUI 是机器人的浏览器管理界面,让你告别命令行,用网页管理机器人。Plugin UI 是其中的插件界面扩展子系统,允许任何插件在 WebUI 中注册自己的管理页面。

WebUI 使用教程

前置条件

使用 WebUI 前请先完成安装与登录密钥配置,详见 WebUI 部署指南

登录

打开浏览器访问 WebUI 地址(默认 http://localhost:8000/webui/frontend/),首次进入会跳转到登录页。

  • 管理员密码:在 Neo-MoFox 配置文件中设置的 HTTP API Key 即为登录密码
  • 登录后会话存于 sessionStorage,关闭浏览器标签后需重新登录

主页(控制台)

实时监控与统计总览。

  • 后端状态:Neo-MoFox 后端是否运行中
  • 今日消息:当天收发的消息数量
  • 运行时间:机器人已持续运行多久
  • 注册组件:当前加载的组件总数
  • 运行总览:活跃任务、协程池守护、事件订阅、调度成功率
  • LLM 数据:总请求数、成功率、输入 / 输出 Token、总花费
  • 插件统计:已加载 / 失败的插件数
  • 适配器状态:各适配器在线 / 离线
  • 消息趋势分析:过去 7/30/90 天的消息趋势图
  • 平台消息统计:按平台分组的消息数

配置管理

管理机器人核心配置文件,分三个标签页:

  • 机器人配置:编辑 config/bot_config.toml,包含机器人基本信息、权限、平台等
  • 模型配置:编辑 config/model.toml,配置各模型任务(actor、tool_use 等)与 API Key;在单个模型的编辑弹窗中,除常规「额外参数」外还提供 HTTP 特殊键(headers / query / body)三个独立编辑区,可分别注入请求头、URL 查询参数与请求体字段,留空表示不启用,三者会从 extra_params 中独立透传
  • MCP 配置:编辑 MCP 服务配置,挂载外部工具能力

保存后是否自动热重载由「设置 → 通用设置 → 配置编辑器」中的保存后自动热重载开关(默认开启)控制:开启时配置会自动应用到运行时,无需重启;关闭后仅写盘,需手动重启生效。少数无法热重载的配置项仍需重启。

插件配置

按插件维度编辑各自的 config.toml。每个插件配置项会根据其 manifest.json 中声明的字段类型自动渲染成对应的表单控件(开关、滑块、下拉、文本域等)。

  • 顶部可搜索插件
  • 点击插件卡片进入其配置表单
  • 保存后同样受「保存后自动热重载」开关控制:开启时自动热重载该插件的运行时配置,无需重载插件

插件管理

查看和管理已加载的插件。

  • 已加载 / 未加载两个分区,可搜索插件名或描述
  • 点击插件进入插件详情
    • 加载 / 重载 / 卸载并删除插件(卸载会永久删除插件文件,不可恢复)
    • 查看组件总数、组件类型分布、依赖数量
    • 组件列表按类型(Action / Adapter / Command / Router / Agent / Tool / Chatter / Config / Service)分组,显示活跃 / 未激活 / 错误状态
    • 元数据:源、可用项、主动作、权限级别

卸载不可恢复

「卸载并删除」会停止插件所有组件并永久删除插件的全部文件,操作前请确认。

聊天监视

按聊天流查看实时消息与上下文。

  • 左侧聊天流列表:显示所有群聊 / 私聊流,可搜索平台、名称、群组或预览
  • 顶部统计:聊天流数、分组数、通知连接 / 消息连接的 WebSocket 状态(已连接 / 连接中 / 已断开)
  • 选中流后查看消息窗口,支持加载更早消息、直接输入文本发送
  • 区分群聊 / 私聊 / 未知类型

LLM 统计

追踪模型请求、Token、成本与运行质量。

  • 总览:总请求数、总 Token(输入 / 输出)、总成本、成功率、缓存命中率
  • Token 分布:最近请求的 Token 趋势
  • 质量:成功 / 失败请求对比
  • 模型使用排行:哪个模型调用最多
  • 请求名:按 task name 分组的请求统计
  • 会话流:按 stream 维度的调用统计
  • 最近请求:最近一次调用的明细
  • 顶部可按时间窗口筛选(7 天 / 一个月)

请求体检视器

实时查看 Neo-MoFox 捕获的 OpenAI 兼容请求体,用于调试 LLM 调用。

  • 捕获请求数、最近更新时间、消息总数、工具声明数
  • 左侧请求列表:可搜索模型、API、提供商,显示每条请求的消息数 / 工具数
  • 选中后右侧查看详情,支持两种视图:
    • 结构化:渲染消息流(区分 tool_call / tool_result / media / 内容块)、工具 Schema、按角色过滤
    • Raw JSON:原始请求体
  • 顶部「清空」可清除当前内存中的捕获记录

日志查看

查看实时与历史日志,支持级别过滤、关键词搜索与日志多选。

  • 实时日志:通过 WebSocket 推送并使用虚拟滚动渲染;支持自动滚动到底部、回到底部、清空当前日志、连接 / 断开实时日志服务
  • 日志多选:左键点选切换、右键取消选中、按 Esc 清空全部选中;选中后底部浮现操作栏,显示已选条数,提供:
    • 全选 / 取消全选:再次点击切换
    • 复制:将选中日志复制到剪贴板
    • 取消选择:清空全部选中
  • 移动端:触控设备下日志行支持左滑选中,并在顶部提示「左滑可选中日志」
  • 历史日志:按日志文件浏览,支持文件搜索、关键词高亮、按级别过滤,可向前 / 向后滚动分页加载

插件中心

展示其他插件通过 Plugin UI 系统注册的自定义页面。

  • 从左侧列表选择一个插件页面开始使用
  • 支持搜索插件页面
  • 页面内容由各插件自行用 XML 声明式渲染(详见 UI 开发指南

设置

主题设置

自定义界面配色与外观。

  • 外观模式:跟随系统 / 浅色 / 深色
  • 主题色:预设颜色(深空蓝、翡翠绿、珊瑚橙、薰衣草、玫瑰红、金黄色)、壁纸取色、自定义颜色
  • 背景壁纸:上传自定义壁纸图片或视频,调整模糊度与不透明度,可删除

通用设置

调整界面语言、字体与系统行为偏好。

  • 界面语言:简体中文 / English
  • 字体大小:小 / 中 / 大
  • 系统
    • 自动更新:发现新版本后自动下载并安装
    • 启动时检查更新:每次启动时自动检测是否有新版本
  • 配置编辑器
    • 保存后自动热重载:开启后,在「配置管理」「插件配置」中保存配置会自动应用到运行时,无需重启(默认开启)
  • 修改后自动保存,可「重新获取」或「恢复默认」

数据管理

备份或还原 WebUI 全量配置。

  • 导出配置:将当前所有设置(主题、界面、系统、配置编辑器)导出为 JSON 文件,可用于备份或迁移
  • 导入配置:上传或粘贴 JSON 配置文件,完全替换当前所有设置(操作前请确认 JSON 内容正确)

Plugin UI 开发指南

Plugin UI 系统提供两种渲染模式:

模式说明适用场景
XML 模式使用声明式 XML 描述界面,由 WebUI 内置渲染引擎解析为 Vue 组件树表单、配置页、数据展示等标准管理界面
HTML 模式插件自行提供 HTML/CSS/JS 资源,WebUI 以 Shadow DOM 沙箱加载,注入 sys 桥接对象需要完全自定义 UI 的复杂场景、需要第三方 JS 库

对于大多数插件,XML 模式即可满足需求——你只需在后端 Service 调用中传入一段 XML 字符串,WebUI 就能自动渲染出 Material Design 3 风格的交互界面。

需要图表可视化、Canvas / WebGL、复杂表单编排或第三方 JS 库(ECharts、Monaco 等)时,可切换到 HTML 模式:你写原生 HTML / CSS / JS,运行在独立 Shadow DOM 沙箱中,通过 sys 桥接对象调系统接口。两种模式共享同一套 sys-* 组件。

开发指南目录

文档说明
UI 开发指南 · 总览整体架构、核心概念、前提条件
UI 开发指南 · XML 入门XML 轨语法、语法糖、管道指令、API 模板、表达式、移动端适配
UI 开发指南 · XML 组件参考XML 轨所有内置组件的属性与用法
UI 开发指南 · HTML 开发HTML 轨资源结构、Shadow DOM 沙箱、sys 注入
UI 开发指南 · HTML 组件参考HTML 轨 sys-* 自定义元素的命令式用法
UI 开发指南 · HTML sys APIsys 桥接对象的完整 API 参考

贡献者

The avatar of contributor named as minecraft1024a minecraft1024a
The avatar of contributor named as micraft1024a micraft1024a

页面历史

Released under the GPL-3.0 License.