timamsk/sing-box
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update documentation

Browse Source
This commit is contained in:
世界
2023-12-03 14:53:22 +08:00
parent deba59c140
commit 0f965cf1f4
50 changed files with 768 additions and 388 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/configuration/outbound/hysteria.md
View File

@@ -24,10 +24,6 @@
}
```
!!! warning ""
QUIC, which is required by hysteria is not included by default, see [Installation](./#installation).
### Fields
#### server

4
docs/configuration/outbound/hysteria.zh.md
View File

@@ -24,10 +24,6 @@
}
```
!!! warning ""
默认安装不包含被 Hysteria 依赖的 QUIC，参阅 [安装](/zh/#_2)。
### 字段
#### server

4
docs/configuration/outbound/hysteria2.md
View File

@@ -22,10 +22,6 @@
}
```
!!! warning ""
QUIC, which is required by Hysteria2 is not included by default, see [Installation](./#installation).
!!! warning "Difference from official Hysteria2"
The official Hysteria2 supports an authentication method called **userpass**,

4
docs/configuration/outbound/hysteria2.zh.md
View File

@@ -22,10 +22,6 @@
}
```
!!! warning ""
默认安装不包含被 Hysteria2 依赖的 QUIC，参阅 [安装](/zh/#_2)。
!!! warning "与官方 Hysteria2 的区别"
官方程序支持一种名为 **userpass** 的验证方式，

5
docs/configuration/outbound/index.md
View File

@@ -15,8 +15,8 @@
### Fields
| Type | Format |
|----------------|---------------------------------|
| Type | Format |
|----------------|--------------------------------|
| `direct` | [Direct](./direct/) |
| `block` | [Block](./block/) |
| `socks` | [SOCKS](./socks/) |
@@ -26,7 +26,6 @@
| `trojan` | [Trojan](./trojan/) |
| `wireguard` | [Wireguard](./wireguard/) |
| `hysteria` | [Hysteria](./hysteria/) |
| `shadowsocksr` | [ShadowsocksR](./shadowsocksr/) |
| `vless` | [VLESS](./vless/) |
| `shadowtls` | [ShadowTLS](./shadowtls/) |
| `tuic` | [TUIC](./tuic/) |

5
docs/configuration/outbound/index.zh.md
View File

@@ -15,8 +15,8 @@
### 字段
| 类型 | 格式 |
|----------------|---------------------------------|
| 类型 | 格式 |
|----------------|--------------------------------|
| `direct` | [Direct](./direct/) |
| `block` | [Block](./block/) |
| `socks` | [SOCKS](./socks/) |
@@ -26,7 +26,6 @@
| `trojan` | [Trojan](./trojan/) |
| `wireguard` | [Wireguard](./wireguard/) |
| `hysteria` | [Hysteria](./hysteria/) |
| `shadowsocksr` | [ShadowsocksR](./shadowsocksr/) |
| `vless` | [VLESS](./vless/) |
| `shadowtls` | [ShadowTLS](./shadowtls/) |
| `tuic` | [TUIC](./tuic/) |

106
docs/configuration/outbound/shadowsocksr.md
View File

@@ -1,106 +0,0 @@
### Structure
```json
{
"type": "shadowsocksr",
"tag": "ssr-out",
"server": "127.0.0.1",
"server_port": 1080,
"method": "aes-128-cfb",
"password": "8JCsPssfgS8tiRwiMlhARg==",
"obfs": "plain",
"obfs_param": "",
"protocol": "origin",
"protocol_param": "",
"network": "udp",
... // Dial Fields
}
```
!!! warning ""
The ShadowsocksR protocol is obsolete and unmaintained. This outbound is provided for compatibility only.
!!! warning ""
ShadowsocksR is not included by default, see [Installation](./#installation).
### Fields
#### server
==Required==
The server address.
#### server_port
==Required==
The server port.
#### method
==Required==
Encryption methods:
* `aes-128-ctr`
* `aes-192-ctr`
* `aes-256-ctr`
* `aes-128-cfb`
* `aes-192-cfb`
* `aes-256-cfb`
* `rc4-md5`
* `chacha20-ietf`
* `xchacha20`
#### password
==Required==
The shadowsocks password.
#### obfs
The ShadowsocksR obfuscate.
* plain
* http_simple
* http_post
* random_head
* tls1.2_ticket_auth
#### obfs_param
The ShadowsocksR obfuscate parameter.
#### protocol
The ShadowsocksR protocol.
* origin
* verify_sha1
* auth_sha1_v4
* auth_aes128_md5
* auth_aes128_sha1
* auth_chain_a
* auth_chain_b
#### protocol_param
The ShadowsocksR protocol parameter.
#### network
Enabled network
One of `tcp` `udp`.
Both is enabled by default.
### Dial Fields
See [Dial Fields](/configuration/shared/dial/) for details.

106
docs/configuration/outbound/shadowsocksr.zh.md
View File

@@ -1,106 +0,0 @@
### 结构
```json
{
"type": "shadowsocksr",
"tag": "ssr-out",
"server": "127.0.0.1",
"server_port": 1080,
"method": "aes-128-cfb",
"password": "8JCsPssfgS8tiRwiMlhARg==",
"obfs": "plain",
"obfs_param": "",
"protocol": "origin",
"protocol_param": "",
"network": "udp",
... // 拨号字段
}
```
!!! warning ""
ShadowsocksR 协议已过时且无人维护。 提供此出站仅出于兼容性目的。
!!! warning ""
默认安装不包含被 ShadowsocksR，参阅 [安装](/zh/#_2)。
### 字段
#### server
==必填==
服务器地址。
#### server_port
==必填==
服务器端口。
#### method
==必填==
加密方法：
* `aes-128-ctr`
* `aes-192-ctr`
* `aes-256-ctr`
* `aes-128-cfb`
* `aes-192-cfb`
* `aes-256-cfb`
* `rc4-md5`
* `chacha20-ietf`
* `xchacha20`
#### password
==必填==
Shadowsocks 密码。
#### obfs
ShadowsocksR 混淆。
* plain
* http_simple
* http_post
* random_head
* tls1.2_ticket_auth
#### obfs_param
ShadowsocksR 混淆参数。
#### protocol
ShadowsocksR 协议。
* origin
* verify_sha1
* auth_sha1_v4
* auth_aes128_md5
* auth_aes128_sha1
* auth_chain_a
* auth_chain_b
#### protocol_param
ShadowsocksR 协议参数。
#### network
启用的网络协议
`tcp` 或 `udp`。
默认所有。
### 拨号字段
参阅 [拨号字段](/zh/configuration/shared/dial/)。

2
docs/configuration/outbound/tor.md
View File

@@ -18,7 +18,7 @@
!!! info ""
Embedded tor is not included by default, see [Installation](./#installation).
Embedded Tor is not included by default, see [Installation](/installation/build-from-source/#build-tags).
### Fields

2
docs/configuration/outbound/tor.zh.md
View File

@@ -18,7 +18,7 @@
!!! info ""
默认安装不包含嵌入式 Tor, 参阅 [安装](/zh/#_2)。
默认安装不包含嵌入式 Tor, 参阅 [安装](/zh/installation/build-from-source/#_5)。
### 字段

4
docs/configuration/outbound/tuic.md
View File

@@ -21,10 +21,6 @@
}
```
!!! warning ""
QUIC, which is required by TUIC is not included by default, see [Installation](./#installation).
### Fields
#### server

4
docs/configuration/outbound/tuic.zh.md
View File

@@ -21,10 +21,6 @@
}
```
!!! warning ""
默认安装不包含被 TUI 依赖的 QUIC，参阅 [安装](/zh/#_2)。
### 字段
#### server

8
docs/configuration/outbound/wireguard.md
View File

@@ -36,14 +36,6 @@
}
```
!!! warning ""
WireGuard is not included by default, see [Installation](./#installation).
!!! warning ""
gVisor, which is required by the unprivileged WireGuard is not included by default, see [Installation](./#installation).
### Fields
#### server

8
docs/configuration/outbound/wireguard.zh.md
View File

@@ -24,14 +24,6 @@
}
```
!!! warning ""
默认安装不包含 WireGuard, 参阅 [安装](/zh/#_2)。
!!! warning ""
默认安装不包含被非特权 WireGuard 需要的 gVisor, 参阅 [安装](/zh/#_2)。
### 字段
#### server