Skip to content

Commit

Permalink
Merge pull request #17 from CreeperAWA/master
Browse files Browse the repository at this point in the history
修正错误的拼写、语法、标点和命令
  • Loading branch information
Gaojianli authored Nov 24, 2024
2 parents c6dc5a0 + 145df30 commit 0794bde
Show file tree
Hide file tree
Showing 6 changed files with 30 additions and 31 deletions.
6 changes: 1 addition & 5 deletions docs/setup/Windows/Portable.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
sidebar_position: 2
---

# 便携版

## 下载和安装
Expand All @@ -12,10 +11,7 @@ sidebar_position: 2
## 升级

:::warning
你必须重新解压所有的文件,**不可以覆盖**必须重新解压所有内容!**
你必须重新解压所有的文件,**不可以**覆盖**必须重新解压所有内容!**
:::


要升级 Portable 包,首先将 `data` 数据文件夹挪出工作目录到其他位置。删除原来的文件夹并重新解压新版本的 Portable 包,并将 `data` 数据文件夹挪回原来的位置即可。


3 changes: 1 addition & 2 deletions i18n/en/docusaurus-plugin-content-docs/current/btn/intro.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
sidebar_position: 1
---

# What is BTN

Before we start to understand what BTN is, we first need to understand various anti-leeching methods in history.
Expand Down Expand Up @@ -71,4 +70,4 @@ It sounds like a lot of data needs to be uploaded to the server. The answer is:

To perform these analysis operations, BTN must collect and upload a large amount of necessary data, all types of uploaded data can be found in the [BTN protocol specification](https://github.com/PBH-BTN/BTN-Spec).

It is particularly worth mentioning that: when uploading, we will not upload the info_hash and name of the torrent. Instead, we use the irreversible hashed torrent
It is particularly worth mentioning that: when uploading, we will not upload the info_hash and name of the torrent. Instead, we use the irreversible hashed torrent.
22 changes: 10 additions & 12 deletions i18n/en/docusaurus-plugin-content-docs/current/intro.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
sidebar_position: 1
---

# Welcome

Welcome to the documentation of PeerBanHelper. This document will provide you with detailed steps and common issues for PeerBanHelper from installation to configuration.
Expand All @@ -10,17 +9,16 @@ Welcome to the documentation of PeerBanHelper. This document will provide you wi

Please select your operating system or deployment method to view the installation tutorial:

| Platform | Link |
| ----------------------------- | ---------------------------------- |
| Windows Installer | [View](./setup/Windows/Installer.md) |
| Windows Portable | [View](./setup/Windows/Portable.md) |
| Docker | [View](./setup/Docker.md) |
| Synology DSM(Package) | [View](./setup/Synology%20DSM/Imnks.md) |
| Synology DSM(Container Manager) | [View](./setup/Synology%20DSM/docker.md) |
| Linux Installer | [View](./setup/Linux/LinuxInstall4j.md) |
| Linux maunal Install | [View](./setup/Linux/Manual.md) |
| Package Manager (Deb) | [View](./setup/Linux/Deb.md) |

| Platform | Link |
| ------------------------------- | ------------------------------------- |
| Windows Installer | [View](./setup/Windows/Installer.md) |
| Windows Portable | [View](./setup/Windows/Portable.md) |
| Docker | [View](./setup/Docker.md) |
| Synology DSM(Package) | [View](./setup/Synology%20DSM/Imnks.md) |
| Synology DSM(Container Manager) | [View](./setup/Synology%20DSM/docker.md) |
| Linux Installer | [View](./setup/Linux/LinuxInstall4j.md) |
| Linux Manual Install | [View](./setup/Linux/Manual.md) |
| Package Manager (Deb) | [View](./setup/Linux/Deb.md) |

## Need Support?

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,12 @@
sidebar_position: 3
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.
It does not meet the [FSH](https://en.wikipedia.org/wiki/Filesystem_Hierarchy_Standard) standard, [Docker](../Docker.md) is recommended for Linux users.
:::

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.
For Redhat-based users, please go to [Releases](https://github.com/PBH-BTN/PeerBanHelper/releases) to download a `.rpm` package, for other users please download the `.sh` file.

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.
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
---
sidebar_position: 2
---
# Manual Install


# Maunal Install
:::tip
[Docker](../Docker.md) is more recmmended.
[Docker](../Docker.md) is more recommended.
:::

## Install OpenJDK
Expand All @@ -32,16 +31,19 @@ OpenJDK 64-Bit Server VM (build xxxxxxx, mixed mode, sharing)
```

## Download Jar

Download the `jar` and `libraries.tar.gz` from [Release](https://github.com/PBH-BTN/PeerBanHelper/releases/latest).

Unzip them into a same directory.

Using following command to launch PBH:
Using the following command to launch PBH:

```shell
java -jar -Xmx512M -XX:+UseG1GC -XX:+UseStringDeduplication -XX:+ShrinkHeapInSteps -jar <jar file>
java -Xmx512M -XX:+UseG1GC -XX:+UseStringDeduplication -XX:+ShrinkHeapInSteps -jar <jar file>
```

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 file> nogui
java -Xmx512M -XX:+UseG1GC -XX:+UseStringDeduplication -XX:+ShrinkHeapInSteps -jar <jar file> nogui
```
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
sidebar_position: 2
---
# Manual Install

# Maunal Install
## Install Java

Install JDK by homebrew:

```shell
Expand All @@ -24,17 +25,21 @@ Java(TM) SE Runtime Environment (build 23.0.1+11-39)
Java HotSpot(TM) 64-Bit Server VM (build 23.0.1+11-39, mixed mode, sharing)
```

## 运行
## Running

Download the `jar` and `libraries.tar.gz` from [Release](https://github.com/PBH-BTN/PeerBanHelper/releases/latest)
Unzip them into a same directory.

Run:

```shell
java -Djava.awt.headless=true -Xmx512M -Xss512k -XX:+UseG1GC -XX:+UseStringDeduplication -XX:+ShrinkHeapInSteps -jar PeerBanHelper.jar nogui
```

## Services

touch file `~/Library/LaunchAgents/peerbanhelper.plist` with content:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
Expand Down

0 comments on commit 0794bde

Please sign in to comment.