finish english doc for installer

PBH-BTN · Nov 12, 2024 · deeaf9b · deeaf9b
1 parent 8cff738
commit deeaf9b
Show file tree

Hide file tree

Showing 16 changed files with 109 additions and 106 deletions.
diff --git a/docs/setup/Linux/Deb.md b/docs/setup/Linux/Deb.md
@@ -30,7 +30,7 @@ OpenJDK 64-Bit Server VM (build xxxxxxx, mixed mode, sharing)
 ```
 
 ## 下载安装
-访问 [PBH最新版版本发布页](https://github.com/PBH-BTN/PeerBanHelper/releases/latest)，向下滚动，下载 DEB 文件。
+访问 [PBH最新版版本发布页](https://github.com/PBH-BTN/PeerBanHelper/releases/latest) 下载 DEB 文件。
 
 安装 DEB 文件：
 

diff --git a/docs/setup/Linux/LinuxInstall4j.md b/docs/setup/Linux/LinuxInstall4j.md
@@ -5,8 +5,9 @@ sidebar_label: 安装程序(不推荐)
 
 
 # 安装程序
-
-> 请注意：我们更推荐您使用 [Docker部署](../Docker.md)
+:::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)
+:::
 
 Redhat 系用户请前往 [Releases](https://github.com/PBH-BTN/PeerBanHelper/releases)下载`.rpm`软件包，对于其他 Linux 用户请 下载以 `.sh` 结尾的安装程序。
 

diff --git a/docs/setup/Linux/Manual.md b/docs/setup/Linux/Manual.md
@@ -4,9 +4,9 @@ sidebar_position: 2
 
 
 # 手动部署
-
+:::tip
 请注意：我们更推荐您使用 [Docker部署](../Docker.md))
-
+:::
 ## 安装依赖
 
 使用你的包管理器安装 OpenJDK 21 或更高版本（此处以 apt 为例）：
@@ -31,7 +31,7 @@ OpenJDK 64-Bit Server VM (build xxxxxxx, mixed mode, sharing)
 ```
 
 ## 下载JAR
-访问 [PBH最新版版本发布页](https://github.com/PBH-BTN/PeerBanHelper/releases/latest)，向下滚动，下载 JAR 文件和 libraries.tar.gz。
+访问 [PBH最新版版本发布页](https://github.com/PBH-BTN/PeerBanHelper/releases/latest)，下载 JAR 文件和 libraries.tar.gz。
 
 将解压出来的 libraries 文件夹和 jar 放在一起。
 

diff --git a/docs/setup/Synology DSM/docker.md b/docs/setup/Synology DSM/docker.md
@@ -22,7 +22,7 @@ sidebar_position: 6
 
 ## 获取版本标签
 
-首先访问 [PBH最新版版本发布页](https://github.com/PBH-BTN/PeerBanHelper/releases/latest)，向下滚动，找到如图所示的 “Docker 用户” 章节，并复制镜像标签备用。
+首先访问 [PBH最新版版本发布页](https://github.com/PBH-BTN/PeerBanHelper/releases/latest)，找到如图所示的 “Docker 用户” 章节，并复制镜像标签备用。
 
 ![image-tag](../assets/docker-tag.png)
 

diff --git a/docs/setup/Windows/Portable.md b/docs/setup/Windows/Portable.md
@@ -11,6 +11,11 @@ sidebar_position: 2
 
 ## 升级
 
+:::warning
+你必须重新解压所有的文件，**不可以覆盖！**必须重新解压所有内容！**
+:::
+
+
 要升级 Portable 包，首先将 `data` 数据文件夹挪出工作目录到其他位置。删除原来的文件夹并重新解压新版本的 Portable 包，并将 `data` 数据文件夹挪回原来的位置即可。
 
-**特别注意：你必须重新解压所有的文件，不可以覆盖！不可以覆盖！不可以覆盖！不可以覆盖！不可以覆盖！不可以覆盖！不可以覆盖！必须重新解压所有内容！**
+
diff --git a/docs/setup/macOS/Installer.md b/docs/setup/macOS/Installer.md
@@ -20,7 +20,7 @@ sidebar_position: 1
 
 ### GUI
 
-顾名思义，以图形窗口启动 PeerBanHelper。会有一个窗口可以查看日志，以及一个可以打开数据文件夹和免登录打开 WebUI 的菜单。
+以图形窗口启动 PeerBanHelper。会有一个窗口可以查看日志，以及一个可以打开数据文件夹和免登录打开 WebUI 的菜单。
 点击窗口的关闭按钮，就可以最小化到系统托盘图标。
 
 ### GUI Silent
@@ -29,4 +29,4 @@ sidebar_position: 1
 
 ### NoGUI
 
-以控制台的模式情况，最节约资源。适合硬核用户。
+以控制台的模式情况，最节约资源。
diff --git a/i18n/en/docusaurus-plugin-content-docs/current/setup/Docker.md b/i18n/en/docusaurus-plugin-content-docs/current/setup/Docker.md
@@ -8,7 +8,7 @@ Docker is the recommended deployment method for PeerBanHelper on Linux. Using th
 
 ## Get the version tags
 
-First visit the [PBH latest version release page](https://github.com/PBH-BTN/PeerBanHelper/releases/latest), scroll down and find the “Docker Users” section as shown and copy the image tag for backup.
+First visit the [PBH latest version release page](https://github.com/PBH-BTN/PeerBanHelper/releases/latest), find the “Docker Users” section as shown and copy the image tag for backup.
 
 ![image-tag](./assets/docker-tag.png)
 

diff --git a/i18n/en/docusaurus-plugin-content-docs/current/setup/FreeBSD.md b/i18n/en/docusaurus-plugin-content-docs/current/setup/FreeBSD.md
@@ -3,46 +3,45 @@ sidebar_position: 2
 ---
 
 # FreeBSD
+ After `v6.4.1`, PeerBanHelper provides a FreeBSD version of the installation package, currently supporting `13.4` and `14.1` two versions.
 
-从`v6.4.1`之后，PeerBanHelper 提供 FreeBSD 版本安装包，目前支持`13.4`和`14.1`两个版本。
-
-请前往[发布](https://github.com/PBH-BTN/PeerBanHelper/releases/latest)页面找到你对应版本的 FreeBSD 安装包，复制链接，输入以下命令下载：
+Please go to the [release](https://github.com/PBH-BTN/PeerBanHelper/releases/latest) page to find the FreeBSD package for your corresponding version, copy the link, and enter the following command to download:
 
 ```
 fetch https://github.com/PBH-BTN/PeerBanHelper/releases/download/v6.4.2/peerbanhelper-v*.*.*-FreeBSD-*.*-RELEASE.pkg
 ```
 
-## 安装依赖
-使用 `pkg` 工具安装 OpenJDK 21 或更高版本：
+## Install Java
+Use  `pkg` to install OpenJDK 21 or higher：
 
 ```shell
 sudo pkg install openjdk21
 ```
 
-验证安装是否成功：
+Verify:
 
 ```shell
 java -version
 ```
 
-如果安装成功，则会输出类似下列的版本号：
+Once you installed successfully, you will get the following output:
 
 ```plain
 OpenJDK Runtime Environment (build 21.0.3+9-1)
 OpenJDK 64-Bit Server VM (build 21.0.3+9-1, mixed mode, sharing)
 ```
 
-## 安装
+## Install
 ```shell
-pkg add -f peerbanhelper-v*.*.*-FreeBSD-*.*-RELEASE.pkg # -f 表示强制更新安装
+pkg add -f peerbanhelper-v*.*.*-FreeBSD-*.*-RELEASE.pkg # -f for force install
 ```
 
-## 运行
+## Run
 ```shell
 service peerbanhelper onestart
 ```
 
-## 开机启动
+## Auto-start
 ```shell
 sysrc peerbanhelper_enable=YES
 ```
diff --git a/i18n/en/docusaurus-plugin-content-docs/current/setup/Linux/Deb.md b/i18n/en/docusaurus-plugin-content-docs/current/setup/Linux/Deb.md
@@ -4,46 +4,44 @@ sidebar_position: 1
 
 # Debian/Ubuntu/Kali Linux
 
->适用于Debian/Ubuntu/Kali Linux等发行版
+>Suitable for Debian-derived distributions, such as Ubuntu, Kali Linux, etc.
 
-## 安装依赖
-
-使用`apt`安装 OpenJDK 21 或更高版本：
+## Install dependencies
 
 ```shell
 sudo apt-get update
 sudo apt-get install openjdk-21-jdk-headless -y
 ```
 
-验证安装是否成功：
+Verify:
 
 ```shell
 java -version
 ```
 
-如果安装成功，则会输出类似下列的版本号：
+You will get the following output if you have successfully installed:
 
 ```plain
 openjdk version "xx.xx.xxx" 2024-01-16
 OpenJDK Runtime Environment (build xxxxxxx)
 OpenJDK 64-Bit Server VM (build xxxxxxx, mixed mode, sharing)
 ```
 
-## 下载安装
-访问 [PBH最新版版本发布页](https://github.com/PBH-BTN/PeerBanHelper/releases/latest)，向下滚动，下载 DEB 文件。
+## Install
+Download the deb file from [Release](https://github.com/PBH-BTN/PeerBanHelper/releases/latest)
 
-安装 DEB 文件：
+Install the deb:
 
 ```shell
 sudo dpkg -i peerbanhelper_*.*.*_all.deb
 ```
 
-## 启动
+## Run
 ```shell
 systemctl start peerbanhelper
 ```
 
-如需后台/开机运行，请运行：
+## Auto-start
 ```shell
 systemctl enable peerbanhelper
 ```
diff --git a/i18n/en/docusaurus-plugin-content-docs/current/setup/Linux/LinuxInstall4j.md b/i18n/en/docusaurus-plugin-content-docs/current/setup/Linux/LinuxInstall4j.md
@@ -1,14 +1,14 @@
 ---
 sidebar_position: 3
-sidebar_label: 安装程序(不推荐)
+sidebar_label: Installer(not recommended)
 ---
 
 
-# 安装程序
+# Installer
+:::tip
+It does not meet the [FSH](https://en.wikipedia.org/wiki/Filesystem_Hierarchy_Standard) standard, [Docker](../Docker.md) is recmmended for Linux users.
+:::
 
-> 请注意：我们更推荐您使用 [Docker部署](../Docker.md)
+For Redhat-based user, please go to [Releases](https://github.com/PBH-BTN/PeerBanHelper/releases) to download a `.rpm` package, for other user please download the `.sh` file.
 
-Redhat 系用户请前往 [Releases](https://github.com/PBH-BTN/PeerBanHelper/releases)下载`.rpm`软件包，对于其他 Linux 用户请 下载以 `.sh` 结尾的安装程序。
-
-
-默认使用 CLI 安装向导，如果您的 Linux 安装支持桌面环境，将启动图形安装程序，操作与 Windows 版一致。
+The installer will use CLI by default, if your Linux installation supports a desktop environment, the graphical installer will be started, just like the Windows version.
diff --git a/i18n/en/docusaurus-plugin-content-docs/current/setup/Linux/Manual.md b/i18n/en/docusaurus-plugin-content-docs/current/setup/Linux/Manual.md
@@ -3,46 +3,45 @@ sidebar_position: 2
 ---
 
 
-# 手动部署
+# Maunal Install
+:::tip
+[Docker](../Docker.md) is more recmmended.
+:::
 
-请注意：我们更推荐您使用 [Docker部署](../Docker.md))
+## Install OpenJDK
 
-## 安装依赖
-
-使用你的包管理器安装 OpenJDK 21 或更高版本（此处以 apt 为例）：
+Use your package manager to install OpenJDK 21 or higher (here is an example using apt):
 
 ```shell
 sudo apt-get update
 sudo apt-get install openjdk-21-jdk-headless -y
 ```
 
-验证安装是否成功：
+Verify the installation:
 
 ```shell
 java -version
 ```
 
-如果安装成功，则会输出类似下列的版本号：
+If the installation is successful, you will see output similar to the following:
 
 ```plain
 openjdk version "xx.xx.xxx" 2024-01-16
 OpenJDK Runtime Environment (build xxxxxxx)
 OpenJDK 64-Bit Server VM (build xxxxxxx, mixed mode, sharing)
 ```
 
-## 下载JAR
-访问 [PBH最新版版本发布页](https://github.com/PBH-BTN/PeerBanHelper/releases/latest)，向下滚动，下载 JAR 文件和 libraries.tar.gz。
+## Download Jar
+Download the `jar` and `libraries.tar.gz` from [Release](https://github.com/PBH-BTN/PeerBanHelper/releases/latest).
 
-将解压出来的 libraries 文件夹和 jar 放在一起。
+Unzip them into a same directory.
 
-使用命令来启动 PBH：
+Using following command to launch PBH：
 ```shell
-java -jar -Xmx512M -XX:+UseG1GC -XX:+UseStringDeduplication -XX:+ShrinkHeapInSteps -jar 替换这段文字为JAR文件的文件名
+java -jar -Xmx512M -XX:+UseG1GC -XX:+UseStringDeduplication -XX:+ShrinkHeapInSteps -jar <jar file>
 ```
-通常情况下，PBH 会自动探测桌面环境，并在支持的情况下启用 GUI，但在部分设备上，GUI 可能会初始化失败。遇到此类情况，请手动禁用 GUI：
+PBH will automatically detect the desktop environment and enable the GUI if supported, but the GUI may fail to initialize on some devices. In such cases, manually disable the GUI:
 
 ```shell
-java -jar -Xmx512M -XX:+UseG1GC -XX:+UseStringDeduplication -XX:+ShrinkHeapInSteps -jar 替换这段文字为JAR文件的文件名 nogui
+java -jar -Xmx512M -XX:+UseG1GC -XX:+UseStringDeduplication -XX:+ShrinkHeapInSteps -jar <jar file> nogui
 ```
-
-即可启动 PBH。如需后台/开机运行，请自行[配置 systemd 系统服务](https://github.com/PBH-BTN/PeerBanHelper/issues/179#issuecomment-2198225784)。
diff --git a/i18n/en/docusaurus-plugin-content-docs/current/setup/Synology DSM/docker.md b/i18n/en/docusaurus-plugin-content-docs/current/setup/Synology DSM/docker.md
@@ -22,7 +22,7 @@ sidebar_position: 6
 
 ## 获取版本标签
 
-首先访问 [PBH最新版版本发布页](https://github.com/PBH-BTN/PeerBanHelper/releases/latest)，向下滚动，找到如图所示的 “Docker 用户” 章节，并复制镜像标签备用。
+首先访问 [PBH最新版版本发布页](https://github.com/PBH-BTN/PeerBanHelper/releases/latest)，找到如图所示的 “Docker 用户” 章节，并复制镜像标签备用。
 
 ![image-tag](../assets/docker-tag.png)
 

diff --git a/i18n/en/docusaurus-plugin-content-docs/current/setup/Windows/Installer.md b/i18n/en/docusaurus-plugin-content-docs/current/setup/Windows/Installer.md
@@ -3,33 +3,33 @@ sidebar_position: 1
 ---
 
 
-# 安装器
+# Installer
 
-## 下载和安装
+## Download and Installation
 
-打开 [GitHub Releases](https://github.com/PBH-BTN/PeerBanHelper/releases/latest)。你会找到三个以 `.exe` 结尾的安装程序。
+Open [GitHub Releases](https://github.com/PBH-BTN/PeerBanHelper/releases/latest). You will find three installers ending with `.exe`.
 
-其中，一种带有 `nojava` 标记，另一种不带。如果你对什么是 Java 不熟悉，请选择**不带**nojava标记的下载。
+Among them, one has a `nojava` tag, and the other does not. If you are unfamiliar with what Java is, please choose the download **without** the nojava tag.
 
-然后，你还会注意到还有 `amd64` 和 `aarch64` 的区别：
-* 普通用户，请全部统一下载带有 `amd64` 标记的 `.exe` 安装程序。
-* 如果你是不幸购买了高通骁龙 ARM 架构处理器的 Windows 笔记本的倒霉蛋小白鼠用户：请下载带有 `aarch64` 的 `.exe` 安装程序。
+Then, you will also notice the difference between `amd64` and `aarch64`:
+* For most users, please download the `.exe` installer with the `amd64` tag.
+* If you are an unfortunate user who has purchased a Windows notebook with a Qualcomm Snapdragon CPU: please download the `.exe` installer with the `aarch64` tag.
 
-### 开机启动
+### Boot Startup
 
-勾选随系统启动时，当您登录到 Windows 桌面，PBH 就会静默启动到系统托盘。
+When you check the box to start with the system, PBH will silently start to the system tray when you log in to the Windows desktop.
 
 ## GUI/GUI Silent/NoGUI
 
 ### GUI
 
-顾名思义，以图形窗口启动 PeerBanHelper。会有一个窗口可以查看日志，以及一个可以打开数据文件夹和免登录打开 WebUI 的菜单。
-点击窗口的关闭按钮，就可以最小化到系统托盘图标。
+As the name suggests, PeerBanHelper starts with a graphical window. There will be a window to view logs, and a menu to open the data folder and log in to the WebUI without logging in.
+Clicking the close button on the window will minimize it to the system tray icon.
 
 ### GUI Silent
 
-与 GUI 类似，但启动时不会显示窗口。适合喜欢静默启动的用户。
+Similar to GUI, but the window will not be displayed when starting. Suitable for users who like silent startup.
 
 ### NoGUI
 
-以控制台的模式情况，最节约资源。适合硬核用户。
+In the console mode situation, it is the most resource-saving. Suitable for pro users.
diff --git a/i18n/en/docusaurus-plugin-content-docs/current/setup/Windows/Portable.md b/i18n/en/docusaurus-plugin-content-docs/current/setup/Windows/Portable.md
@@ -2,15 +2,17 @@
 sidebar_position: 2
 ---
 
-# 便携版
+# Portable
 
-## 下载和安装
+## Install
 
-从 [GitHub Releases](https://github.com/PBH-BTN/PeerBanHelper/releases/latest) 下载以 `.zip` 结尾的 Windows Portable 压缩包。
-解压即用。
+Download the `zip` from [GitHub Releases](https://github.com/PBH-BTN/PeerBanHelper/releases/latest) , unzip it.
 
-## 升级
+## Upgrade
+:::warning
+You must unzip all of the zip, **do not** use overwrite!
+:::
 
-要升级 Portable 包，首先将 `data` 数据文件夹挪出工作目录到其他位置。删除原来的文件夹并重新解压新版本的 Portable 包，并将 `data` 数据文件夹挪回原来的位置即可。
 
-**特别注意：你必须重新解压所有的文件，不可以覆盖！不可以覆盖！不可以覆盖！不可以覆盖！不可以覆盖！不可以覆盖！不可以覆盖！必须重新解压所有内容！**
+To upgrade, firstly backup your `data`. Unzip the latest Portable package, then restore your  `data` directory.
+