Awesome

qBittorrent-ClientBlocker

中文 (默认, Beta 版本) English (Default, Beta Version)
中文 (Public 正式版) English (Public version)

一款适用于 qBittorrent (4.1+)/Transmission (3.0+, Beta)/BitComet (2.0+, Beta, Partial) 的客户端屏蔽器, 默认屏蔽包括但不限于迅雷等客户端.

• 全平台支持
• 支持记录日志及热重载配置
• 支持忽略私有 IP 地址
• 支持自定义屏蔽列表 (不区分大小写, 支持正则表达式)
• 支持多种客户端及其认证, 同时可自动检测部分客户端 (目前支持 qBittorrent. 可以安全忽略检测客户端时发生的错误)
• 支持增强自动屏蔽 (默认禁用): 根据默认或设定的相关参数自动屏蔽 Peer
• 在 Windows 下支持通过系统托盘或窗口热键 (CTRL+ALT+B) 显示及隐藏窗口 (部分用户反馈其可能会影响屏蔽, 由于原因不明, 若遇到相关问题可避免使用该功能)

使用 Usage

前提

• 必须启用客户端的 Web UI 功能.

常规版本使用

1. 从 GitHub Release 下载压缩包并解压;

   <details> <summary>查看 常见平台下载版本 对照表</summary>

   操作系统	处理器架构	处理器位数	下载版本	说明
   macOS	ARM64	64 位	darwin-arm64	常见于 Apple M 系列
   macOS	AMD64	64 位	darwin-amd64	常见于 Intel 系列
   Windows	AMD64	64 位	windows-amd64	常见于大部分现代 PC
   Windows	i386	32 位	windows-386	少见于部分老式 PC
   Windows	ARM64	64 位	windows-arm64	常见于新型平台, 应用于部分平板/笔记本/少数特殊硬件
   Windows	ARMv7	32 位	windows-arm	少见于罕见平台, 应用于部分上古硬件, 如 Surface RT 等
   Linux	AMD64	64 位	linux-amd64	常见于大部分 NAS 及服务器
   Linux	i386	32 位	linux-386	少见于部分老式 NAS 及服务器
   Linux	ARM64	64 位	linux-arm64	常见于部分服务器及开发板, 如 Oracle 或 Raspberry Pi 等
   Linux	ARMv*	32 位	linux-armv*	少见于部分老式服务器及开发板, 查看 /proc/cpuinfo 或 从高到底试哪个能跑

   其它版本的 Linux/NetBSD/FreeBSD/OpenBSD/Solaris 可以此类推, 并在列表中选择适合自己的.

   </details>

2. 解压后, 可能需要修改随附的配置文件 config.json;

   • 可根据高级需求, 按需设置配置, 具体见 配置 Config.
   • 若客户端屏蔽器运行于本机, 但未启用客户端 "跳过本机客户端认证" (及密码不为空且并未手动设置密码), 则必须修改配置文件, 并填写 clientPassword.
   • 若客户端屏蔽器不运行于本机 或 客户端未安装在默认路径 或 客户端不支持自动读取配置文件, 则必须修改配置文件, 并填写 clientURL/clientUsername/clientPassword.

3. 启动客户端屏蔽器, 并观察信息输出是否正常即可;

   对于 Windows, 可选修改客户端的快捷方式, 放入自己的屏蔽器路径, 使客户端与屏蔽器同时运行;

   qBittorrent: C:\Windows\System32\cmd.exe /c "(tasklist | findstr qBittorrent-ClientBlocker || start C:\Users\Example\qBittorrent-ClientBlocker\qBittorrent-ClientBlocker.exe) && start qbittorrent.exe"

   对于 macOS, 可选使用一基本 LaunchAgent 用户代理 用于开机自启及后台运行;

   对于 Linux, 可选使用一基本 Systemd 服务配置文件 用于开机自启及后台运行;

Docker 版本使用

• 从 Docker Hub 拉取 Docker 镜像.

  docker pull simpletracker/qbittorrent-clientblocker:latest
  

• 配置方法一: 使用 配置文件映射

  1. 在合适位置新建 config.json 作为配置文件, 具体内容可参考 config.json 及 配置 Config;

  2. 填入 clientURL/clientUsername/clientPassword;

     • 可根据高级需求, 按需设置其它配置, 具体见 配置 Config.
     • 若启用客户端的 "IP 子网白名单", 则可不填写 clientUsername 和 clientPassword.

  3. 运行 Docker 并查看日志, 观察信息输出是否正常即可;

     以下命令模版仅作为参考, 请替换 /path/config.json 为你的配置文件路径.

     docker run -d \
         --name=qbittorrent-clientblocker --network=bridge --restart unless-stopped \
         -v /path/config.json:/app/config.json \
         simpletracker/qbittorrent-clientblocker:latest
     

• 配置方法二: 使用 环境变量

  • 使用前提: 设置 useENV 环境变量为 true.

  • 使用环境变量按需配置设置, 具体见 配置 Config.

  • 若设置较复杂, 则可能出现 blockList 不生效的情况. 因此, 若需要配置此设置, 则使用环境变量是不推荐的.

  • 以下命令模版仅作为参考.

    docker run -d \
        --name=qbittorrent-clientblocker --network=bridge --restart unless-stopped \
        -e debug=false \
        -e logPath=logs \
        -e blockList='["ExampleBlockList1", "ExampleBlockList2"]' \
        -e clientURL=http://example.com \
        -e clientUsername=exampleUser \
        -e clientPassword=examplePass \
        simpletracker/qbittorrent-clientblocker:latest
    

参数 Flag

配置 Config

Docker 版本通过相同名称的环境变量配置, 通过自动转换环境变量为配置文件实现.

反馈 Feedback

用户及开发者可以通过 Issue 反馈 bug, 通过 Discussion 提问/讨论/分享 使用方法, 通过 Pull Request 向客户端屏蔽器贡献代码改进.
注意: 应基于 dev 分支. 为 Feature 发起 Pull Request 时, 请不要同步创建 Issue. 由于人手有限, 开发进度可能较为缓慢.

致谢 Credit

1. 我们在客户端屏蔽器的早期开发过程中部分参考了 jinliming2/qbittorrent-ban-xunlei. 我们可能也会参考其它同类项目对项目进行优化, 但将不在此处单独列出;
2. 我们会在每期版本的 Release Note 中感谢当期通过 Pull Request 向客户端屏蔽器贡献代码改进的用户及开发者;