Austin/sing-box
1
0
Fork 0
mirror of https://github.com/SagerNet/sing-box.git synced 2024-11-16 02:32:22 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

documentation: Two updates

Browse Source 
* Copyedit documentation

Close #1378

* remove yum, go full on dnf

fixes #2049
This commit is contained in:
Mingye Wang 2024-08-20 22:23:24 +08:00 committed by 世界
parent 090494faf5
commit aae3fded32
No known key found for this signature in database
GPG Key ID: CD109927C34A63C4
5 changed files with 30 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/installation/package-manager.md
View File

@ -24,14 +24,7 @@ icon: material/package
sudo dnf config-manager --add-repo https://sing-box.app/sing-box.repo sudo dnf config-manager --add-repo https://sing-box.app/sing-box.repo
sudo dnf install sing-box # or sing-box-beta sudo dnf install sing-box # or sing-box-beta
``` ```
(This applies to any distribution that uses `dnf` as the package manager: Fedora, CentOS, even OpenSUSE with DNF installed.)
=== ":material-redhat: CentOS / YUM"
```bash
sudo yum install -y yum-utils
sudo yum-config-manager --add-repo https://sing-box.app/sing-box.repo
sudo yum install sing-box # or sing-box-beta
```
## :material-download-box: Manual Installation ## :material-download-box: Manual Installation
@ -46,6 +39,7 @@ icon: material/package
```bash ```bash
bash <(curl -fsSL https://sing-box.app/rpm-install.sh) bash <(curl -fsSL https://sing-box.app/rpm-install.sh)
``` ```
(This applies to any distribution that uses `rpm` and `systemd`. Because of how `rpm` defines dependencies, if it installs, it probably works.)
=== ":simple-archlinux: Archlinux / PKG" === ":simple-archlinux: Archlinux / PKG"

10
docs/installation/package-manager.zh.md
View File

@ -24,14 +24,7 @@ icon: material/package
sudo dnf config-manager --add-repo https://sing-box.app/sing-box.repo sudo dnf config-manager --add-repo https://sing-box.app/sing-box.repo
sudo dnf install sing-box # or sing-box-beta sudo dnf install sing-box # or sing-box-beta
``` ```
（这适用于任何使用 `dnf` 作为包管理器的发行版：Fedora、CentOS，甚至安装了 DNF 的 OpenSUSE。）
=== ":material-redhat: CentOS / YUM"
```bash
sudo yum install -y yum-utils
sudo yum-config-manager --add-repo https://sing-box.app/sing-box.repo
sudo yum install sing-box # or sing-box-beta
```
## :material-download-box: 手动安装 ## :material-download-box: 手动安装
@ -46,6 +39,7 @@ icon: material/package
```bash ```bash
bash <(curl -fsSL https://sing-box.app/rpm-install.sh) bash <(curl -fsSL https://sing-box.app/rpm-install.sh)
``` ```
（这适用于任何使用 `rpm` 和 `systemd` 的发行版。由于 `rpm` 定义依赖关系的方式，如果安装成功，就多半能用。）
=== ":simple-archlinux: Archlinux / PKG" === ":simple-archlinux: Archlinux / PKG"

15
docs/manual/proxy-protocol/hysteria2.md
View File

@ -4,16 +4,17 @@ icon: material/lightning-bolt
# Hysteria 2 # Hysteria 2
The most popular Chinese-made simple protocol based on QUIC, the selling point is Brutal, Hysteria 2 is a simple, Chinese-made protocol based on QUIC.
a congestion control algorithm that can resist packet loss by manually specifying the required rate by the user. The selling point is Brutal, a congestion control algorithm that
tries to achieve a user-defined bandwidth despite packet loss.
!!! warning !!! warning
Even though GFW rarely blocks UDP-based proxies, such protocols actually have far more characteristics than TCP based proxies. Even though GFW rarely blocks UDP-based proxies, such protocols actually have far more obvious characteristics than TCP based proxies.
| Specification | Binary Characteristics | Active Detect Hiddenness | | Specification | Resists passive detection | Resists active probes |
|---------------------------------------------------------------------------|------------------------|--------------------------| |---------------------------------------------------------------------------|---------------------------|-----------------------|
| [hysteria.network](https://v2.hysteria.network/docs/developers/Protocol/) | :material-alert: | :material-check: | | [hysteria.network](https://v2.hysteria.network/docs/developers/Protocol/) | :material-alert: | :material-check: |
## :material-text-box-check: Password Generator ## :material-text-box-check: Password Generator
@ -44,7 +45,7 @@ To use sing-box with the official program, you need to fill in that combination
Replace `up_mbps` and `down_mbps` values with the actual bandwidth of your server. Replace `up_mbps` and `down_mbps` values with the actual bandwidth of your server.
=== ":material-harddisk: With local certificate" === ":material-harddisk: With local certificate"
```json ```json
{ {
"inbounds": [ "inbounds": [

19
docs/manual/proxy-protocol/shadowsocks.md
View File

@ -4,15 +4,18 @@ icon: material/send
# Shadowsocks # Shadowsocks
As the most well-known Chinese-made proxy protocol, Shadowsocks is the most well-known Chinese-made proxy protocol.
Shadowsocks exists in multiple versions, It exists in multiple versions, but only AEAD 2022 ciphers
but only AEAD 2022 ciphers TCP with multiplexing is recommended. over TCP with multiplexing is recommended.
| Ciphers | Specification | Cryptographic Security | Binary Characteristics | Active Detect Hiddenness | | Ciphers | Specification | Cryptographically sound | Resists passive detection | Resists active probes |
|----------------|------------------------------------------------------------|------------------------|------------------------|--------------------------| |----------------|------------------------------------------------------------|-------------------------|---------------------------|-----------------------|
| Stream Ciphers | [shadowsocks.org](https://shadowsocks.org/doc/stream.html) | :material-alert: | :material-alert: | :material-alert: | | Stream Ciphers | [shadowsocks.org](https://shadowsocks.org/doc/stream.html) | :material-alert: | :material-alert: | :material-alert: |
| AEAD | [shadowsocks.org](https://shadowsocks.org/doc/aead.html) | :material-check: | :material-alert: | :material-alert: | | AEAD | [shadowsocks.org](https://shadowsocks.org/doc/aead.html) | :material-check: | :material-alert: | :material-alert: |
| AEAD 2022 | [shadowsocks.org](https://shadowsocks.org/doc/sip022.html) | :material-check: | :material-check: | :material-help: | | AEAD 2022 | [shadowsocks.org](https://shadowsocks.org/doc/sip022.html) | :material-check: | :material-check: | :material-help: |
(We strongly recommend using multiplexing to send UDP traffic over TCP, because
doing otherwise is vulnerable to passive detection.)
## :material-text-box-check: Password Generator ## :material-text-box-check: Password Generator

15
docs/manual/proxy-protocol/trojan.md
View File

@ -4,15 +4,15 @@ icon: material/horse
# Trojan # Trojan
As the most commonly used TLS proxy made in China, Trojan can be used in various combinations, Torjan is the most commonly used TLS proxy made in China. It can be used in various combinations,
but only the combination of uTLS and multiplexing is recommended. but only the combination of uTLS and multiplexing is recommended.
| Protocol and implementation combination | Specification | Binary Characteristics | Active Detect Hiddenness | | Protocol and implementation combination | Specification | Resists passive detection | Resists active probes |
|-----------------------------------------|----------------------------------------------------------------------|------------------------|--------------------------| |-----------------------------------------|----------------------------------------------------------------------|---------------------------|-----------------------|
| Origin / trojan-gfw | [trojan-gfw.github.io](https://trojan-gfw.github.io/trojan/protocol) | :material-check: | :material-check: | | Origin / trojan-gfw | [trojan-gfw.github.io](https://trojan-gfw.github.io/trojan/protocol) | :material-check: | :material-check: |
| Basic Go implementation | / | :material-alert: | :material-check: | | Basic Go implementation | / | :material-alert: | :material-check: |
| with privates transport by V2Ray | No formal definition | :material-alert: | :material-alert: | | with privates transport by V2Ray | No formal definition | :material-alert: | :material-alert: |
| with uTLS enabled | No formal definition | :material-help: | :material-check: | | with uTLS enabled | No formal definition | :material-help: | :material-check: |
## :material-text-box-check: Password Generator ## :material-text-box-check: Password Generator
@ -211,4 +211,3 @@ but only the combination of uTLS and multiplexing is recommended.
] ]
} }
``` ```