bot断连时的通知插件
Project description
📖 介绍
- 可以在bot断开与nonebot的连接时向主人发送微信公众号消息或邮件消息,用来通知主人bot可能被风控掉线
- 目前支持全部适配器协议,通知方式支持: pushplus微信公众号通知;邮件通知
- 如果有其他通知方式的需求,欢迎提issues或pr
💿 安装
使用 nb-cli 安装
在 nonebot2 项目的根目录下打开命令行, 输入以下指令即可安装nb plugin install nonebot-plugin-disconnect-notice
使用包管理器安装
在 nonebot2 项目的插件目录下, 打开命令行, 根据你使用的包管理器, 输入相应的安装命令pdm
pdm add nonebot-plugin-disconnect-notice
poetry
poetry add nonebot-plugin-disconnect-notice
⚙️ 配置
运行插件前,需要在 nonebot2 项目的.env.prod
文件中添加下表中的pushplus token 或smtp相关配置项
pushplus微信公众号消息配置教程
-
点击网页右上角 登录 按钮,微信扫码完成登录
-
点击公众号提示的该卡片完成登录绑定,提示启用成功即可
-
回到网页端,顶部菜单栏选择发送消息 - 一对一消息,然后点击一键复制
-
将token按照下方配置项名 disconnect_notice_pushplus_token = "" 填入
.env.prod
文件内
邮件通知配置教程
- 以qq邮箱为例,其他邮箱的开启smtp方式是类似的
-
点击qq邮箱的设置
-
点击账户
-
点击管理服务,如果没有开启,这里可能显示的是
开启服务
-
点击
生成授权码
-
按照要求用密保手机号发送短信验证
-
复制得到的这个授权码
-
得到的这个
授权码
就相当于邮箱密码,邮箱账号就是qq邮箱,其他的一些常见邮箱的smtp_server和smtp_port配置参数参考下表
邮箱名 | smtp_server | smtp_port |
---|---|---|
qq邮箱 | smtp.qq.com | 465 |
网易yeah邮箱 | smtp.yeah.net | 465 |
阿里云邮箱 | smtp.aliyun.com | 465 |
网易163邮箱 | smtp.163.com | 465 |
移动139邮箱 | smtp.139.com | 465 |
配置项 | 必填 | 值类型 | 默认值 | 说明 |
---|---|---|---|---|
disconnect_notice_mode_list | 是 | list[str] | ["pushplus"] | 通知类型列表,枚举值:pushplus mail,可填写多个通知源,如["pushplus","mail"] |
disconnect_notice_pushplus_token | 是 | str | "" | pushplus微信公众号token,具体获取方式见上方教程 |
disconnect_notice_smtp_user | 是 | str | "" | 邮箱账号,如 114514@yeah.net |
disconnect_notice_smtp_password | 是 | str | "" | 邮箱密码或授权码,如 114514 |
disconnect_notice_smtp_server | 是 | str | "" | 邮箱服务器地址,如 smtp.yeah.net |
disconnect_notice_smtp_port | 是 | int | 465 | 邮箱端口号,ssl模式时为465 |
disconnect_notice_notice_email | 是 | str | "" | 收件人邮箱,填写自己邮箱即可 |
disconnect_notice_dev_mode | 否 | bool | False | 开发者模式,该模式下bot断开连接不会触发通知消息,避免本地测试插件时不断重载而导致的大量掉线通知 |
disconnect_notice_max_grace_time | 否 | int | 10 | 断连后最大宽限时长,单位:秒,如果在此期间bot完成了重连,则不触发邮件通知 |
示例配置
## disconnect_notice掉线通知示例配置
# 通知方式list,可填写多种通知方式 枚举值:pushplus mail
disconnect_notice_mode_list = ["pushplus"]
# 邮件通知
disconnect_notice_smtp_user = "114514@yeah.net" #邮箱账号
disconnect_notice_smtp_password = "114514" #邮箱密码
disconnect_notice_smtp_server = "smtp.yeah.net" #邮箱服务器地址
disconnect_notice_smtp_port = 465 #邮箱端口号
disconnect_notice_notice_email = "114514@qq.com" #收件人邮箱
# pushplus微信公众号通知 https://www.pushplus.plus/
disconnect_notice_pushplus_token = ""
# 其他设定
disconnect_notice_dev_mode = False #开发者模式,该模式下bot断连不会触发通知消息,避免本地测试插件时不断重载而导致的大量掉线通知
disconnect_notice_max_grace_time = 10 #断连后最大宽限时长,单位:秒,如果在此期间bot完成了重连,则不触发邮件通知
🎉 使用
指令表
指令 | 权限 | 需要@ | 范围 | 说明 |
---|---|---|---|---|
掉线测试 | 主人 | 否 | 所有会话 | 主动触发掉线通知测试,用来测试通知是否正常可用 |
效果图
邮件通知
pushplus微信通知
✨喜欢的话就点个star✨吧,球球了QAQ
⏳ Star 趋势
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for nonebot_plugin_disconnect_notice-0.3.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 49764364e5e6343f62bcc8babd464cb82cfa2b7dbb93732284ddc899f2bfae99 |
|
MD5 | 53fecc227b6920cddcd447c517dba605 |
|
BLAKE2b-256 | d6cda9169ca4b73f9de3d6dd4bc20fd6e6d21ae9b8ccb9d4911027faba3ac0ac |
Close
Hashes for nonebot_plugin_disconnect_notice-0.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 919c0ff7a55e448f4c58e1ed969b2e8b33cd2b73ec081e3cfe5f06f4e28c9446 |
|
MD5 | ce606ff22dff932d2fe174a1a682b144 |
|
BLAKE2b-256 | c881ec92b159de71e5b613ce773105031dc48e86a223110b5e04f4f77007968e |