Skip to content

Commit

Permalink
Merge pull request #21 from CreeperAWA/master
Browse files Browse the repository at this point in the history
使用AI翻译三个文档,修改Linux/LinuxInstall4j.md文档的一个提示等级
  • Loading branch information
Ghost-chu authored Dec 8, 2024
2 parents 1bc7cc4 + 63291f4 commit 7c7d955
Show file tree
Hide file tree
Showing 5 changed files with 37 additions and 34 deletions.
3 changes: 1 addition & 2 deletions docs/hook/ban-invoker.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@

PBH 可以在封禁 IP 的同时生成一份 `ipfilter.dat` 文件给其它下载器使用。


```yaml
# 封禁列表处理
# PBH 能够除了调用 BT 客户端的封禁 API 外,还能够进行如下操作,以便适配更多其它客户端
Expand Down Expand Up @@ -126,4 +125,4 @@ banlist-invoker:
- "/bin/sh -c 'ipset add peerbanhelper-blocklist ${peer.ip}'"
unban:
- "/bin/sh -c 'ipset remove peerbanhelper-blocklist ${peer.ip}'"
```
```
4 changes: 2 additions & 2 deletions docs/setup/Linux/LinuxInstall4j.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ sidebar_label: 安装程序(不推荐)


# 安装指南
:::tip
**重要提示**请注意,以下安装过程可能会破坏系统的[FHS](https://zh.wikipedia.org/wiki/%E6%96%87%E4%BB%B6%E7%B3%BB%E7%BB%9F%E5%B1%82%E6%AC%A1%E7%BB%93%E6%9E%84%E6%A0%87%E5%87%86)兼容性。为了确保更稳定和兼容的安装,我们强烈推荐您使用 [Docker部署方案](../Docker.md)
:::warning
请注意,以下安装过程可能会破坏系统的[FHS](https://zh.wikipedia.org/wiki/%E6%96%87%E4%BB%B6%E7%B3%BB%E7%BB%9F%E5%B1%82%E6%AC%A1%E7%BB%93%E6%9E%84%E6%A0%87%E5%87%86)兼容性。为了确保更稳定和兼容的安装,我们强烈推荐您使用 [Docker部署方案](../Docker.md)
:::
对于Redhat系列的用户,请访问[Releases页面](https://github.com/PBH-BTN/PeerBanHelper/releases)下载适用于您的系统的`.rpm`软件包。而其他Linux用户,则应该下载以`.sh`结尾的脚本安装程序。

Expand Down
22 changes: 11 additions & 11 deletions i18n/en/docusaurus-plugin-content-docs/current/hook/ban-invoker.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
# 封禁执行器

## 生成本地 ipfilter.dat
# Banlist invoker

PBH 可以在封禁 IP 的同时生成一份 `ipfilter.dat` 文件给其它下载器使用。
## Generate Local ipfilter.dat

PBH can generate an `ipfilter.dat` file for other downloaders while banning IPs.

```yaml
# 封禁列表处理
Expand All @@ -17,7 +16,7 @@ banlist-invoker:
enabled: false
```
生成的文件内容示例如下:
An example of the generated file content is as follows:
```
36.154.243.166-36.154.243.166,90,[L1]PBH Generated Rule-ebf4c937-e66a-473f-ae1b-e7e9ca673604
Expand All @@ -28,14 +27,15 @@ banlist-invoker:
221.131.158.182-221.131.158.182,90,[L1]PBH Generated Rule-9335b44e-e7e7-47c2-8062-72aadea0127d
```

## 执行系统命令
## Execute System Commands

When banning/unbanning/clearing the banlist, PBH can execute a series of system commands. You can use this feature to manipulate the system firewall.

在出现封禁/解封禁/清理封禁列表事件发生时,PBH 可以执行一系列系统命令。您可以使用此功能操作系统防火墙。
:::warning
执行命令时将使用与 PBH 当前用户相同的权限执行。
Commands will be executed with the same permissions as the current user of PBH.
:::

默认示例配置为使用 ipset iptables 从系统防火墙上封禁 IP 地址。
The default example configuration uses ipset and iptables to ban IP addresses on the system firewall.

```yaml
# 封禁列表处理
Expand Down Expand Up @@ -79,7 +79,7 @@ banlist-invoker:
- "/bin/sh -c 'ipset remove peerbanhelper-blocklist ${peer.ip}'"
```
## 配置文件
## Configuration File
```yaml
# 封禁列表处理
Expand Down Expand Up @@ -125,4 +125,4 @@ banlist-invoker:
- "/bin/sh -c 'ipset add peerbanhelper-blocklist ${peer.ip}'"
unban:
- "/bin/sh -c 'ipset remove peerbanhelper-blocklist ${peer.ip}'"
```
```
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# HTTP 服务器
# HTTP Server Configuration

PeerBanHelper 内置了 Javalin 作为内置 HTTP 服务器,以提供 WebUI 管理界面,并和部分下载器进行交互。
PeerBanHelper integrates Javalin as its built-in HTTP server to support the WebUI management interface and interact with some downloaders.

## 更改 WebUI 端口
## Modify WebUI Port Number

```yaml
# Http 服务器设置
Expand All @@ -13,7 +13,9 @@ server:
http: 9898
```
## 关闭公网监听,仅开放本地的 WebUI 和下载器封禁列表提供端点访问
## Restrict Local Network Access for WebUI Listening
To enhance security, you can configure the listening address of the WebUI to allow only local access.
```yaml
# Http 服务器设置
Expand All @@ -25,12 +27,13 @@ server:
address: "0.0.0.0"
```
## 使用外部 WebUI
Setting `address` to `"127.0.0.1"` ensures that only local machines can access the endpoints for the WebUI and the download ban list.

## Use Customized WebUI

PeerBanHelper 可以从文件系统加载外部 WebUI 文件。
PeerBanHelper supports loading a customized WebUI file from the filesystem.

首先需要在 `data/` 文件夹手动创建一个 `static` 目录,里面放置 WebUI 文件。
然后在配置文件中手动添加一行隐藏配置,让 PBH 使用外部 WebUI 文件:
You need to manually create a `static` directory within the `data/` folder, and place your customized WebUI files there. Then add corresponding settings in the configuration file to enable the custom WebUI:

```yaml
# Http 服务器设置
Expand All @@ -41,9 +44,9 @@ server:
external-webui: true
```

## 使用不同域的 WebUI
## Cross-Origin Resource Sharing (CORS) Configuration

PeerBanHelper 开启了 CORS 保护,如果使用来自其它位置(非内置 HTTP 服务器提供)的 WebUI,则会被 CORS 拒绝。因此您需要禁用 CORS 保护:
Out of security considerations, PeerBanHelper enables CORS protection by default. If you are using a non-built-in HTTP server's WebUI, you need to disable the CORS protection.

```yaml
# Http 服务器设置
Expand All @@ -55,12 +58,13 @@ server:
allow-cors: false
```

## 更改 WebUI Token
Setting `allow-cors` to `true allows cross-domain access, but please be aware of potential security risks.

如果不幸忘记了 WebUI Token 是什么,又或者您想修改下 Token,则可以在配置文件中修改:
## Modify WebUI Access Token

```yaml
If you have forgotten the WebUI's access token or wish to change it, update this in your configuration file:

```yaml
# Http 服务器设置
# Http Server Settings
server:
Expand All @@ -70,17 +74,17 @@ server:
token: ""
```

## 开发自己的 WebUI / WebAPI
## Developing Customized WebUI/WebAPI

我们鼓励开发者为 PeerBanHelper 编写或改进 WebUI
We encourage developers to create or improve the WebUI for PeerBanHelper.

自 v6.0.1 开始,您可以在这里查看完整的 API 文档:
Since version 6.0.1, you can view the complete API documentation at:

[https://peerbanhelper.apifox.cn](https://peerbanhelper.apifox.cn)

请注意:如果 WebAPI 连续鉴权失败 10 次,您的 IP 地址会被防暴力破解系统屏蔽 15 分钟。
Please note: If continuous authentication failures exceed 10 times for a WebAPI endpoint, your IP address will be blacklisted for 15 minutes by the brute-force protection system.

## 配置文件
## Complete Configuration File Example

```yaml
# Http 服务器设置
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 代理服务器

尽管修改 JVM 参数也能让 PBH 使用代理服务器,但我们推荐您通过配置文件修改相关配置。
Although modifying JVM parameters can also enable PBH to use a proxy server, we recommend that you modify the relevant configuration through the configuration file.

## 配置文件
```yaml
Expand Down

0 comments on commit 7c7d955

Please sign in to comment.