Skip to content

QChatGPT的守门人,包含黑白名单、临时用户机制

Notifications You must be signed in to change notification settings

zuo-shi-yun/Gatekeeper

Repository files navigation

Gatekeeper 包含黑名单、白名单、临时用户机制的看门狗,保护流量的守门人。
下图是默认配置下的系统流程。 2.png (本插件运行于QChatGPT)

💪插件功能

黑白名单机制
  • 如在白名单直接放行。自动添加管理员qq到白名单。
  • 如在黑名单则禁止请求。自动添加banlist.py下qq到黑名单。
  • 可动态控制黑白名单是否开启、黑白名单QQ号。
临时用户机制
  • 临时用户:即不在白名单也不在黑名单的用户。
  • 对该类用户分配最大请求配额(可在范围内随机分配),在配额内的请求可以正常发送。
  • 超出配额的请求根据配置自动回复超额提示信息。
  • 根据配置自动重置配额。
  • 可动态控制是否开启临时用户机制。

⚔️安装与配置

安装
  • 运行!plugin get https://github.com/zuo-shi-yun/Gatekeeper.git
  • 进入插件目录执行pip install -r requirements.txt
配置
  • 如果你不熟悉yaml格式文件,请使用指令修改配置,所有配置均可通过指令动态修改。
  • 系统相关配置存于config.yml文件中。
  • 可于config-temporary.yml文件中查看每一项配置的详细说明。在该文件修改配置无效!!
  • 可对插件运行逻辑、黑白名单机制、临时用户机制进行配置。

📲交互指令

说明

  • 下面的所有指令(cmd)均有两种形式,“!cmd”以及“cmd”。
    其中“cmd”形式的指令只有当config文件中normal_cmd字段为True时有效(默认为True)。
    下文中“!”省略不写,若使用“!cmd”形式时别忘了加。
  • 所有命令仅对管理员生效。
  • 可以向机器人发送"看门狗"快速查看指令说明

白名单

  1. 打开白名单:"打开白名单"。
  2. 添加qq号到白名单:"添加白名单 qq号1 qq号2"。
    tips:不限制添加的qq号数量,以空格分隔。
  3. 删除白名单qq号:"删除白名单 qq号"
  4. 关闭白名单:"关闭白名单"。
  5. 查询白名单中所有的qq号:"查询白名单"

黑名单

  1. 打开黑名单:"打开黑名单"。
  2. 添加qq号到黑名单:"添加黑名单 qq号1 qq号2"。
    tips:不限制添加的qq号数量,以空格分隔。
  3. 删除黑名单qq号:"删除黑名单 qq号"
  4. 关闭黑名单:"关闭黑名单"。
  5. 查询黑名单中的所有qq号:"查询黑名单"

临时用户

  1. 打开临时用户机制:"打开临时用户"。
  2. 设置临时用户最高配额:"设置最高 请求数"
    eg:设置临时用户最高请求数为10:设置最高 10
    tips:当随机配额关闭时,每个用户的最高配额均为该参数。
  3. 设置配额刷新天数:"设置天数 天数"
    eg:设置配额刷新间隔为1天:设置天数 1
  4. 设置超额提示信息:"设置信息 提示信息"
    tips:提示信息中以“{}”代表配额刷新天数,空格代表换行。
  5. 打开随机配额机制:"打开随机配额"
    tips:开启后将随机从[最低配额, 最高配额]范围内给用户随机分配配额
  6. 设置临时用户最低配额:"设置最低 请求数"。
  7. 关闭临时用户机制:"关闭临时用户"
  8. 关闭随机配额机制:"关闭随机配额"

运行逻辑

  1. 打开"cmd"形式的指令:"打开普通指令"。
  2. 关闭"cmd"形式的指令:"关闭普通指令"。
  3. 打开阻止其余插件行为:"打开插件阻止"
    tips:可以通过更改plugins/settings.json中order字段中每个插件名称的前后顺序,
    以达到精准控制屏蔽某些插件的目的。
  4. 关闭阻止其余插件行为:"关闭插件阻止"
  5. 查询系统所有配置项:"查询配置"

About

QChatGPT的守门人,包含黑白名单、临时用户机制

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published