Skip to main content

A lightweight WebUI management console for NoneBot2

Project description

NoneBot Plugin

Mimo Console

随 NoneBot2 运行的 WebUI 管理面板。

PyPI Python CI License

能做什么

  • 查看 CPU、内存、磁盘、网络、进程占用和运行时间。
  • 查看当前连接的 Bot、适配器和已加载插件。
  • 搜索 NoneBot 官方插件商店,安装、更新或卸载插件。
  • 在网页中修改 dotenv 配置,敏感字段自动脱敏,保存前自动备份。
  • 搜索和筛选当前进程日志。
  • 自定义 WebUI 背景图,支持远程链接或本地上传。
  • 检测 GitHub 最新版本并一键更新,概览页支持重启 NoneBot。
  • 使用初始化令牌创建管理员,后续通过账号密码登录。

前端资源随插件一起安装,不依赖单独的 Web 服务,也不绑定任何消息适配器。

安装

使用 NB-CLI:

nb plugin install nonebot-plugin-mimo-console

或使用 uv / pip:

uv add nonebot-plugin-mimo-console
# pip install nonebot-plugin-mimo-console

使用 uv 或 pip 安装后,请确认 NoneBot 项目的 pyproject.toml 已加载插件:

[tool.nonebot]
plugins = ["nonebot_plugin_mimo_console"]

项目需要启用 FastAPI 驱动:

DRIVER=~fastapi

启动 NoneBot 后,日志会显示 WebUI 地址和首次初始化令牌。默认地址:

http://127.0.0.1:8080/mimo-console/

第一次打开时输入日志中的令牌并创建管理员;完成初始化后只需使用管理员账号登录。

配置

所有配置均可省略。

配置项 默认值 作用
MIMO_CONSOLE_PATH /mimo-console WebUI 挂载路径
MIMO_CONSOLE_PROJECT_ROOT 当前工作目录 NoneBot 项目目录
MIMO_CONSOLE_SESSION_HOURS 72 登录有效时长,范围 1-720 小时
MIMO_CONSOLE_ENABLE_STORE true 显示官方插件商店
MIMO_CONSOLE_ALLOW_PACKAGE_MANAGEMENT true 允许安装、更新和卸载插件
MIMO_CONSOLE_STORE_CACHE_SECONDS 600 商店数据缓存时间
MIMO_CONSOLE_PACKAGE_TIMEOUT 300 插件操作超时时间(秒)
MIMO_CONSOLE_GITHUB_PROXY GitHub 加速前缀或镜像仓库地址,用于 README、版本检查和自更新

超级用户也可以发送 mimo控制台NoneBot控制台 获取访问地址。

版本更新与重启

  • 概览页显示当前版本,并与 GitHub 最新 release 比对,有新版时可一键通过 nb plugin update 自更新(结果缓存约 30 分钟)。
  • 更新与修改配置一样,需要重启 NoneBot 才能生效。
  • 概览页的「重启」按钮会发送 SIGINT 让进程优雅退出,需要 NoneBot 进程由外部进程管理器托管(systemd / MCSManager autoRestart / pm2 / Docker restart=always 等)才会自动重新拉起;未托管时进程会停止。

数据与安全

  • Mimo Console 具有修改 dotenv、管理 Python 包、查看日志、禁用插件响应器和触发进程重启等高权限能力,其权限等同于运行 NoneBot 的系统用户。
  • 不建议将 WebUI 直接暴露到公网;确需公网访问时,应在反向代理层启用 HTTPS、来源限制或额外认证。
  • 不需要在线安装、更新和卸载插件时,建议设置 MIMO_CONSOLE_ALLOW_PACKAGE_MANAGEMENT=false
  • 管理员数据由 nonebot-plugin-localstore 保存,不会写进插件安装目录。
  • Token、Secret、Password、Cookie、API Key 等配置值默认脱敏。
  • 配置修改会生成备份,重启 NoneBot 后生效;修改项目配置和依赖前仍建议自行备份。
  • 自定义背景图保存在 localstore 数据目录,上传文件名随机化;远程 URL 仅允许 http/https,浏览器端加载,不做服务端可达性校验。
  • “禁用插件”只会阻止对应插件的 Matcher 继续响应事件,不会停止其已注册的后台任务;Mimo Console 自身不可被禁用。

本地开发

uv sync --all-groups
uv run poe test
uv run ruff check .
uv build

项目使用 GPL-3.0 协议。

致谢

感谢M

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nonebot_plugin_mimo_console-0.1.8.tar.gz (72.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nonebot_plugin_mimo_console-0.1.8-py3-none-any.whl (77.2 kB view details)

Uploaded Python 3

File details

Details for the file nonebot_plugin_mimo_console-0.1.8.tar.gz.

File metadata

  • Download URL: nonebot_plugin_mimo_console-0.1.8.tar.gz
  • Upload date:
  • Size: 72.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.32 {"installer":{"name":"uv","version":"0.11.32","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for nonebot_plugin_mimo_console-0.1.8.tar.gz
Algorithm Hash digest
SHA256 15bc969e9a09f104c8e759e05e32a5ae4292a2e1ca2b5d5712141ff72fbc40b9
MD5 26e29177024a0cd3efdbbe6fd8322168
BLAKE2b-256 f79aaf4a349d193633802c90e52450e0273f43455f21725c42ba0e673dc4da4f

See more details on using hashes here.

File details

Details for the file nonebot_plugin_mimo_console-0.1.8-py3-none-any.whl.

File metadata

  • Download URL: nonebot_plugin_mimo_console-0.1.8-py3-none-any.whl
  • Upload date:
  • Size: 77.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.32 {"installer":{"name":"uv","version":"0.11.32","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for nonebot_plugin_mimo_console-0.1.8-py3-none-any.whl
Algorithm Hash digest
SHA256 82734419005f3c970260650ee0fc3bd7e62f2aee8717b3e0230aafd47233a7b9
MD5 22341d5d5e9a9dc0c831e90045d52fac
BLAKE2b-256 56a0ea620d384f5b40f6512487949b7b31834912d5a76e4326c62e83a6507bd5

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page