Appearance
Haruki分布式部署文档
本教程包括部署与配置Haruki分布式客户端与Bot端的大部分内容
准备工作
WARNING
部署本项目需要一定的电脑基础,会读文档,推荐使用vscode之类的阅读器查看文档
部署bot这一行为可能违反腾讯的用户协议,因此可能导致的 QQ 账号被封禁或限制等一切后果,开发者不予承担。
请合理使用本分布式客户端,恶意使用可能会被开发者收回使用权限、永久拉黑。
Haruki Dev群号:959939201 如遇任何问题请在自我排除后附上截图在群里询问!!!
客户端注册过程中要求你填写的QQ号为你本人的QQ号,而非你使用Bot的账号
请不要把Bot账号拉进来!
请勿将HarukiClient用于QQ官方机器人!这会导致Haruki Cloud的绑定数据异常!
获取一台服务器
你需要一台24h不关机的电脑,否则关机这段时间HarukiBot将无法工作,此处推荐购买雨云运行
Windows 电脑需要运行大于等于 Windows 8 或 Windows server 2012 版本的系统(更低版本实测无法运行)
Linux 系统推荐使用 Ubuntu 22.04
, Debian 12
或以上的Linux发行版系统
macOS仅提供Apple Silicon (即arm64)的打包文件,x86的macOS不提供支持
在较低版本 Ubuntu 和其他较低版本 Linux 中可能提示缺少 GLIBC 对应版本,安装非常麻烦,不推荐使用。
客户端安装与配置
在群文件中下载对应系统的客户端(群文件客户端文件夹中)与配置文件(群文件主目录7月4日)
text
Windows HarukiClient-Windows-x64-v1.1.7.zip
Linux HarukiClient-Linux-amd64-v1.1.7-glibc.app
WARNING
Windows版本并非单文件,请把所有文件解压缩出来,Linux无需解压.app文件
请务必不要使用Windows自带的解压缩解压Windows客户端,否则解压的时候会报错从而解压失败
推荐使用7zip解压:https://www.7-zip.org/
如果官网下载失败可以在群文件主目录9月4日找到win-x64安装包:7z2501-x64.exe
将配置文件放在解压出的文件同目录文件目录的位置,否则客户端会闪退
文件结构应与下列一致
(解压出的文件夹或纯英文目录的文件夹)
├ configs.json
└ HarukiClient-xxx-v1.1.7.exe/.app
配置文件configs.json
json
{
"host": "127.0.0.1", //反向代理地址
"port": 8000, //反向代理端口
"botId": null, //客户端ID,验证时自动获取
"credential": "", //客户端credit,验证时自动获取
"enableHelp": true, //启用客户端的help指令
"controlApiAccessToken": null, //客户端内置API的鉴权token,如果需要再填写
"enableModules": [ //启用功能列表
"all"
],
"runMode": "blacklist", //执行模式(黑名单/白名单)
"blacklists": { //黑名单列表
"all": [], //所有功能黑名单
"pjsk": [] //pjsk相关功能黑名单
},
"whitelists": { //同上
"all": [],
"pjsk": []
},
"additionalFuncWhitelists": [], //娱乐功能白名单
"botAdmins": [], //客户端管理员(填写进群验证的QQ号,不加引号)
"userBlacklists": [], //为用户黑名单,添加进此的用户会无法使用你的Haruki分布式
"enableGroupCommandLimit": false, //为是否启用全局消息限制
"globalCommandHourlyLimit": null, //为每小时限制回复的消息数量,达到此数量之后该小时之内不会再响应任何指令
"globalCommandDailyLimit": null, //为每天限制回复的消息数量,达到此数量之后次日北京时间8点之前不会再响应任何指令
"enableCN": true //为是否启用国服功能
}
客户端的配置告一段落,接下来进入Bot端部署
Bot端部署以及几种推荐使用的方案
请使用支持 OneBot V11 协议的 QQ 客户端
1.Lagrange.OneBot
首先,需要有一台服务器或者24小时开机联网的电脑,以保证您部署的bot能一直运行。
其次,请在该设备上下载 Lagrange.OneBot。
下载链接:
- Lagrange.OneBot: https://github.com/LagrangeDev/Lagrange.Core/releases/tag/nightly
- 按设备架构进行安装,如果不知道的话可以参照下面的
- 一般windows设备选择win-x64_net9.0
- 一般linux服务器选择linux-x64_net9.0
接着,从\Lagrange.OneBot\bin\Release\net9.0\linux-x64(win-x64)\publish中提取出Lagrange.OneBot文件
如果是linux系统,需要使用chmod +x Lagrange.OneBot给予可执行权限
然后运行,第一次运行后先退出,修改生成的appsettings.json文件
需要修改的地方:
(版本号无法公开传播请询问群友或者通过lgr官方群或者readme获取)
"SignServerUrl": "https://sign.lagrangecore.org/api/sign/版本号"
"MusicSignServerUrl": "https://ss.xingzhige.com/music_card/card"
如果遇到提示qq版本过低无法登录,一般签名服务器修改最新的版本号即可
按照以下格式添加或修改ws反代,默认应存在一个127.0.0.1和8080端口的配置,请修改suffix为/ws,端口为8000
添加新的ws反代请在{}后,[]内添加,每一项{}之间用,隔开
json
"Implementations": [
{
"Type": "ReverseWebSocket",
"Host": "127.0.0.1",
"Port": 8000,
"Suffix": "/ws",
"ReconnectInterval": 5000,
"HeartBeatInterval": 5000,
"AccessToken": ""
}
]
确认括号成对后保存,再次运行lgr,扫码登录bot账号即可
2.Napcat
首先,需要有一台服务器或者24小时开机联网的电脑,以保证您部署的bot能一直运行。
其次,请在该设备上下载 Napcat。
下载安装启动方式:
Windows
展开最新一个版本的Assets,下载NapCat.Shell.Windows.OneKey.zip文件并解压
启动 NapCatInstaller.exe 等待自动化配置(占空间略大,可以自行选择上述解压路径)
进入 NapCat.XXXX.Shell 文件夹,启动napcat.bat扫码登录(如果提示QQ损坏就把所有文件删了重新安装一次)
登陆后,使用客户端或者webui,点击左侧网络配置选项,右侧左上角新建选择websocket客户端,url填入 ws://127.0.0.1:8000/ws
名称随意,记得点击左上角启动并保存(如需添加其他bot地址,请重复上述操作并填入对应url)
现版本webui默认随机密码token,请在webui.json文件下查看,如无需公网访问webui请将host改为127.0.0.1,port改为0,若需公网使用请临时开启使用后关闭,并使用非默认端口。
webui启用时,启动后可在启动日志中看到形如 [WebUI] WebUI Local Panel Url: http://127.0.0.1:6099/webui?token=xxxx 的 token 信息。
json{ "host": "0.0.0.0", // WebUI 监听地址 "port": 6099, // WebUI 端口 "token": "xxxx", // 登录密钥, 默认是自动生成的随机登录密码 "loginRate": 3, // 每分钟登录次数限制 }
或者登陆后退出,通过手动修改文件配置。进入NapCat.XXXX.Shell\versions\9.9.19-34740\resources\app\napcat\config文件夹
现在这里应该有onebot11_{刚才登录的QQ号}.json
打开该文件,在"websocketClients"的[]里填入以下内容:
json{ "name": "websocket-client-0", "enable": true, "url": "ws://127.0.0.1:8000/ws", "messagePostFormat": "array", "reportSelfMessage": false, "reconnectInterval": 5000, "token": "", "debug": false, "heartInterval": 30000 }
Debian/Ubuntu/Centos等linux系统
在命令行输入以下命令下载,安装选项可以默认,也可以根据需要自行调整
- bash
curl -o
napcat.sh
https://nclatest.znin.net/NapNeko/NapCat-Installer/main/script/install.sh
&& sudo bash napcat.sh
启动nc
- bash
sudo xvfb-run -a /opt/QQ/qq --no-sandbox #第一次登录请扫码 sudo xvfb-run -a /opt/QQ/qq --no-sandbox -q QQ号 #以后使用
- 安装完成后先通过napcat start QQ号启动,然后结束,并进入/opt/QQ/resources/app/app_launcher/napcat/config,打开onebot11_{刚才登录的QQ号}.json
- 修改websocketClients的值(和Windows的配置相同,复制粘贴ok)
- 保存后再次登录即可
- Linux也可使用webui进行配置
更多更详细安装方式请访问https://napneko.pages.dev/guide/boot/Shell
3.LLOnebot(仅说明,推荐换用Napcat)
Windows
首先确认你已经安装了64位的原版无插件NTQQ
打开浏览器,输入以下链接:https://github.com/LLOneBot/LLOneBot/releases
下载LLOneBot-win-x64-ffmpeg.zip解压后双击运行exe即可
安装完毕后,登录你所需要挂bot的QQ号,之后打开 QQ 的设置,看到了LLOneBot就代表安装成功了。
打开LLOneBot设置选择反向ws代理,并添加以下地址:ws://127.0.0.1:8000/ws
配置文件,webui配置请查看文档:https://llonebot.com/guide/getting-started
客户端使用与验证
###配置完毕bot端后使用管理员权限运行/sudo运行Haruki客户端
Windows
powershell
HarukiClient-Windows-x64-v1.1.7.exe 或 双击运行
Linux(如Ubuntu/Debian/AlmaLinux)
由于Linux-glibc客户端原名较长可选择重命名,例如hrkClient.app
sh
sudo chmod 777 HarukiClient-Linux-amd64-v1.1.7-glibc.app
./HarukiClient-Linux-amd64-v1.1.7-glibc.app
###准备就绪后可尝试启动客户端,如果没有问题会显示如下日志:
text
[xxxx-xx-xx xx:xx:xx] Detected no bot account configured, starting registration...
当你遇到下面的提示的时候,请填写你的**大号QQ号/进群的QQ账号(不是bot账号)**来获取验证码
text
Please enter your Instant Messenger User ID (QQ is your qq number):
当你看到如下消息时,请在Haruki Dev群内发送/haruki_verify <客户端里显示的六位数字>
完成注册,请注意不要将<>一起包括在内:
text
[xxxx-xx-xx xx:xx:xx] Your verification code is {verification_code}, verification code will be expired in 10 minutes.
[xxxx-xx-xx xx:xx:xx] Please enter after finishing register verification.
此时群里机器人会提示Successfully verified,或者群友会发啃,偷啃,口啃之类字样
回到客户端处按回车完整通过验证。 如果没有回车就退出了客户端,不会保存配置需要重新验证
验证完毕此时客户端后台应该显示这样的语句
text
[2025-09-05 23:35:12 +0800] [28620] [INFO] Running on http://127.0.0.1:8000 (CTRL + C to quit)
请确保此处显示的端口与填入bot配置中的相同,已有群友看错并填入bot导致无法使用。
验证完毕后请重启hrk客户端(也可一并重启bot端),否则bot可能不会发送消息。
在有自己bot的群而不是私聊发送指令测试,比如/haruki_info,如果一切正常,你的bot应该会回复如下消息:
text
Haruki Cloud Env: production
Haruki Cloud v1.10.0
Latest Client v1.1.7
Haruki Client v1.1.7
Haruki Bot Id: <YourBotId>
如果没有回复,请检查客户端运行是否报错、OneBot 日志是否报错。并重新对照bot与客户端配置,最后再带着截图询问群友。
使用lgr后台每几分钟出现一大串warn报错时请先确定bot反馈,若bot正常响应请无视。
如果都没有报错,则可能是机器人账号被腾讯风控,需要在同一环境中多登录一段时间。