From 1db7f45370c1549c6caa51789bde0dffb7125f7e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E4=B8=96=E7=95=8C?= Date: Tue, 13 Sep 2022 11:24:33 +0800 Subject: [PATCH] Update documentation --- constant/version.go | 2 +- docs/changelog.md | 16 +++ docs/configuration/outbound/shadowsocks.md | 12 ++ docs/configuration/outbound/shadowsocks.zh.md | 12 ++ docs/configuration/outbound/shadowsocksr.md | 106 ++++++++++++++++++ .../configuration/outbound/shadowsocksr.zh.md | 106 ++++++++++++++++++ docs/configuration/outbound/vless.md | 70 ++++++++++++ docs/configuration/outbound/vless.zh.md | 70 ++++++++++++ docs/index.md | 1 + docs/index.zh.md | 1 + mkdocs.yml | 2 + 11 files changed, 397 insertions(+), 1 deletion(-) create mode 100644 docs/configuration/outbound/shadowsocksr.md create mode 100644 docs/configuration/outbound/shadowsocksr.zh.md create mode 100644 docs/configuration/outbound/vless.md create mode 100644 docs/configuration/outbound/vless.zh.md diff --git a/constant/version.go b/constant/version.go index 7b2c20ea..0c6211dc 100644 --- a/constant/version.go +++ b/constant/version.go @@ -1,6 +1,6 @@ package constant var ( - Version = "1.1-beta3" + Version = "1.1-beta4" Commit = "" ) diff --git a/docs/changelog.md b/docs/changelog.md index f8867d44..cf003b77 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -1,3 +1,19 @@ +#### 1.1-beta4 + +* Add internal simple-obfs and v2ray-plugin [Shadowsocks plugins](/configuration/outbound/shadowsocks#plugin) +* Add [ShadowsocksR outbound](/configuration/outbound/shadowsocksr) +* Add [VLESS outbound and XUDP](/configuration/outbound/vless) +* Skip wait for hysteria tcp handshake response +* Fix socks4 client +* Fix hysteria inbound +* Fix concurrent write + +#### 1.0.3 + +* Fix socks4 client +* Fix hysteria inbound +* Fix concurrent write + #### 1.1-beta3 * Fix using custom TLS client in http2 client diff --git a/docs/configuration/outbound/shadowsocks.md b/docs/configuration/outbound/shadowsocks.md index 48c0d878..6a0ae6ad 100644 --- a/docs/configuration/outbound/shadowsocks.md +++ b/docs/configuration/outbound/shadowsocks.md @@ -9,6 +9,8 @@ "server_port": 1080, "method": "2022-blake3-aes-128-gcm", "password": "8JCsPssfgS8tiRwiMlhARg==", + "plugin": "", + "plugin_opts": "", "network": "udp", "udp_over_tcp": false, "multiplex": {}, @@ -65,6 +67,16 @@ Legacy encryption methods: The shadowsocks password. +#### plugin + +Shadowsocks SIP003 plugin, implemented in internal. + +Only `obfs-local` and `v2ray-plugin` are supported. + +#### plugin_opts + +Shadowsocks SIP003 plugin options. + #### network Enabled network diff --git a/docs/configuration/outbound/shadowsocks.zh.md b/docs/configuration/outbound/shadowsocks.zh.md index 5b5611f6..32a2de5d 100644 --- a/docs/configuration/outbound/shadowsocks.zh.md +++ b/docs/configuration/outbound/shadowsocks.zh.md @@ -9,6 +9,8 @@ "server_port": 1080, "method": "2022-blake3-aes-128-gcm", "password": "8JCsPssfgS8tiRwiMlhARg==", + "plugin": "", + "plugin_opts": "", "network": "udp", "udp_over_tcp": false, "multiplex": {}, @@ -65,6 +67,16 @@ Shadowsocks 密码。 +#### plugin + +Shadowsocks SIP003 插件，由内部实现。 + +仅支持 `obfs-local` 和 `v2ray-plugin`。 + +#### plugin_opts + +Shadowsocks SIP003 插件参数。 + #### network 启用的网络协议 diff --git a/docs/configuration/outbound/shadowsocksr.md b/docs/configuration/outbound/shadowsocksr.md new file mode 100644 index 00000000..43c71b99 --- /dev/null +++ b/docs/configuration/outbound/shadowsocksr.md @@ -0,0 +1,106 @@ +### 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. diff --git a/docs/configuration/outbound/shadowsocksr.zh.md b/docs/configuration/outbound/shadowsocksr.zh.md new file mode 100644 index 00000000..ced3756a --- /dev/null +++ b/docs/configuration/outbound/shadowsocksr.zh.md @@ -0,0 +1,106 @@ +### 结构 + +```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/)。 diff --git a/docs/configuration/outbound/vless.md b/docs/configuration/outbound/vless.md new file mode 100644 index 00000000..0fd45474 --- /dev/null +++ b/docs/configuration/outbound/vless.md @@ -0,0 +1,70 @@ +### Structure + +```json +{ + "type": "vless", + "tag": "vless-out", + + "server": "127.0.0.1", + "server_port": 1080, + "uuid": "bf000d23-0752-40b4-affe-68f7707a9661", + "network": "tcp", + "tls": {}, + "packet_encoding": "", + "transport": {}, + + ... // Dial Fields +} +``` + +!!! warning "" + + The VLESS protocol is architecturally coupled to v2ray and is unmaintained. This outbound is provided for compatibility purposes only. + +### Fields + +#### server + +==Required== + +The server address. + +#### server_port + +==Required== + +The server port. + +#### uuid + +==Required== + +The VLESS user id. + +#### network + +Enabled network + +One of `tcp` `udp`. + +Both is enabled by default. + +#### tls + +TLS configuration, see [TLS](/configuration/shared/tls/#outbound). + +#### packet_encoding + +| Encoding | Description | +|------------|-----------------------| +| (none) | Disabled | +| packetaddr | Supported by v2ray 5+ | +| xudp | Supported by xray | + +#### transport + +V2Ray Transport configuration, see [V2Ray Transport](/configuration/shared/v2ray-transport). + +### Dial Fields + +See [Dial Fields](/configuration/shared/dial) for details. diff --git a/docs/configuration/outbound/vless.zh.md b/docs/configuration/outbound/vless.zh.md new file mode 100644 index 00000000..39949b4d --- /dev/null +++ b/docs/configuration/outbound/vless.zh.md @@ -0,0 +1,70 @@ +### 结构 + +```json +{ + "type": "vless", + "tag": "vless-out", + + "server": "127.0.0.1", + "server_port": 1080, + "uuid": "bf000d23-0752-40b4-affe-68f7707a9661", + "network": "tcp", + "tls": {}, + "packet_encoding": "", + "transport": {}, + + ... // 拨号字段 +} +``` + +!!! warning "" + + VLESS 协议与 v2ray 架构耦合且无人维护。 提供此出站仅出于兼容性目的。 + +### 字段 + +#### server + +==必填== + +服务器地址。 + +#### server_port + +==必填== + +服务器端口。 + +#### uuid + +==必填== + +VLESS 用户 ID。 + +#### network + +启用的网络协议。 + +`tcp` 或 `udp`。 + +默认所有。 + +#### tls + +TLS 配置, 参阅 [TLS](/zh/configuration/shared/tls/#outbound)。 + +#### packet_encoding + +| 编码 | 描述 | +|------------|---------------| +| (空) | 禁用 | +| packetaddr | 由 v2ray 5+ 支持 | +| xudp | 由 xray 支持 | + +#### transport + +V2Ray 传输配置，参阅 [V2Ray 传输层](/zh/configuration/shared/v2ray-transport)。 + +### 拨号字段 + +参阅 [拨号字段](/zh/configuration/shared/dial/)。 diff --git a/docs/index.md b/docs/index.md index 600b9b8d..4659212e 100644 --- a/docs/index.md +++ b/docs/index.md @@ -27,6 +27,7 @@ go install -v -tags with_clash_api github.com/sagernet/sing-box/cmd/sing-box@lat | `with_quic` | Build with QUIC support, see [QUIC and HTTP3 dns transports](./configuration/dns/server), [Naive inbound](./configuration/inbound/naive), [Hysteria Inbound](./configuration/inbound/hysteria), [Hysteria Outbound](./configuration/outbound/hysteria) and [V2Ray Transport#QUIC](./configuration/shared/v2ray-transport#quic). | | `with_grpc` | Build with standard gRPC support, see [V2Ray Transport#gRPC](./configuration/shared/v2ray-transport#grpc). | | `with_wireguard` | Build with WireGuard support, see [WireGuard outbound](./configuration/outbound/wireguard). | +| `with_shadowsocksr` | Build with ShadowsocksR support, see [ShadowsocksR outbound](./configuration/outbound/shadowsocksr). | | `with_ech` | Build with TLS ECH extension support for TLS outbound, see [TLS](./configuration/shared/tls#ech). | | `with_utls` | Build with [uTLS](https://github.com/refraction-networking/utls) support for TLS outbound, see [TLS](./configuration/shared/tls#utls). | | `with_acme` | Build with ACME TLS certificate issuer support, see [TLS](./configuration/shared/tls). | diff --git a/docs/index.zh.md b/docs/index.zh.md index 9dd1ab6e..6e9b6f98 100644 --- a/docs/index.zh.md +++ b/docs/index.zh.md @@ -27,6 +27,7 @@ go install -v -tags with_clash_api github.com/sagernet/sing-box/cmd/sing-box@lat | `with_quic` | 启用 QUIC 支持，参阅 [QUIC 和 HTTP3 DNS 传输层](./configuration/dns/server)，[Naive 入站](./configuration/inbound/naive)，[Hysteria 入站](./configuration/inbound/hysteria)，[Hysteria 出站](./configuration/outbound/hysteria) 和 [V2Ray 传输层#QUIC](./configuration/shared/v2ray-transport#quic)。 | | `with_grpc` | 启用标准 gRPC 支持，参阅 [V2Ray 传输层#gRPC](./configuration/shared/v2ray-transport#grpc)。 | | `with_wireguard` | 启用 WireGuard 支持，参阅 [WireGuard 出站](./configuration/outbound/wireguard)。 | +| `with_shadowsocksr` | 启用 ShadowsocksR 支持，参阅 [ShadowsocksR 出站](./configuration/outbound/shadowsocksr)。 | | `with_ech` | 启用 TLS ECH 扩展支持，参阅 [TLS](./configuration/shared/tls#ech)。 | | `with_utls` | 启用 [uTLS](https://github.com/refraction-networking/utls) 支持， 参阅 [TLS](./configuration/shared/tls#utls)。 | | `with_acme` | 启用 ACME TLS 证书签发支持，参阅 [TLS](./configuration/shared/tls)。 | diff --git a/mkdocs.yml b/mkdocs.yml index 795e49b0..7c6c0583 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -84,6 +84,8 @@ nav: - WireGuard: configuration/outbound/wireguard.md - Hysteria: configuration/outbound/hysteria.md - ShadowTLS: configuration/outbound/shadowtls.md + - ShadowsocksR: configuration/outbound/shadowsocksr.md + - VLESS: configuration/outbound/vless.md - Tor: configuration/outbound/tor.md - SSH: configuration/outbound/ssh.md - DNS: configuration/outbound/dns.md