完善中文文档，使其更加正式和清晰 #18
完善中文文档，使其更加正式和清晰 #18
Conversation
Walkthrough本次拉取请求对多个文档进行了文本修改，旨在提高清晰度和一致性。具体修改包括重述引言、更新标题和小节、调整语言风格以更正式，并对指令进行更清晰的表述。文档涉及的主题包括 BTN 计划、下载器配置、用户常见问题解答等，整体上增强了文档的可读性和用户体验。 Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Documentation
User->>Documentation: 查看BTN计划文档
Documentation-->>User: 提供连接和参与指引
User->>Documentation: 查看下载器配置文档
Documentation-->>User: 提供安装和配置步骤
User->>Documentation: 查阅常见问题解答
Documentation-->>User: 提供故障排除建议
Possibly related PRs
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (4)
🚧 Files skipped from review as they are similar to previous changes (4)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 10
🧹 Outside diff range and nitpick comments (71)
docs/prefandlang/logger.md (2)
3-5: 描述更新准确且专业文字调整恰当地提升了专业性，同时保持了易读性。建议在"PeerBanHelper（PBH）"首次出现时可以添加更详细的解释。
-PeerBanHelper（PBH）在每次完成 Peers 检查后，默认会输出一条日志信息。 +PeerBanHelper（简称 PBH，一个用于管理和封禁 Peers 的工具）在每次完成 Peers 检查后，默认会输出一条日志信息。
17-19: 存储说明更新合理，建议补充细节文档更新清晰地说明了日志存储机制，但建议补充以下信息以更好地帮助用户：
- 日志文件的保留时间
- 压缩后的文件命名格式
- 如何查看已压缩的历史日志
建议添加如下内容：
-PBH 会自动将过往的日志文件进行打包压缩归档。 +PBH 会自动将过往的日志文件进行打包压缩归档。压缩后的日志文件会以 `yyyy-MM-dd.log.gz` 格式命名，默认保留最近30天的日志记录。您可以使用标准的解压工具查看这些历史日志。docs/setup/Linux/LinuxInstall4j.md (2)
11-11: 建议补充系统要求和发行版示例当前的说明已经很清晰，但建议增加以下内容：
- 具体列举支持的主要Linux发行版
- 说明系统的最低配置要求
建议添加如下内容：
对于Redhat系列的用户，请访问[Releases页面](https://github.com/PBH-BTN/PeerBanHelper/releases)下载适用于您的系统的`.rpm`软件包。而其他Linux用户，则应该下载以`.sh`结尾的脚本安装程序。 +## 支持的发行版 +- RedHat系列：RHEL 8+、CentOS 8+、Fedora 30+ +- 其他发行版：Ubuntu 20.04+、Debian 10+ + +## 系统要求 +- CPU：双核及以上 +- 内存：2GB及以上 +- 磁盘空间：500MB可用空间
13-13: 建议补充图形界面的具体要求当前对安装方式的说明简洁明了，但建议补充以下信息：
- 运行图形界面所需的具体环境要求
- 各步骤的详细说明
建议添加如下内容：
在安装过程中，系统将默认使用命令行界面（CLI）安装向导。如果您的Linux系统支持桌面环境，那么安装程序将自动启动图形安装向导，其操作流程与Windows版本相似。 +## 图形界面要求 +- 已安装X Window System +- 运行GNOME、KDE等桌面环境 +- 最小分辨率：1024x768 + +## 安装步骤 +1. 为安装文件添加执行权限：`chmod +x 安装文件名` +2. 运行安装程序：`./安装文件名` +3. 根据向导提示完成配置 +4. 验证安装：运行 `pbh --version` 检查版本号docs/downloader/qBittorrentEE.md (2)
13-13: 建议改进格式以提高可读性建议对版本号和关键术语进行格式优化。
建议应用以下修改：
-qBittorrent EE 提供了 [ShadowBan API](https://github.com/c0re100/qBittorrent-Enhanced-Edition/issues/538)，作为传统 IP 封禁的替代方案。要使用此功能，您需要确保已安装 qBittorrent Enhanced Edition 4.6.6.10 或更高版本。 +qBittorrent EE 提供了 [ShadowBan API](https://github.com/c0re100/qBittorrent-Enhanced-Edition/issues/538)，作为传统 IP 封禁的替代方案。要使用此功能，您需要确保已安装 **qBittorrent Enhanced Edition `4.6.6.10`** 或更高版本。
16-18: 建议优化警告部分的结构警告内容非常全面，但可以通过更好的视觉分隔来提高可读性。
建议将警告内容分为明确的要点：
:::warning -**除非在必要情况下，否则不建议启用 ShadowBan 功能。** 误用此功能可能会导致您的行为类似于恶意吸血端，进而引发一系列问题。 -此外，在成功达到恶意吸血者的连接数限制之前，您可能会首先达到互联网服务提供商（ISP）设定的连接数限制，从而导致您自己的网络连接中断。这种情况可能会产生反向效果。考虑到当前的吸血端在长时间未接收到您的上传数据时会自动断开连接，这使得 ShadowBan 功能的效果大打折扣。 +**⚠️ 重要提示：除非必要，否则不建议启用 ShadowBan 功能** + +主要风险： +- 误用可能导致您的行为类似于恶意吸血端 +- 可能触及 ISP 连接数限制，导致网络连接中断 + +功能限制： +- 吸血端在长时间未收到上传数据时会自动断开 +- 实际效果可能低于预期 :::docs/setup/Windows/Portable.md (3)
9-11: 建议补充解压后的目录结构说明当前的下载和解压说明清晰明确，但建议添加解压后的目录结构说明，以帮助用户确认安装是否正确。
建议在解压说明后添加如下内容：
解压该压缩包至您希望存放 PeerBanHelper 的任意目录，解压后即可直接使用。 + +解压后，您将看到以下目录结构： +``` +PeerBanHelper/ +├── data/ # 配置文件和数据存储目录 +├── PeerBanHelper.exe # 主程序 +└── ... 其他程序文件 +```
19-25: 建议添加数据备份提醒升级步骤说明清晰，但建议在开始升级步骤前添加数据备份建议，以防意外情况发生。
建议在升级步骤前添加：
升级步骤如下： + +在开始升级之前，建议您先备份整个 `data` 文件夹，以防升级过程中出现意外情况。 + 1. 首先，将当前的 `data` 文件夹（包含您的配置数据和记录）移动至一个临时位置。
15-17: 建议补充警告说明当前的警告信息明确但可以添加更多解释性内容，帮助用户理解为什么不能直接覆盖文件。
建议修改警告内容：
:::warning -在升级便携版时，**切勿**直接覆盖旧文件，而需要**完整重新解压新版本的所有文件**。 +在升级便携版时，**切勿**直接覆盖旧文件，而需要**完整重新解压新版本的所有文件**。直接覆盖可能导致程序文件不完整或版本混乱，从而影响软件的正常运行。 :::docs/btn/connect.md (3)
11-17: 建议添加安全提示虽然注册流程描述清晰，但建议添加以下安全相关提示：
- GitHub 授权时的安全确认步骤
- 账号安全保护建议
建议添加如下内容：
请在浏览器中打开 [https://btn-prod.ghostchu-services.top](https://btn-prod.ghostchu-services.top) 并使用 GitHub 授权登录，系统将自动为您创建一个账号。 + +> 注意：授权时请确认页面的安全性，并建议开启 GitHub 两步验证以提高账号安全性。
21-21: 建议补充凭证安全存储提示关于凭证保管的说明可以更加完善。
建议添加如下内容：
请务必记录页面上显示的 `AppID` 和 `AppSecret`，因为一旦关闭该页面，`AppSecret` 将不再显示。 + +> 安全提示： +> - 请将凭证保存在安全的位置 +> - 不要与他人分享这些信息 +> - 如果怀疑凭证泄露，请立即重新生成
25-37: 建议添加故障排除指南配置步骤清晰，截图说明充分，建议补充常见问题解决方案。
建议在文档末尾添加：
 + +## 常见问题 + +### 连接失败怎么办？ +- 检查 AppID 和 AppSecret 是否正确输入 +- 确认网络连接是否正常 +- 验证 PeerBanHelper 是否为最新版本 + +### 如何验证连接成功？ +- 检查 PeerBanHelper 日志 +- 观察 BTN 状态指示器docs/platform/Windows.md (2)
5-5: 建议补充性能影响的具体说明当前描述很好地解释了 EcoQoS 的功能和好处。建议添加一个简短说明，具体说明启用此功能可能带来的性能影响程度，以帮助用户做出更明智的选择。
建议添加类似以下内容：
在 Windows 11 的 22H2 版本或更高版本中，如果系统 BIOS 和 CPU 均支持，PeerBanHelper（PBH）将自动启用 [EcoQoS](https://devblogs.microsoft.com/performance-diagnostics/introducing-ecoqos/) 节能功能。此功能旨在缓解 PBH 在执行检测任务时因瞬时计算量增加导致的 CPU 睿频及电量消耗，同时降低 PBH 的运行优先级，以便将更多系统资源分配给其他应用程序。 + 启用此功能后，PBH 的检测任务处理速度可能会降低约 10-20%，但可以显著降低系统资源占用。
7-9: 建议优化图片的可访问性图片说明简洁明了，但建议增强图片的可访问性。
建议修改为：
- +docs/setup/macOS/Installer.md (4)
5-11: 建议补充安装文件的具体命名格式为了帮助用户更容易识别下载文件，建议在说明两个版本时补充具体的文件命名格式示例。
建议按如下方式补充说明：
-其中，一个带有 `nojava` 标识，另一个则没有。若您对 Java 不甚了解，建议选择**未带** `nojava` 标识的版本进行下载。 +其中，一个带有 `nojava` 标识（如 `PeerBanHelper-1.0.0-nojava.dmg`），另一个则没有（如 `PeerBanHelper-1.0.0.dmg`）。若您对 Java 不甚了解，建议选择**未带** `nojava` 标识的版本进行下载。
13-15: 建议补充系统安全提示的背景说明当前的安全提示说明可以更加详细，帮助用户理解为什么会出现该提示以及如何安全地处理。
建议按如下方式扩展说明：
-3. 系统可能会提示您是否要打开此应用程序，请点击"打开"以继续安装流程。 +3. 由于 macOS 的安全机制，系统可能会显示"无法打开，因为无法验证开发者"的提示。这是正常现象，您可以： + - 点击"取消" + - 前往"系统偏好设置" > "安全性与隐私" + - 在"通用"标签页中点击"仍要打开" + - 在弹出的确认对话框中点击"打开"以继续安装流程
25-28: 建议补充系统托盘菜单选项的具体说明当前对系统托盘的功能描述较为笼统，建议详细列举可用的菜单选项。
建议按如下方式补充说明：
-您可通过点击窗口的关闭按钮，将其最小化至系统托盘图标，并可以双击打开图形用户界面，或右键查看部分信息。 +您可通过点击窗口的关闭按钮，将其最小化至系统托盘图标。在系统托盘图标上： +- 双击：重新打开主界面 +- 右键点击可访问快捷菜单： + - 打开主界面 + - 打开数据文件夹 + - 访问 WebUI + - 查看运行状态 + - 退出程序
30-32: 建议补充 GUI Silent 模式的优势说明当前说明侧重于功能描述，建议补充此模式的具体应用场景和优势。
建议按如下方式扩展说明：
-与 GUI 模式相似，但启动时不会显示图形窗口，仅在系统托盘处显示一个图标，并可以双击打开图形用户界面，或右键查看部分信息。此模式适合偏好静默启动的用户。 +与 GUI 模式相似，但启动时不会显示图形窗口，仅在系统托盘处显示一个图标，并可以双击打开图形用户界面，或右键查看部分信息。此模式具有以下优势： +- 开机启动时不会干扰用户操作 +- 减少系统资源占用 +- 保持界面功能的同时提供更好的用户体验 +特别适合将程序设置为开机启动的用户。docs/module/ip-address-blocker-rules.md (1)
5-7: 提示部分的添加使文档更加清晰这个提示的添加很有价值，它为用户提供了明确的配置方法指导。建议补充说明使用 WebUI 进行配置的具体优势，以帮助用户更好地理解这个建议。
建议扩展提示内容如下：
:::tip -不建议通过配置文件配置此功能，您可以直接使用 WebUI 的可视化编辑。 +不建议通过配置文件配置此功能，您可以直接使用 WebUI 的可视化编辑。使用 WebUI 可以实时预览更改效果，降低配置错误的风险，并且操作更加直观。 :::docs/setup/Windows/Installer.md (2)
10-16: 建议补充版本说明细节为了帮助用户更好地选择合适的版本，建议：
- 添加版本号格式示例
- 详细说明带Java和不带Java版本的具体区别和适用场景
建议添加如下内容：
其中，一个带有 `nojava` 标识，另一个则没有。若您对 Java 不甚了解，建议选择**未带** `nojava` 标识的版本进行下载。 + +例如，安装文件可能显示为： +- `PeerBanHelper-1.0.0-amd64.exe`（推荐普通用户使用） +- `PeerBanHelper-1.0.0-amd64-nojava.exe`（适用于系统已安装Java环境的用户）
35-37: 建议补充NoGUI模式的使用说明NoGUI模式的说明可以更加详细，建议补充：
- 如何在此模式下访问WebUI
- 如何查看运行日志
- 如何退出程序
建议扩展说明如下：
NoGUI 模式以控制台形式运行，资源占用最低。此模式更适合高级用户或需要最小化资源使用的场景。 + +在NoGUI模式下： +- 可通过浏览器访问 `http://localhost:端口号` 来使用WebUI +- 程序日志将直接显示在控制台窗口中 +- 可以通过在控制台中按 Ctrl+C 来退出程序docs/prefandlang/language.md (1)
10-14: 配置说明双语展示，清晰易懂！双语注释的添加有助于中英文用户理解配置选项。建议可以考虑为其他配置项也采用类似的双语展示方式。
docs/setup/Docker.md (1)
11-11: 建议补充版本标签使用的最佳实践当前的说明已经很好地警告了不要使用
latest标签，建议进一步补充说明：
- 推荐使用具体的版本号标签
- 说明如何识别稳定版本的标签格式
建议添加如下内容：
+推荐使用类似 `vX.Y.Z` 格式的具体版本标签，例如 `v1.2.3`。这样可以确保部署的版本稳定且可控。Also applies to: 15-15
docs/setup/Synology DSM/Imnks.md (3)
9-9: 建议改进语法表达建议将"提供便捷的安装与更新服务"修改为"提供便捷地安装与更新服务"，以符合中文语法规范。
-PeerBanHelper 与 [imnks.com](https://imnks.com/) 携手合作，将 PeerBanHelper 以容器套件的形式引入群晖（Synology）的套件中心，提供便捷的安装与更新服务。 +PeerBanHelper 与 [imnks.com](https://imnks.com/) 携手合作，将 PeerBanHelper 以容器套件的形式引入群晖（Synology）的套件中心，提供便捷地安装与更新服务。🧰 Tools
🪛 LanguageTool
[uncategorized] ~9-~9: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：便捷"地"安装
Context: ...nHelper 以容器套件的形式引入群晖（Synology）的套件中心，提供便捷的安装与更新服务。 请遵循[矿神SPK源官方教程](https://imnks....(wb4)
27-27: 建议突出显示重要警告信息为了防止用户误操作，建议将有关共享文件夹修改的警告信息以更醒目的方式呈现。
-安装完成后，PeerBanHelper 将自动创建一个名为"peerbanhelper"的共享文件夹，用于存储所有相关的文件和配置。请注意，虽然可以切换该共享文件夹的存储空间，但对其执行除切换存储空间外的其他操作可能会导致工作异常。 +安装完成后，PeerBanHelper 将自动创建一个名为"peerbanhelper"的共享文件夹，用于存储所有相关的文件和配置。 + +> ⚠️ **重要提示**：虽然可以切换该共享文件夹的存储空间，但对其执行除切换存储空间外的其他操作可能会导致工作异常。
41-41: 建议优化网络配置说明的结构当前的说明包含了多个重要信息点，建议以更结构化的方式呈现，以便用户更好地理解和执行配置步骤。
-尽管 PeerBanHelper 是以套件形式安装的，但其本质上仍是一个 Docker 容器。因此，在配置网络时，需遵循 Docker 的相关步骤。当访问位于同一 NAS 上的下载器时，应使用网关地址，而非 `127.0.0.1` 或 `localhost`。网关地址可在 Container Manager（容器管理器）的"网络"选项卡下的"peerbanhelper_default"网络配置中找到。 +### 网络配置说明 + +1. **容器特性**：尽管 PeerBanHelper 是以套件形式安装的，但其本质上仍是一个 Docker 容器。 + +2. **地址使用注意事项**： + - 不要使用：`127.0.0.1` 或 `localhost` + - 正确做法：使用网关地址访问同一 NAS 上的下载器 + +3. **查找网关地址**： + - 打开 Container Manager（容器管理器） + - 进入"网络"选项卡 + - 在"peerbanhelper_default"网络配置中查看网关地址docs/setup/Linux/Deb.md (3)
29-32: 建议明确说明版本兼容性要求示例输出中使用了"xx.xx.xxx"作为版本号占位符，建议添加说明，指出具体的最低版本要求和推荐版本。
建议在版本输出示例前添加说明：
+请确保显示的版本号不低于21.0.0。如果显示的版本较低，请按照上述步骤安装更新版本的OpenJDK。
44-44: 建议补充依赖安装的具体操作说明当前仅提示"按照提示操作即可"，建议添加更详细的操作指导。
建议添加以下内容：
-系统可能会提示您安装一些额外的依赖项，按照提示操作即可。 +系统可能会提示您安装一些额外的依赖项。如遇此情况，请执行以下命令安装缺失的依赖： +```shell +sudo apt-get install -f +``` +如果安装过程中遇到其他错误，请查看错误信息并确保系统已更新到最新状态。
60-60: 建议添加故障排查指南服务状态检查命令已提供，但建议补充常见问题的排查方法。
建议在文档末尾添加：
+### 常见问题排查 + +如果服务无法正常启动，请依次检查： + +1. 查看详细的服务日志： +```shell +journalctl -u peerbanhelper -n 50 +``` + +2. 确认服务配置文件权限： +```shell +ls -l /etc/peerbanhelper/config.json +``` + +3. 检查系统资源使用情况： +```shell +top +df -h +```docs/downloader/qBittorrent.md (2)
17-21: 建议加强安全配置说明步骤说明清晰，但建议：
- 为端口号
7474添加选择建议，比如避免使用常见端口- 强调密码复杂度要求，建议提供具体示例
- 可以补充说明防火墙配置的最佳实践
建议添加如下安全提示：
3. 配置一个端口号，本例中我们使用`7474`。请注意，这里的"IP地址"实际上是指"监听网卡地址"，如果不确定其含义，可以保持默认为`*`，不过，如果您的防火墙配置不当，其他人也可访问到您的 qBittorrent WebUI。 + 建议选择非常见端口（避免使用80、443等），并确保配置防火墙仅允许受信任的IP地址访问此端口。 4. 在"身份验证"部分，设置一个用户名和高强度密码。若密码被他人猜中，他们可能会访问 qBittorrent 下载文件或执行命令/程序。 + 建议密码长度不少于12位，并包含大小写字母、数字和特殊字符。
38-45: 配置步骤说明完整，建议补充验证信息步骤描述清晰，特别是对特殊字符的说明很有帮助。建议补充以下内容：
- 添加常见错误提示的解释
- 说明如何验证连接是否正常工作
建议在最后添加：
6. 点击"确定"按钮，如果提示成功，则表示添加成功。 +7. 如需验证连接是否正常工作，可以尝试添加一个测试种子，观察是否能被正确识别和管理。 +8. 如果遇到"连接失败"错误，请检查： + - WebUI 是否已正确启用 + - 端口号是否正确 + - 用户名密码是否正确 + - 防火墙是否已正确配置docs/setup/FreeBSD.md (4)
17-17: 建议使用具体的版本号替代通配符示例URL中使用了通配符（
*.*.*），这可能会使用户感到困惑。建议使用一个具体的版本号作为示例，比如使用最新的稳定版本号。-fetch https://github.com/PBH-BTN/PeerBanHelper/releases/download/v6.4.2/peerbanhelper-v*.*.*-FreeBSD-*.*-RELEASE.pkg +fetch https://github.com/PBH-BTN/PeerBanHelper/releases/download/v6.4.2/peerbanhelper-v6.4.2-FreeBSD-13.4-RELEASE.pkg
24-24: 建议明确说明最低版本要求虽然文档提到需要"OpenJDK 21或更高版本"，但建议明确说明具体的最低版本要求，包括补丁版本号，以避免潜在的兼容性问题。
建议在安装说明前添加：
+OpenJDK的最低版本要求为21.0.1。如果安装了更高版本，也同样兼容。
67-67: 建议添加服务状态验证步骤启动服务后，用户可能需要验证服务是否正常运行。建议添加检查服务状态的命令。
建议在启动命令后添加：
sudo service peerbanhelper onestart + +# 验证服务状态 +sudo service peerbanhelper status
78-78: 建议添加故障排除章节文档目前缺少故障排除指南。建议添加一个新的章节，包含常见问题和解决方案。
建议在文档末尾添加：
## 故障排除 ### 常见问题 1. 如果服务启动失败，请检查： - Java版本是否满足要求 - 系统日志中的错误信息：`sudo tail -f /var/log/messages` - PBH日志文件 2. 如果遇到权限问题： - 确认使用了sudo执行需要权限的命令 - 检查安装目录的权限设置 如需更多帮助，请访问我们的[GitHub Issues页面](https://github.com/PBH-BTN/PeerBanHelper/issues)。docs/intro.md (3)
7-7: 建议调整欢迎语的正式程度"莅临"一词过于正式，建议使用更适合技术文档的表达方式。
建议修改为：
-欢迎莅临 PeerBanHelper 的文档世界。本指南将全面引领您从 PeerBanHelper 的安装到配置，以及解决可能遇到的常见问题。 +欢迎访问 PeerBanHelper 的文档。本指南将全面介绍 PeerBanHelper 的安装、配置过程，以及帮助您解决常见问题。
15-21: 链接表述统一，建议优化格式链接添加"点击此处查看"提升了可读性，格式统一。建议调整表格列宽以获得更好的显示效果。
建议在 Markdown 表格中添加列宽控制：
-| 系统/平台 | 访问链接 | -| ----------------------------- | ---------------------------------- | +| 系统/平台 | 访问链接 | +|:----------------------------- |:---------------------------------- |
30-33: 许可证说明清晰，建议统一语气许可证相关说明透明且友好，但文档语气略有不一致。
建议修改为：
-但请注意，PeerBanHelper 的部分高级功能可能需要您输入许可证。您可以通过[爱发电平台](https://afdian.com/a/Ghost_chu)赞助获取许可证，或者向已拥有许可证的朋友借用（不用担心，这是被允许的，您完全可以这么做😎）。 +需要说明的是，PeerBanHelper 的部分高级功能需要许可证。您可以通过[爱发电平台](https://afdian.com/a/Ghost_chu)赞助获取许可证，也可以向已拥有许可证的朋友借用（这是允许的做法）。docs/setup/Linux/Manual.md (3)
12-34: 建议说明包管理器示例的适用范围当前的安装说明使用
apt作为示例很好，但建议添加说明这是针对 Ubuntu/Debian 系统的示例，其他 Linux 发行版可能需要使用不同的包管理器。建议在
apt示例之前添加类似以下说明：-首先，您需要使用系统的包管理器来安装 OpenJDK 21 或更高版本的Java开发工具包（JDK）。以下示例以 `apt` 包管理器为例： +首先，您需要使用系统的包管理器来安装 OpenJDK 21 或更高版本的Java开发工具包（JDK）。以下以 Ubuntu/Debian 系统的 `apt` 包管理器为例（其他 Linux 发行版请使用相应的包管理器）：
35-40: 建议添加文件完整性验证步骤下载说明清晰，但建议添加验证下载文件完整性的步骤，以确保文件下载正确。
建议添加类似以下内容：
下载完成后，请解压 `libraries.tar.gz` 压缩包，并将解压得到的 `libraries` 文件夹与 JAR 文件放置在同一目录下。 + +建议您通过检查文件的 SHA-256 校验和来验证下载文件的完整性。校验和可在发布页面找到。
55-55: 建议扩充系统服务配置的说明虽然提供了 systemd 配置的链接很好，但建议简要说明配置系统服务的好处。
建议修改为：
-这样即可启动 PeerBanHelper。如果您希望 PeerBanHelper 在后台运行或在系统启动时自动运行，请自行[配置 systemd 系统服务](https://github.com/PBH-BTN/PeerBanHelper/issues/179#issuecomment-2198225784) 以实现这一功能。 +这样即可启动 PeerBanHelper。为了确保服务的稳定性和自动恢复能力，建议将 PeerBanHelper 配置为系统服务。您可以参考[这篇教程](https://github.com/PBH-BTN/PeerBanHelper/issues/179#issuecomment-2198225784)来配置 systemd 系统服务，这样可以实现开机自启动、后台运行和自动重启等功能。docs/module/multi-dial.md (2)
6-6: 建议添加具体示例说明当前描述准确清晰，但建议添加一个具体的示例来说明触发条件，比如："例如：当设置阈值为5时，如果检测到同一/24子网内有6个IP同时下载同一个种子，则会触发封禁。"这样可以帮助用户更直观地理解。
Line range hint
11-50: 建议优化配置参数的技术说明配置文档整体清晰，但建议对以下几点进行补充完善：
subnet-mask-length参数建议添加具体示例：# IP地址前多少位相同的视为同一个子网，位数越少范围越大，一般不需要修改 +# 例如：24表示匹配前24位，即192.168.1.0/24这样的网段 subnet-mask-length: 24
cache-lifespan参数建议说明缓存过期的具体行为：# 所有连接过的peer会记入缓存，DHCP服务会定期重新分配IP，缓存时间过长会导致误杀 +# 当缓存过期后，之前记录的连接历史将被清除，重新开始统计 cache-lifespan: 86400docs/setup/Synology DSM/docker.md (3)
13-13: 建议补充数据保护相关说明当前的说明已经提到了避免覆盖已设置内容的注意事项，建议进一步补充有关数据备份的建议。
建议添加如下内容：
+在进行配置之前，如果您之前已经部署过 PBH，请确保已备份原有的配置文件和数据。
50-50: 建议补充数据持久化说明关于数据卷映射的说明可以更加详细，建议补充数据持久化的重要性说明。
建议扩展说明如下：
**注意**：上述示例中的 `./data` 是指 Docker Compose 文件所在目录下的 `data` 文件夹，它将映射到容器内的 `/app/data`。同时，请将 `TZ` 环境变量的值设置为您所在的时区。 +该数据卷映射确保了容器重启或更新后，您的配置数据能够持久保存。建议定期备份 `data` 文件夹以防数据丢失。
60-60: 建议补充容器重启的具体操作步骤当前对重启操作的说明较为简略，建议补充具体的操作步骤。
建议添加如下内容：
首次启动完成后，配置文件应会自动生成。配置好配置文件后，再次重启 Docker 容器即可使用。 +重启容器可通过以下方式进行： +1. 在容器列表中选择 PeerBanHelper 容器 +2. 点击"停止"按钮停止容器 +3. 等待容器完全停止后，点击"启动"按钮重新启动容器docs/btn/intro.md (2)
13-13: 建议补充技术细节建议在解释 PeerID 和 ClientName 黑名单策略时，添加这些标识符的具体格式示例，以帮助读者更好地理解。
-最初，人们采用基于 PeerID 和 ClientName 的黑名单策略，以阻止特定类型的客户端连接到下载器进行吸血。这种策略虽然简单有效，但前提是下载器不会对这些标识符进行伪装，一旦伪装成功，该策略即失效。 +最初，人们采用基于 PeerID（例如："-qB4390-"）和 ClientName（例如："qBittorrent 4.3.9"）的黑名单策略，以阻止特定类型的客户端连接到下载器进行吸血。这种策略虽然简单有效，但前提是下载器不会对这些标识符进行伪装，一旦伪装成功，该策略即失效。
33-33: 建议补充协议版本兼容性说明在介绍 BTN 协议时，建议补充说明协议版本的兼容性要求，以帮助用户避免版本不匹配导致的问题。
-BTN（全称 BitTorrent Threat Network）由 BTN 服务器和 BTN 客户端组成，通过 [BTN 协议](https://github.com/PBH-BTN/BTN-Spec) 实现数据交换。 +BTN（全称 BitTorrent Threat Network）由 BTN 服务器和 BTN 客户端组成，通过 [BTN 协议](https://github.com/PBH-BTN/BTN-Spec) 实现数据交换。请确保服务器和客户端使用兼容的协议版本（目前推荐使用 v1.x 版本），以确保正常通信。docs/downloader/BitComet.md (4)
7-7: 建议考虑使用更通用的表述"利用"一词虽然正式，但可能显得过于技术化。建议考虑使用"通过"或保留原来的"使用"，这样更符合技术文档的友好性。
-PeerBanHelper 利用 BitComet 的 WebAPI 与 BitComet 进行交互。 +PeerBanHelper 通过 BitComet 的 WebAPI 与 BitComet 进行交互。
20-24: 建议添加版本检查方法版本要求说明清晰，建议补充如何查看当前 BitComet 版本的具体步骤。
建议在版本要求后添加：
+### 查看当前版本 +1. 打开 BitComet +2. 点击"帮助"->"关于 BitComet" +3. 在弹出窗口中查看版本号
45-48: 建议补充说明性能影响建议添加具体的性能影响说明，帮助用户理解这项设置的重要性。
建议在说明中补充：
+如果不禁用此限制，可能会导致以下问题： +- WebAPI 响应时间增加 +- 封禁操作延迟 +- 系统稳定性下降
66-76: 建议添加故障排除指南配置步骤清晰，但建议补充常见问题的排查方法。
建议在最后添加：
+### 常见问题排查 +如果连接测试失败，请检查： +1. BitComet 是否正在运行 +2. 远程访问是否已启用 +3. 端口号是否正确 +4. 用户名密码是否正确 +5. 防火墙是否已放行端口docs/module/active-monitoring.md (1)
7-7: 建议完善 API 限制说明关于 Transmission 和 BitComet 的 API 限制说明可以更详细一些。
建议修改为：
-Transmission, BitComet 用户因 API 限制可能缺失部分数据。 +Transmission 和 BitComet 用户请注意：由于这些客户端的 API 限制，某些 Peer 统计数据（如：实时速度、总计流量等）可能无法完整获取。docs/downloader/BiglyBT.md (3)
14-16: 建议增强 Java 版本要求的警告信息建议补充说明使用不兼容版本可能导致的具体问题，例如：
-您的 BiglyBT 必须运行在 Java 11 或更高版本上。如果是 Java 8 或更低版本，则无法使用，必须[切换 Java 版本] +您的 BiglyBT 必须运行在 Java 11 或更高版本上。如果使用 Java 8 或更低版本，插件将无法正常加载和运行，您必须[切换 Java 版本]
19-20: 建议优化菜单操作的描述方式为使表达更加地道，建议调整如下：
-在 BiglyBT/Vuze/Azureus 中，点击"帮助"菜单，然后选择"关于 BiglyBT/Vuze/Azureus"。 +在 BiglyBT/Vuze/Azureus 中，依次选择"帮助"菜单中的"对于 BiglyBT/Vuze/Azureus"选项。🧰 Tools
🪛 LanguageTool
[uncategorized] ~19-~19: “关于”组成的介词短语必需位于句首，或请改用"对于"代替。
Context: ... 在 BiglyBT/Vuze/Azureus 中，点击“帮助”菜单，然后选择“关于 BiglyBT/Vuze/Azureus”。 2. 在弹出的窗口中，查看右侧的...(wb2)
77-79: 建议完善 Token 保存的警告信息建议补充具体的操作时序，使用户更清楚地了解操作步骤：
-**重要提示**：请确保点击保存按钮，否则重启 BiglyBT 后，Token 将重新生成，导致之前的配置失效。 +**重要提示**：配置完成后请立即点击保存按钮。如果在保存之前关闭或重启 BiglyBT，Token 将重新生成，导致之前记录的 Token 失效。docs/faq.md (5)
3-5: 建议添加具体的浏览器缓存清理步骤为了帮助用户更好地解决问题，建议添加具体的缓存清理步骤，例如常见浏览器（Chrome、Firefox等）的具体操作方法。
## 升级后 WebUI 出现白屏、黑屏或无限数据加载 -请尝试清除浏览器缓存。 +请尝试清除浏览器缓存： + +- Chrome：按 Ctrl+Shift+Delete，选择"缓存的图片和文件"，点击"清除数据" +- Firefox：按 Ctrl+Shift+Delete，选择"缓存"，点击"清除" + +清除缓存后，请刷新页面重试。
19-31: 建议添加安全提示关于使用网关地址连接的说明中，建议添加安全相关的注意事项。
**其他 Docker 用户**：执行 `sudo docker network inspect bridge` 命令，找到 Gateway 地址并进行连接。 +> **安全提示**：在生产环境中，建议配置适当的网络安全策略，限制对网关地址的访问权限，以防止未经授权的访问。
41-43: 建议改进格式以提高可读性技术说明很清晰，但可以通过格式优化来提高可读性。
## 反吸血进度检查器为何显示进度超过 100%？ -进度检查器会累加特定种子上的下载进度。若对方出现进度回退、断开重连、更换 PeerID 或 Client name，下载器会视为新客户端并重新计算数据。但 PBH 会持续累积进度，避免对方欺骗反吸血检查。例如，文件大小为 1000MB，对方下载 102% 即表示实际下载了 1020MB 数据。 +进度检查器会累加特定种子上的下载进度。出现超过 100% 的情况可能是由于： + +- 对方出现进度回退 +- 断开重连 +- 更换 PeerID 或 Client name + +在这些情况下，下载器会视为新客户端并重新计算数据。但 PBH 会持续累积进度，避免对方欺骗反吸血检查。 + +> **示例**：若文件大小为 1000MB，显示对方下载 102% 即表示实际下载了 1020MB 数据。
54-62: 建议补充 SSL 证书验证的详细信息SSL 证书验证的说明可以更详细一些，帮助用户理解潜在风险。
## 什么是验证 SSL 证书？ -若填写的地址是 HTTPS 地址，且启用此开关，则会验证 SSL 证书的有效性。无效则报错以保证安全。若关闭，则信任所有 SSL 证书。 +若填写的地址是 HTTPS 地址，且启用此开关，则会验证 SSL 证书的有效性： + +- **启用验证**：系统会检查证书是否由受信任的证书颁发机构（CA）签发、是否在有效期内、域名是否匹配等。如果证书无效，系统会报错以保护您的安全。 +- **关闭验证**：系统将信任所有 SSL 证书，包括自签名证书。这可能带来安全风险，建议仅在测试环境或确认安全的内网环境中使用。
74-78: 需要指定代码块的语言代码块缺少语言标识符，建议添加以提高可读性和语法高亮效果。
-``` +```shell java -Dpbh.please-disable-safe-network-environment-check-i-know-this-is-very-dangerous-and-i-may-lose-my-data-and-hacker-may-attack-me-via-this-endpoint-and-steal-my-data-or-destroy-my-computer-i-am-fully-responsible-for-this-action-and-i-will-not-blame-the-developer-for-any-loss ...<details> <summary>🧰 Tools</summary> <details> <summary>🪛 Markdownlint (0.35.0)</summary> 75-75: null Fenced code blocks should have a language specified (MD040, fenced-code-language) </details> </details> </blockquote></details> <details> <summary>docs/setup/macOS/Manual.md (3)</summary><blockquote> `38-38`: **建议添加 JVM 参数说明** 建议为每个 JVM 参数添加简要说明，帮助用户理解这些设置的作用，特别是内存相关的参数（如 `-Xmx512M` 和 `-Xss512k`）对系统性能的影响。 建议添加如下说明： ```markdown JVM 参数说明： - `-Djava.awt.headless=true`：启用无界面模式 - `-Xmx512M`：设置最大堆内存为 512MB - `-Xss512k`：设置线程栈大小为 512KB - `-XX:+UseG1GC`：使用 G1 垃圾收集器 - `-XX:+UseStringDeduplication`：启用字符串去重 - `-XX:+ShrinkHeapInSteps`：分步收缩堆内存
90-90: 建议补充服务管理命令说明为了帮助用户更好地管理服务，建议添加常用的服务管理命令说明。
建议在文档末尾添加：
常用服务管理命令： - 停止服务：`launchctl unload ~/Library/LaunchAgents/peerbanhelper.plist` - 启动服务：`launchctl load -w ~/Library/LaunchAgents/peerbanhelper.plist` - 查看服务状态：`launchctl list | grep peerbanhelper`
Line range hint
76-76: 需要添加工作目录创建步骤配置文件中指定了
WorkingDirectory，但文档中没有说明如何创建这个目录。这可能导致服务启动失败。建议在第 3 步之前添加：
请确保创建工作目录： ```shell mkdir -p /path/to/PBH注意：请将
/path/to/PBH替换为实际的目录路径。</blockquote></details> <details> <summary>docs/module/ip-address-blocker.md (2)</summary><blockquote> `4-6`: **提示部分的添加很有帮助！** 这个提示能有效引导用户使用更友好的配置方式。建议稍作补充，说明使用 WebUI 的具体优势。 建议修改为： ```diff -不建议通过配置文件配置此功能，您可以直接使用 WebUI 的可视化编辑。 +不建议通过配置文件配置此功能，您可以直接使用 WebUI 的可视化编辑，这样可以实时预览更改并降低配置错误的风险。
Line range hint
89-89: 建议在配置示例部分添加相关提示为保持文档的一致性，建议在 YAML 配置示例之前也添加类似的提示信息。
建议在配置示例之前添加：
+:::tip +以下配置示例仅供参考。建议使用 WebUI 进行配置，而不是直接编辑配置文件。 +::: # 配置文件docs/network/http-server.md (5)
Line range hint
16-31: 建议补充更多安全相关的上下文信息当前的安全说明已经很好，建议增加以下内容：
- 解释为什么本地访问更安全
- 提供使用反向代理的建议（如果需要外部访问）
- 说明暴露到公网的潜在风险
建议添加如下内容：
将 `address` 设置为 `"127.0.0.1"` 可以确保只有本地机器能够访问 WebUI 和下载器封禁列表的端点。 + + > 安全提示：如果确实需要从外部访问 WebUI，建议： + > 1. 使用反向代理（如 Nginx）来控制访问 + > 2. 启用 HTTPS 加密 + > 3. 配置适当的访问控制措施
Line range hint
32-46: 建议补充文件权限相关说明目前的自定义 WebUI 配置说明清晰易懂，建议添加以下安全相关信息：
- static 目录的推荐权限设置
- 文件所有权的建议配置
建议在说明中添加：
您需要在 `data/` 文件夹下手动创建一个名为 `static` 的目录，并将自定义的 WebUI 文件放置在其中。 + + > 注意：请确保： + > 1. static 目录权限设置为 755 + > 2. 文件权限设置为 644 + > 3. 目录和文件的所有者为运行 PBH 的用户
Line range hint
47-61: 建议提供具体的使用场景示例当前的 CORS 设置说明准确且包含了安全警告，建议补充：
- 何时需要启用 CORS 的具体场景
- 如何安全地配置 CORS
建议添加：
将 `allow-cors` 设置为 `true` 可以允许跨域访问，但请注意这可能会带来安全风险。 + + > 示例场景： + > 1. 在开发环境中测试自定义 WebUI（如 localhost:3000 访问 API） + > 2. 使用分离部署的前端应用 + > + > 安全建议： + > 1. 仅在必要时启用 CORS + > 2. 考虑使用反向代理来避免跨域问题
85-85: 建议补充解除封禁的操作说明关于防暴力破解的说明很重要，建议补充以下信息：
- 如何确认 IP 是否被封禁
- 如何手动解除 IP 封禁
建议添加：
请注意：若 WebAPI 连续鉴权失败达到 10 次，您的 IP 地址将被防暴力破解系统屏蔽 15 分钟。 + + > 如需检查 IP 是否被封禁或手动解除封禁，请参考： + > 1. 查看日志文件了解封禁状态 + > 2. 重启服务可以清除所有 IP 封禁 + > 3. 等待 15 分钟后自动解除封禁
Line range hint
87-107: 建议补充配置参数的有效值范围配置示例的注释很详细，建议为关键参数添加有效值范围说明：
- http 端口的有效范围
- token 的最小长度要求
- prefix URL 的格式要求
建议在配置示例中补充：
# WebUI 监听端口 # WebUI listen port http: 9898 + # 有效范围：1024-65535，建议使用非常用端口 + # WebUI 监听地址，如果需要从非本机访问，请修改为 0.0.0.0，本机部署建议使用 127.0.0.1 提高安全性 # WebUI listen address, if you need access from non-localhost location, change it to 0.0.0.0. Locally deploy use 127.0.0.1 is recommended. address: "0.0.0.0" + # 在 PBH 需要给下载器传递地址时，将使用此地址传递，请确保此地址最终可被下载器访问，请【不要】以 / 结尾 # When PBH need pass the URL of blocklist to downloader, it will use this address as prefix, make sure this URL can be access from your downloader. DO NOT end with slash (/) prefix: "http://127.0.0.1:9898" + # URL 必须包含协议（http/https）且不能以斜杠结尾 + # 要访问 WebUI 端点，则需要 Token。如果这里为空，PBH 在启用时将进入 OOBE 向导，指导您进行基本配置 # To access the WebUI endpoint, token is required. If there is empty string, OOBE will start to guide you set it. token: "" + # Token 建议长度：至少 16 个字符，包含字母、数字和特殊字符
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (32)
docs/btn/connect.md(1 hunks)docs/btn/intro.md(1 hunks)docs/downloader/BiglyBT.md(1 hunks)docs/downloader/BitComet.md(1 hunks)docs/downloader/qBittorrent.md(1 hunks)docs/downloader/qBittorrentEE.md(1 hunks)docs/faq.md(1 hunks)docs/intro.md(1 hunks)docs/misc/json-engine.md(1 hunks)docs/module/active-monitoring.md(1 hunks)docs/module/auto-range-ban.md(1 hunks)docs/module/client-name.md(1 hunks)docs/module/ip-address-blocker-rules.md(1 hunks)docs/module/ip-address-blocker.md(1 hunks)docs/module/multi-dial.md(1 hunks)docs/module/peer-id.md(1 hunks)docs/network/http-server.md(6 hunks)docs/network/proxy-server.md(0 hunks)docs/platform/Windows.md(1 hunks)docs/prefandlang/language.md(1 hunks)docs/prefandlang/logger.md(2 hunks)docs/setup/Docker.md(2 hunks)docs/setup/FreeBSD.md(2 hunks)docs/setup/Linux/Deb.md(1 hunks)docs/setup/Linux/LinuxInstall4j.md(1 hunks)docs/setup/Linux/Manual.md(1 hunks)docs/setup/Synology DSM/Imnks.md(1 hunks)docs/setup/Synology DSM/docker.md(1 hunks)docs/setup/Windows/Installer.md(1 hunks)docs/setup/Windows/Portable.md(1 hunks)docs/setup/macOS/Installer.md(1 hunks)docs/setup/macOS/Manual.md(3 hunks)
💤 Files with no reviewable changes (1)
- docs/network/proxy-server.md
✅ Files skipped from review due to trivial changes (4)
- docs/misc/json-engine.md
- docs/module/auto-range-ban.md
- docs/module/client-name.md
- docs/module/peer-id.md
🧰 Additional context used
🪛 LanguageTool
docs/downloader/BiglyBT.md
[uncategorized] ~19-~19: “关于”组成的介词短语必需位于句首，或请改用"对于"代替。
Context: ... 在 BiglyBT/Vuze/Azureus 中，点击“帮助”菜单，然后选择“关于 BiglyBT/Vuze/Azureus”。 2. 在弹出的窗口中，查看右侧的...
(wb2)
docs/setup/Synology DSM/Imnks.md
[uncategorized] ~9-~9: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：便捷"地"安装
Context: ...nHelper 以容器套件的形式引入群晖（Synology）的套件中心，提供便捷的安装与更新服务。 请遵循[矿神SPK源官方教程](https://imnks....
(wb4)
🪛 Markdownlint (0.35.0)
docs/faq.md
75-75: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🔇 Additional comments (53)
docs/prefandlang/logger.md (2)
1-1: 标题修改更加准确和专业
将标题从"日志"改为"日志管理"更好地体现了本节内容的完整性，使文档结构更加清晰。
Line range hint 7-15: 配置示例清晰完整
YAML 配置示例包含了中英双语注释，对配置项的功能解释详尽，对用户非常友好。
docs/setup/Linux/LinuxInstall4j.md (2)
7-7: 标题修改恰当！
新标题"安装指南"更加正式和专业，符合技术文档的规范。
9-9: FHS兼容性警告描述清晰！
警告信息的措辞准确，并通过维基百科链接提供了额外的参考信息。同时，推荐使用Docker的建议也很恰当。
docs/downloader/qBittorrentEE.md (1)
7-7: 描述准确且清晰！
引言简洁地说明了qBittorrentEE与qBittorrent的关系，并恰当地使用了文档链接进行引用。
docs/setup/Windows/Portable.md (1)
5-5: 标题修改恰当！
将标题从"便携版"改为"使用便携版"更好地表明了文档的指导性质，使文档目的更加明确。
docs/btn/connect.md (2)
3-3: 修改很好，语言更加正式清晰！
介绍段落的表述更加专业，并且清楚地说明了文档的目的。
7-7: 描述更加准确和专业！
通过添加组织信息，使服务器描述更加权威和清晰。
docs/platform/Windows.md (1)
1-3: 标题和标题层级结构清晰明确！
标题添加"系统设置"使文档内容更加明确，二级标题中明确指出了系统版本要求，这对用户理解功能的适用范围很有帮助。
docs/setup/macOS/Installer.md (2)
17-19: 内容清晰准确
自启动功能的说明准确且使用了正确的 macOS 术语（菜单栏），表述专业。
21-23: 运行模式介绍简洁明了
对三种运行模式的引导说明清晰，结构合理。
docs/module/ip-address-blocker-rules.md (1)
Line range hint 1-24: 文档结构清晰，内容组织合理
文档采用了清晰的层次结构，配置示例中使用中英双语注释的做法值得肯定，这有助于提高文档的可访问性。
docs/setup/Windows/Installer.md (2)
6-8: 标题修改更加专业且明确
新的标题和章节命名更加正式，清晰地表明了文档的内容和目的。
18-20: 自启动说明清晰准确
开机自启动的说明使用了恰当的术语，解释清楚，用户容易理解。
docs/prefandlang/language.md (7)
1-1: 标题修改更准确，内容说明更清晰！
标题从"国际化"改为"国际化支持"更好地表达了本节的内容范围。对UI和WebUI语言行为的区分说明准确且清晰。
Also applies to: 3-3
5-5: 用词更加专业！
将"更改"改为"调整"使文档语言更加正式。说明文字简洁明了，易于理解。
Also applies to: 7-7
18-18: 语言回退机制说明更加完整！
清晰地解释了语言不支持或文本缺失时的回退逻辑，有助于用户理解系统行为。
22-22: 自定义语言机制说明更加专业！
对覆盖加载机制的解释更加详细和专业，有助于用户理解系统的工作原理。
Also applies to: 24-24
26-26: 兼容性说明很到位！
清楚地解释了系统如何处理旧版本翻译文件，有效地消除了用户对更新后可能出现问题的顾虑。
30-32: 示例说明清晰实用！
通过具体示例来说明覆盖系统的使用方法，使用户更容易理解如何操作。
44-48: 补充示例很有帮助！
通过完全替换的示例，更全面地展示了系统的灵活性，对用户很有帮助。
docs/setup/Docker.md (1)
7-7: 引言表述清晰准确！
引言很好地说明了 Docker 作为推荐部署方式的原因，并强调了其自动启动和稳定运行的优势。
docs/setup/Synology DSM/Imnks.md (1)
13-23: 安装说明清晰完整
安装步骤描述准确，配图恰当，能够有效指导用户完成安装过程。
docs/setup/Linux/Deb.md (1)
5-7: 标题和介绍内容清晰准确！
标题和介绍部分明确指出了支持的系统类型，使用的语言正式得当。
docs/downloader/qBittorrent.md (4)
7-7: 引言部分表述清晰准确！
段落结构完整，专业术语使用恰当，并为 Linux 和 Docker 用户提供了有价值的提示。
11-11: 操作指示更加礼貌规范！
使用"请点击"替代简单的"点击"，语气更加得体。
27-31: 高级设置说明准确到位！
重要设置的说明清晰，使用加粗标记强调关键操作，有助于用户准确完成配置。
Line range hint 1-47: 文档结构清晰，图文搭配合理！
整体文档结构符合技术文档规范，图片说明与文字指导相得益彰。特别赞赏：
- 章节划分逻辑清晰
- 图片位置恰当，便于用户对照操作
- 专业术语使用统一规范
docs/intro.md (2)
9-9: 标题修改恰当，引导语清晰
新的标题更具亲和力，引导语简洁明了。
Also applies to: 11-11
24-24: 帮助指引清晰合理
新的帮助部分结构清晰，引导用户先查看常见问题后再寻求群内帮助，逻辑合理。
Also applies to: 26-26
docs/setup/Linux/Manual.md (5)
6-6: 标题修改更加正式和清晰！
将"手动部署"改为"手动部署指南"使文档性质更加明确，这是一个很好的改进。
8-10: 很好的提示信息添加！
添加 Docker 部署建议的提示框非常恰当，可以帮助用户在开始之前做出更好的选择。交叉引用到 Docker 文档也很有帮助。
41-47: 启动命令说明清晰完整！
启动命令的说明和格式都很规范，JVM 参数配置合理，对文件名替换的说明也很清楚。
49-52: GUI 相关说明非常有帮助！
关于 GUI 自动检测和手动禁用的说明非常清晰，对可能遇到问题的用户很有帮助。
Line range hint 1-55: 文档整体质量显著提升！
本次修改在以下方面都有很好的改进：
- 文档结构更加清晰
- 使用了适当的提示框
- 安装步骤说明更加详细
- 专业术语使用更加规范
- Markdown 格式应用得当
docs/module/multi-dial.md (1)
3-4: 术语修改和功能对比的表述更加专业
将"吸血者"改为"恶意用户"的措辞更加正式得当。同时，新增的ARB与多拨封禁模块的对比说明，有效突出了两者的功能差异，使文档更加清晰。
docs/setup/Synology DSM/docker.md (2)
5-5: 标题和介绍部分表述准确且专业
文档开头的措辞专业得当，特别是对 PeerBanHelper 缩写的说明清晰明确。
Also applies to: 9-9
29-29: 版本标签说明准确且重要
关于避免使用 latest 标签的警告非常重要，有助于用户维持系统稳定性。
docs/btn/intro.md (1)
Line range hint 1-63: 文档整体评价
文档结构清晰，内容全面，语言表达正式且专业。成功地完成了改进中文文档的目标。以下几点值得表扬：
- 历史脉络清晰，层次分明
- 技术概念解释准确
- 隐私安全考虑周全
docs/downloader/BitComet.md (3)
13-16: 警告部分的改进很好
解释更加清晰，特别是关于异步处理和错误提示的说明，有助于用户理解和处理可能遇到的问题。
28-30: 步骤说明清晰完整
配置步骤的描述准确，结构清晰，便于用户操作。
36-39: 配置说明完整且有必要性解释
很好地解释了为什么需要禁用多重连接，并提供了清晰的操作步骤。
docs/module/active-monitoring.md (2)
3-4: 功能说明清晰准确
对主动监测功能的描述简洁明了，很好地解释了其用途和工作原理。
5-7: 硬件警告格式规范，内容重要
警告块的添加非常必要，能有效预防硬件损坏风险。使用 :::warning 语法突出显示也很恰当。
docs/downloader/BiglyBT.md (2)
5-13: 标题格式和兼容性说明的改进很好！
- 标题中的括号前增加了空格，提高了可读性
- "且支持效果最佳"的表述更加准确和专业
Line range hint 1-91: 文档结构清晰，内容组织合理！
- 章节划分符合逻辑
- 截图引用正确
- 步骤说明清晰
- 重要提示突出显示
🧰 Tools
🪛 LanguageTool
[uncategorized] ~19-~19: “关于”组成的介词短语必需位于句首，或请改用"对于"代替。
Context: ... 在 BiglyBT/Vuze/Azureus 中，点击“帮助”菜单，然后选择“关于 BiglyBT/Vuze/Azureus”。 2. 在弹出的窗口中，查看右侧的...
(wb2)
docs/faq.md (5)
7-17: 内容清晰完整，结构合理
端口绑定错误的解释和解决方案都很详细，并且按照不同情况进行了分类说明，便于用户理解和操作。
33-39: 链接引用恰当，说明简洁
文档中的外部链接和参考资料使用得当，能够帮助用户获取更详细的信息。
45-47: 操作指导清晰明确
登录失败的处理步骤说明清楚，用户容易理解和操作。
49-52: 技术说明准确，格式规范
增量封禁的解释准确清晰，使用项目符号区分不同类型，便于理解。
64-66: 统计机制解释清晰
对访问计数和封禁计数的区别解释得很清楚，有助于用户理解统计数据的含义。
docs/setup/macOS/Manual.md (1)
5-30: 文档改进很到位！
标题从"手动安装"改为"手动部署"更加专业，依赖项说明清晰详细，版本验证步骤完整。
docs/network/http-server.md (1)
1-3: 标题和介绍的修改更加准确和专业！
将"HTTP 服务器"改为"HTTP 服务器配置"更好地反映了文档内容。使用"集成"而不是"内置"来描述 Javalin 的使用更加准确，因为这确实是一个集成的第三方组件。
| ### NoGUI 模式 | ||
|
|
||
| NoGUI 模式以控制台形式运行，资源占用最低。此模式更适合高级用户或需要最小化资源使用的场景。 |
There was a problem hiding this comment.
🛠️ Refactor suggestion
建议补充 NoGUI 模式的技术细节
当前对 NoGUI 模式的说明较为简略，建议补充具体的技术细节和使用方法。
建议按如下方式扩展说明：
-NoGUI 模式以控制台形式运行，资源占用最低。此模式更适合高级用户或需要最小化资源使用的场景。
+NoGUI 模式以控制台形式运行，具有以下特点：
+- 通过命令行界面运行，支持标准输入输出
+- 内存占用最低，CPU 使用率显著降低
+- 支持通过配置文件进行设置
+- 可通过系统日志查看运行状态
+
+此模式特别适合：
+- 服务器环境部署
+- 系统资源受限的设备
+- 需要自动化管理的场景
+- 熟悉命令行操作的高级用户📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ### NoGUI 模式 | |
| NoGUI 模式以控制台形式运行，资源占用最低。此模式更适合高级用户或需要最小化资源使用的场景。 | |
| ### NoGUI 模式 | |
| NoGUI 模式以控制台形式运行，具有以下特点： | |
| - 通过命令行界面运行，支持标准输入输出 | |
| - 内存占用最低，CPU 使用率显著降低 | |
| - 支持通过配置文件进行设置 | |
| - 可通过系统日志查看运行状态 | |
| 此模式特别适合： | |
| - 服务器环境部署 | |
| - 系统资源受限的设备 | |
| - 需要自动化管理的场景 | |
| - 熟悉命令行操作的高级用户 |
|
|
||
| ## 使用 Docker Compose 部署 | ||
|
|
||
| 找一个合适的位置创建一个目录作为 PBH 的数据存放位置，并将工作目录切换到此位置。 | ||
| 保存下面的内容到 docker-compose.yml 文件。 | ||
| 选择一个合适的位置，创建一个目录用于存放 PBH 的数据，并将工作目录切换至此位置。然后，将以下内容保存为 `docker-compose.yml` 文件： |
There was a problem hiding this comment.
🛠️ Refactor suggestion
建议补充配置参数的详细说明
当前的 Docker Compose 配置虽然完整，但缺少对关键参数的解释：
- 环境变量
PUID、PGID的作用和推荐值 - 时区设置
TZ的可选值 - 数据卷挂载的目的和重要性
建议在配置文件后添加说明段落：
+### 配置说明
+
+- `PUID` 和 `PGID`：容器内进程的用户ID和组ID，建议设置为当前用户的UID和GID
+- `TZ`：时区设置，中国用户建议设置为 `Asia/Shanghai`
+- `volumes`：数据卷挂载，确保数据持久化存储，请勿更改容器内的路径 `/app/data`Also applies to: 25-25, 38-38
| ``` | ||
|
|
||
| ## 开机启动 | ||
| 请将 `<你下载的安装包文件名>` 替换为你实际下载的安装包文件名。`-f` 参数表示强制更新或安装该软件包。 |
There was a problem hiding this comment.
🛠️ Refactor suggestion
建议补充说明强制安装的影响
文档中提到使用-f参数进行强制安装，但没有详细说明其潜在影响。建议添加相关警告信息。
建议添加以下说明：
-请将 `<你下载的安装包文件名>` 替换为你实际下载的安装包文件名。`-f` 参数表示强制更新或安装该软件包。
+请将 `<你下载的安装包文件名>` 替换为你实际下载的安装包文件名。`-f` 参数表示强制更新或安装该软件包。请注意，强制安装可能会覆盖现有文件，如果您之前已经安装过PBH，请确保已备份重要的配置文件。📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| 请将 `<你下载的安装包文件名>` 替换为你实际下载的安装包文件名。`-f` 参数表示强制更新或安装该软件包。 | |
| 请将 `<你下载的安装包文件名>` 替换为你实际下载的安装包文件名。`-f` 参数表示强制更新或安装该软件包。请注意，强制安装可能会覆盖现有文件，如果您之前已经安装过PBH，请确保已备份重要的配置文件。 |
| - PUID=0 | ||
| - PGID=0 | ||
| - TZ=UTC | ||
| - TZ=Asia/Shanghai # 根据您的时区进行调整 |
There was a problem hiding this comment.
🛠️ Refactor suggestion
建议补充用户权限安全说明
当前配置使用了 root 权限（PUID=0, PGID=0），建议补充说明使用非 root 用户的安全建议。
建议添加如下说明：
- PUID=0
- PGID=0
- TZ=Asia/Shanghai # 根据您的时区进行调整
+ # 建议将 PUID 和 PGID 设置为非 root 用户的 UID 和 GID
+ # 可以通过在 DSM 中运行 id 命令查看当前用户的 UID 和 GID📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - PUID=0 | |
| - PGID=0 | |
| - TZ=UTC | |
| - TZ=Asia/Shanghai # 根据您的时区进行调整 | |
| - PUID=0 | |
| - PGID=0 | |
| - TZ=Asia/Shanghai # 根据您的时区进行调整 | |
| # 建议将 PUID 和 PGID 设置为非 root 用户的 UID 和 GID | |
| # 可以通过在 DSM 中运行 id 命令查看当前用户的 UID 和 GID |
| 此情况在少数设备上可能出现。若遇到此问题，可能需要手动将容器加入到 bridge 网络组。具体操作步骤可能因设备而异，但通常可以在 Docker 的网络设置中找到相关选项。 | ||
|
|
||
|  | ||
|  *（注意：此图仅为示意，实际操作需根据 Docker 的网络配置界面进行调整）* |
There was a problem hiding this comment.
🛠️ Refactor suggestion
建议扩充网络配置的具体操作指南
关于 bridge 网络配置的说明可以更加具体，建议补充详细的操作步骤。
建议扩展说明如下：
此情况在少数设备上可能出现。若遇到此问题，可能需要手动将容器加入到 bridge 网络组。具体操作步骤可能因设备而异，但通常可以在 Docker 的网络设置中找到相关选项。
+具体操作步骤如下：
+1. 在 Docker 界面中，进入"网络"设置
+2. 找到名为"bridge"的默认网络
+3. 编辑网络设置，将 PeerBanHelper 容器添加到该网络中
+4. 保存设置并重启容器📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| 此情况在少数设备上可能出现。若遇到此问题，可能需要手动将容器加入到 bridge 网络组。具体操作步骤可能因设备而异，但通常可以在 Docker 的网络设置中找到相关选项。 | |
|  | |
|  *（注意：此图仅为示意，实际操作需根据 Docker 的网络配置界面进行调整）* | |
| 此情况在少数设备上可能出现。若遇到此问题，可能需要手动将容器加入到 bridge 网络组。具体操作步骤可能因设备而异，但通常可以在 Docker 的网络设置中找到相关选项。 | |
| 具体操作步骤如下： | |
| 1. 在 Docker 界面中，进入"网络"设置 | |
| 2. 找到名为"bridge"的默认网络 | |
| 3. 编辑网络设置，将 PeerBanHelper 容器添加到该网络中 | |
| 4. 保存设置并重启容器 | |
|  *（注意：此图仅为示意，实际操作需根据 Docker 的网络配置界面进行调整）* |
| 在 24 年 8 月，还帮助我们发现了一起使用随机 PeerID 的吸血客户端。 | ||
|
|
||
| ### 避免 PBH 被针对绕过 | ||
| 在数据上报过程中，BTN 检查是否出现新客户端，并记录首次出现和最后一次见到的时间。这有助于推断恶意吸血者的活动时间范围。例如，在 2024 年 8 月，BTN 帮助我们发现了一起使用随机 PeerID 的吸血客户端。 |
There was a problem hiding this comment.
需要更新时间引用
文档中提到"2024年8月"作为未来时间点，但现在已是2024年11月。建议修改为过去时态。
-例如，在 2024 年 8 月，BTN 帮助我们发现了一起使用随机 PeerID 的吸血客户端。
+例如，在 2024 年初，BTN 帮助我们发现了一起使用随机 PeerID 的吸血客户端。📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| 在数据上报过程中，BTN 检查是否出现新客户端，并记录首次出现和最后一次见到的时间。这有助于推断恶意吸血者的活动时间范围。例如，在 2024 年 8 月，BTN 帮助我们发现了一起使用随机 PeerID 的吸血客户端。 | |
| 在数据上报过程中，BTN 检查是否出现新客户端，并记录首次出现和最后一次见到的时间。这有助于推断恶意吸血者的活动时间范围。例如，在 2024 年初，BTN 帮助我们发现了一起使用随机 PeerID 的吸血客户端。 |
| 请始终牢记：只连接到您信任的 BTN 服务器。 |
There was a problem hiding this comment.
🛠️ Refactor suggestion
建议补充安全建议
在提醒用户只连接可信服务器时，建议提供更具体的验证方法。
-请始终牢记：只连接到您信任的 BTN 服务器。
+请始终牢记：只连接到您信任的 BTN 服务器。建议通过以下方式验证服务器可信度：
+1. 确认服务器的 SSL 证书是否有效
+2. 验证服务器域名是否在官方文档列表中
+3. 检查服务器的安全记录和社区反馈📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| 请始终牢记：只连接到您信任的 BTN 服务器。 | |
| 请始终牢记：只连接到您信任的 BTN 服务器。建议通过以下方式验证服务器可信度： | |
| 1. 确认服务器的 SSL 证书是否有效 | |
| 2. 验证服务器域名是否在官方文档列表中 | |
| 3. 检查服务器的安全记录和社区反馈 |
我在文心一言里过了一遍又自行修改了一下，看看怎样？
Summary by CodeRabbit