yiyungent/KnifeHub

Introduce

🧰 简单易用的效率工具平台

• 简单易用 - 拒绝折腾, 专注于工作, 而非工具
• Web 可视化 - 无需再在 Console 上操作, 轻松上手
• 插件化架构 - 轻松使用插件扩展
• 多平台多架构 - win,linux,osx,amd,arm 均可

注意 : QQBotHub 更名为 KnifeHub , 将不再局限于机器人开发

通知
请尽快更新到 最新版 (KnifeHub-v1.1.0 +) ,
v1.1.0 开始将静默发送异常日志等到服务端, 使用本软件即代表同意此隐私授权

注意 : 本项目仅供学习使用, 所有第三方插件与本项目无关

功能

• 大部分功能由插件提供

Screenshots

PluginCore Admin

WebMonitorPlugin

Telegram 通知, 还会附加一张网页截图

QQStatPlugin

Quick Start

部署

PluginCore Admin 用户名 与 PluginCore Admin 密码 为你自己设置的后台登录用户名与密码, 随意设置即可, 自己记住就行

方式1：原生部署 (适合小白)

Releases - KnifeHub, 点我下载
找到并下载 KnifeHub 相应平台压缩包,
(Windows 系统 一般下载 Windows-64 版本即可, 即 KnifeHub-win-x64.zip)
解压里面有 KnifeHub.Web.exe , 运行它即可 (无需再安装其它任何运行库)
黑窗口中会显示一个 url 地址（Now listening on:后跟随的地址）, 复制到浏览器中打开即可 保持此黑窗口在后台运行即可

方式2: 使用 Zeabur 免费 一键部署

• 点击下方按钮 一键部署
• 免费注册, 无需信用卡验证
• 每月 $5.00 免费额度
• 无需保活, 在免费额度用完之前永不停止运行

Zeabur 环境变量

注意:
修改环境变量后, 需 Redeploy 才能生效

方式3: 使用 Render 免费 一键部署

注意: 此种方式 KonataPlugin 可能无法登录上线

• 点击下方按钮 一键部署
• 免费注册, 无需信用卡验证
• Free Instance Hours: 750 hours/month
• Free Bandwidth: 100 GB/month
• Free Build Minutes: 500 min/month
• 注意 : 免费实例类型上的 Web 服务在闲置 15 分钟后会自动停止运行, 当一个新的免费服务请求进来时, Render 会再次启动它, 以便它可以处理该请求, 因此为了保证存活, 请使用第三方监控保活, 例如: UptimeRobot: 免费网站监控服务

Render 环境变量

方式4: 使用 Railway 免费 一键部署

• 点击下方按钮 一键部署
• 免费注册, 无需信用卡验证
• 每月 $5.00 免费额度 / 每月 500 小时免费执行时间
• 无需保活, 在免费额度用完之前永不停止运行

Railway 环境变量

注意:

• Railway 修改环境变量 会 触发 重新 Deploy
• Railway 重新 Deploy 后会删除数据, 你安装的所有插件及数据都将清空。

方式5: 使用 Heroku 一键部署

注意：此种方式 KonataPlugin 可能无法登录上线

• 点击下方按钮 一键部署
• 注意 : Heroku 应用一段时间不访问会自动休眠, 因此为了保证存活, 请使用第三方监控保活, 例如: UptimeRobot: 免费网站监控服务

Heroku 环境变量

方式6: 使用 Docker

注意 : 请不要映射/挂载 容器内 /app/Plugins/ 目录, 否则可能导致 插件无法正常上传 , 此问题解决中

docker run -d --restart=always -p 53213:80 -e ASPNETCORE_URLS="http://*:80" -e ASPNETCORE_ENVIRONMENT="Production" -e TZ="Asia/Shanghai"  --name knifehub yiyungent/knifehub

# 可选, 进入容器 管理, 例如修改 /app/App_Data/PluginCore.Config.json 中的 PluginCore Admin 用户名与密码
docker exec -it knifehub bash

现在访问: http://your-domain/PluginCore/Admin your-domain 为黑窗口中显示的 url 地址

插件管理

访问: https://your-domain/PluginCore/Admin 进入 PluginCore Admin

插件:
下载插件包,

插件包下载见 Release , 直接插件上传 下载的 QQHelloWorldPlugin-net6.0.zip 即可

然后直接 上传 -> 安装 -> 文档 -> 设置 -> 启用 -> 文档 即可

守护进程(daemon)

守护进程: 开机自启动, 程序异常退出时自动重启程序

Windows

方式1: 简易 PowerShell 实现

PowerShell 实现简易 KnifeHub.Web.exe 异常退出时自动重启 KnifeHub.Web.exe
下载 仓库根目录 utils/start.ps1 utils/corn.ps1
将 start.ps1 与 corn.ps1 放入与 KnifeHub.Web.exe 同目录文件夹下,
使用 Windows Terminal / PowerShell 运行 start.ps1 即可

# 确保进入程序目录再执行
cd "KnifeHub-win-x64/win-x64"

./start.ps1

方式2: ProcessGuard

强烈推荐新人使用, 稳定强大

Linux

推荐使用 Supervisor

更新 KnifeHub

查看最新版 Releases - KnifeHub

若你使用 Railway 一键部署,
只需要修改 Railway 创建的仓库 (例如: KnifeHub) 里的 Dockerfile 文件里的 yiyungent/knifehub:v0.5.2 , 更新最后的版本号 v0.5.2 到最新版即可

注意:
请更新前导出插件数据, QQStatPlugin 支持下载数据库到本地, 然后下载最新插件包, 解压, 将数据库文件替换为你导出的数据库文件, 然后在有 QQStatPlugin.sqlite 的路径下打包所有文件 为 zip, 上传插件即可
插件设置 可以通过保持打开插件设置页面的方式, 重新安装插件后, 再在此页面点击保存

一些更新 docker knifehub 可能需要用到的命令

cd /www/wwwroot/knifehub*
# docker-data 位置用于保存当前容器数据
mkdir -p docker-data/App_Data/
mkdir -p docker-data/Plugins/
mkdir -p docker-data/Plugins_wwwroot/
# 保存当前数据
docker cp knifehub:/app/App_Data/PluginCore.Config.json docker-data/App_Data/PluginCore.Config.json
docker cp knifehub:/app/App_Data/plugin.config.json docker-data/App_Data/plugin.config.json
docker cp knifehub:/app/Plugins/ docker-data/
docker cp knifehub:/app/Plugins_wwwroot/ docker-data/

# 移除当前
docker stop knifehub
docker rm knifehub
docker rmi yiyungent/knifehub

# 获取最新
# 建议不要使用 latest , 而是指定最新的版本号, 有可能你使用的 docker 仓储源还未同步, 而导致 latest 仍为旧版
#docker pull yiyungent/knifehub:v1.0.0
docker pull yiyungent/knifehub:latest
docker run -d --restart=always -p 53213:80 -e ASPNETCORE_URLS="http://*:80" -e ASPNETCORE_ENVIRONMENT="Production" -e TZ="Asia/Shanghai"  --name knifehub yiyungent/knifehub

# 这里我将原本备份的数据保存到了这个路径, 进入这个路径, 将备份数据覆盖到 docker 容器中
cd docker-data

docker cp App_Data/PluginCore.Config.json knifehub:/app/App_Data/PluginCore.Config.json
docker cp App_Data/plugin.config.json knifehub:/app/App_Data/plugin.config.json
docker cp Plugins/ knifehub:/app/
docker cp Plugins_wwwroot/ knifehub:/app/

# 重启容器
docker restart knifehub

插件开发

开发必读

注意:
所有纯基于 PluginCore.IPlugins 开发的插件都通用,
下载插件包, 然后 上传 -> 安装 -> 设置 -> 启用 即可

插件开发 可参考:

• 插件开发 | PluginCore
• 建议 参考: ./plugins/QQHelloWorldPlugin

KnifeHub 插件开发包
插件开发包中已包含:

• PluginCore.IPlugins.AspNetCore

注意: 如果你不需要 KnifeHub.Sdk 中的一些 Utils , 那么建议直接依赖 PluginCore.IPlugins.AspNetCore , 减少依赖项, 使之称为通用插件

dotnet add package KnifeHub.Sdk

注意:

• 本项目目前直接使用的 PluginCore 插件框架, 插件采用激发式, 插件工作完成后, 实例会立即销毁, 无法常驻后台
• 若需要定时任务, 可以使用 ITimeJobPlugin, 可见 PluginCore 的文档
• 由于 QQBot 本身为常驻, 因此需额外注意 IPluginFinder 的服务的生命周期/范围, 这点和在 ASP.NET Core 的 Controller 中 直接使用不同

在线开发

使用 Replit 在线开发 | 点我前往

• 预设 Replit 开发模板
• 免费注册, 无需信用卡验证
• 免费在线实验环境, 可启动项目
• Console/Shell 支持
• 未注册用户注册登录后, 再回到此处点击上方链接, fork 此 Replit 模板项目, 基于此开发更方便, 但此模板可能不是最新版, 建议在实验环境中 git pull
• 注意: 此实验环境 KonataPlugin 无法登录上线, 你依然需要做本地测试

相关项目

• KonataDev/Konata.Core - QQ Android 协议核心库
• Chianne1025/QQChannelFramework - QQ 频道 核心库
• yiyungent/PluginCore - 插件系统

社区插件

欢迎 Pull Request !

• SweelLong/AntiRecall: 这是基于KnifeHub - KonataPlugin的开源插件，功能是防止消息撤回。
• SweelLong/RandomImage: 这是基于QQBotHub的开源插件，主要功能是发送随机图片。（短期内不会更新）

赞助者

本列表由 afdian-action 自动更新

感谢这些来自爱发电的赞助者：

Donate

KnifeHub is an Apache-2.0 licensed open source project and completely free to use. However, the amount of effort needed to maintain and develop new features for the project is not sustainable without proper financial backing.

We accept donations through these channels:

• 爱发电 (￥5.00 起)
• 面包多 (￥1.00 起)

License

Author

• KnifeHub.Web Apache-2.0
• KnifeHub.Sdk Apache-2.0
• QQHelloWorldPlugin GPL-3.0
• MoLiPlugin GPL-3.0
• QQStatPlugin GPL-3.0
• BackupPlugin MIT
• AutoLoginPlugin GPL-3.0
• QQNotePlugin GPL-3.0
• ZhiDaoPlugin GPL-3.0
• WebMonitorPlugin Apache-2.0
• QQChannelPlugin MIT
• MoLi4QQChannelPlugin MIT

KnifeHub © yiyun, Released under the GPL-3.0 License.
Authored and maintained by yiyun with help from contributors (list).

GitHub @yiyungent Gitee @yiyungent