diff --git a/docs/.vuepress/config/sidebar.ts b/docs/.vuepress/config/sidebar.ts index 31423af..1b465cd 100644 --- a/docs/.vuepress/config/sidebar.ts +++ b/docs/.vuepress/config/sidebar.ts @@ -39,7 +39,6 @@ export function getConfigSidebar( { text: inbound, children: [ - path + "inbounds/", path + "inbounds/dokodemo.md", path + "inbounds/http.md", path + "inbounds/shadowsocks.md", @@ -52,7 +51,6 @@ export function getConfigSidebar( { text: outbound, children: [ - path + "outbounds/", path + "outbounds/blackhole.md", path + "outbounds/dns.md", path + "outbounds/freedom.md", @@ -67,7 +65,6 @@ export function getConfigSidebar( { text: transport, children: [ - path + "transports/", path + "transports/grpc.md", path + "transports/h2.md", path + "transports/mkcp.md", diff --git a/docs/config/api.md b/docs/config/api.md index 43f0ae2..2c57b6e 100644 --- a/docs/config/api.md +++ b/docs/config/api.md @@ -85,3 +85,7 @@ API 接口配置提供了一些基于 [gRPC](https://grpc.io/)的 API 接口供 ### StatsService 内置的数据统计服务，详见 [统计信息](./stats.md)。 + +## API 调用示例 + +[Xray-API-documents](https://github.com/XTLS/Xray-API-documents) @crossfw diff --git a/docs/config/features/env.md b/docs/config/features/env.md index b83cec3..f882395 100644 --- a/docs/config/features/env.md +++ b/docs/config/features/env.md @@ -4,6 +4,8 @@ Xray 提供以下环境变量以供修改 Xray 的一些底层配置。 ## XTLS 信息显示 + + ### VLESS - 名称：`xray.vless.xtls.show` 或 `XRAY_VLESS_XTLS_SHOW`。 diff --git a/docs/config/inbounds/README.md b/docs/config/inbounds/README.md deleted file mode 100644 index 9485c7e..0000000 --- a/docs/config/inbounds/README.md +++ /dev/null @@ -1,33 +0,0 @@ -# 入站协议 - -> 这个章节包含了目前所有可用于 Inbounds 的协议及具体配置细节. - -## 协议列表 - -> [Dokodemo-door](./dokodemo.md) - -Dokodemo door（任意门）可以监听一个本地端口，并把所有进入此端口的数据发送至指定服务器的一个端口，从而达到端口映射的效果。 - -> [HTTP](./http.md) - -HTTP 协议 - -> [Socks](./socks.md) - -标准 Socks 协议实现，兼容 [Socks 4](http://ftp.icm.edu.pl/packages/socks/socks4/SOCKS4.protocol)、Socks 4a 和 [Socks 5](http://ftp.icm.edu.pl/packages/socks/socks4/SOCKS4.protocol)。 - -> [VLESS](./vless.md) - -VLESS 是一个无状态的轻量传输协议，可以作为 Xray 客户端和服务器之间的桥梁。 - -> [VMess](./vmess.md) - -[VMess](../development/protocols/vmess.md) 是一个加密传输协议，，可以作为 Xray 客户端和服务器之间的桥梁。 - -> [Trojan](./trojan.md) - -[Trojan](https://trojan-gfw.github.io/trojan/protocol) 协议 - -> [Shadowsocks](./shadowsocks.md) - -[Shadowsocks](https://zh.wikipedia.org/wiki/Shadowsocks) 协议。 diff --git a/docs/config/inbounds/trojan.md b/docs/config/inbounds/trojan.md index f083781..9cbc24e 100644 --- a/docs/config/inbounds/trojan.md +++ b/docs/config/inbounds/trojan.md @@ -77,11 +77,7 @@ userLevel 的值, 对应 [policy](../policy.md#policyobject) 中 `level` 的值 目前入站协议中有以下流控模式可选： -- `xtls-rprx-origin`：最初的流控模式，此时客户端仅可选择 `xtls-rprx-origin` 和 `xtls-rprx-origin-udp443` 这两种流控模式。该模式纪念价值大于实际使用价值。 -- `xtls-rprx-direct`：**推荐**，所有平台皆可使用的典型流控方式，此时客户端可选择任何流控模式 - -::: warning 注意 -当 `flow` 被指定时，还需要将该入站协议的 `streamSettings.security` 一项指定为 `xtls`，`tlsSettings` 改为 `xtlsSettings`。详情请参考 [streamSettings](../transport.md#streamsettingsobject)。 -::: +- `xtls-rprx-origin`：最初的流控模式，此时客户端仅可选择 `xtls-rprx-origin` 和 `xtls-rprx-origin-udp443` 这两种流控模式。该模式纪念价值大于实际使用价值。 +- `xtls-rprx-direct`：**推荐**，所有平台皆可使用的典型流控方式，此时客户端可选择任何流控模式 此外，目前 XTLS 仅支持 TCP、mKCP、DomainSocket 这三种传输方式。 diff --git a/docs/config/inbounds/vless.md b/docs/config/inbounds/vless.md index 48b0920..1998456 100644 --- a/docs/config/inbounds/vless.md +++ b/docs/config/inbounds/vless.md @@ -90,11 +90,7 @@ level 的值, 对应 [policy](../policy.md#policyobject) 中 `level` 的值。 目前入站协议中有以下流控模式可选： -- `xtls-rprx-origin`：最初的流控模式，此时客户端仅可选择 `xtls-rprx-origin` 和 `xtls-rprx-origin-udp443` 这两种流控模式。该模式纪念价值大于实际使用价值。 -- `xtls-rprx-direct`：**推荐**，所有平台皆可使用的典型流控方式，此时客户端可选择任何流控模式 - -::: warning 注意 -当 `flow` 被指定时，还需要将该入站协议的 `streamSettings.security` 一项指定为 `xtls`，`tlsSettings` 改为 `xtlsSettings`。详情请参考 [streamSettings](../transport.md#streamsettingsobject)。 -::: +- `xtls-rprx-origin`：最初的流控模式，此时客户端仅可选择 `xtls-rprx-origin` 和 `xtls-rprx-origin-udp443` 这两种流控模式。该模式纪念价值大于实际使用价值。 +- `xtls-rprx-direct`：**推荐**，所有平台皆可使用的典型流控方式，此时客户端可选择任何流控模式 此外，目前 XTLS 仅支持 TCP、mKCP、DomainSocket 这三种传输方式。 diff --git a/docs/config/outbounds/README.md b/docs/config/outbounds/README.md deleted file mode 100644 index 2289e85..0000000 --- a/docs/config/outbounds/README.md +++ /dev/null @@ -1,41 +0,0 @@ -# 出站协议 - -> **这个章节包含了目前所有可用于 Outbounds 的协议及具体配置细节.** - -## 协议列表 - -> [Blackhole](./blackhole.md) - -Blackhole（黑洞）是一个出站数据协议，它会阻碍所有数据的出站，配合 [路由（Routing）](../routing.md) 一起使用，可以达到禁止访问某些网站的效果。 - -> [DNS](./dns.md) - -DNS 是一个出站协议，主要用于拦截和转发 DNS 查询。此出站协议只能接收 DNS 流量（包含基于 UDP 和 TCP 协议的查询），其它类型的流量会导致错误。 - -> [Freedom](./freedom.md) - -Freedom 是一个出站协议，可以用来向任意网络发送（正常的） TCP 或 UDP 数据。 - -> [HTTP](./http.md) - -HTTP 协议 - -> [Socks](./socks.md) - -标准 Socks 协议实现，兼容 [Socks 4](http://ftp.icm.edu.pl/packages/socks/socks4/SOCKS4.protocol)、Socks 4a 和 [Socks 5](http://ftp.icm.edu.pl/packages/socks/socks4/SOCKS4.protocol)。 - -> [VLESS](./vless.md) - -VLESS 是一个无状态的轻量传输协议，可以作为 Xray 客户端和服务器之间的桥梁。 - -> [VMess](./vmess.md) - -[VMess](../development/protocols/vmess.md) 是一个加密传输协议，可以作为 Xray 客户端和服务器之间的桥梁。 - -> [Trojan](./trojan.md) - -[Trojan](https://trojan-gfw.github.io/trojan/protocol) 协议。 - -> [Shadowsocks](./shadowsocks.md) - -[Shadowsocks](https://zh.wikipedia.org/wiki/Shadowsocks) 协议。 diff --git a/docs/config/outbounds/trojan.md b/docs/config/outbounds/trojan.md index 0e89752..1ff0ea4 100644 --- a/docs/config/outbounds/trojan.md +++ b/docs/config/outbounds/trojan.md @@ -62,16 +62,12 @@ Trojan 被设计工作在正确配置的加密 TLS 隧道 目前出站协议中有以下流控模式可选： -- `xtls-rprx-origin`：最初的流控模式。该模式纪念价值大于实际使用价值 -- `xtls-rprx-origin-udp443`：同 `xtls-rprx-origin`, 但放行了目标为 443 端口的 UDP 流量 -- `xtls-rprx-direct`：所有平台皆可使用的典型流控模式 -- `xtls-rprx-direct-udp443`：同 `xtls-rprx-direct`, 但是放行了目标为 443 端口的 UDP 流量 -- `xtls-rprx-splice`：Linux 平台下最建议使用的流控模式 -- `xtls-rprx-splice-udp443`：同 `xtls-rprx-splice`, 但是放行了目标为 443 端口的 UDP 流量 - -::: warning 注意 -当 `flow` 被指定时，还需要将该出站协议的 `streamSettings.security` 一项指定为 `xtls`，`tlsSettings` 改为 `xtlsSettings`。详情请参考 [streamSettings](../transport.md#streamsettingsobject)。 -::: +- `xtls-rprx-origin`：最初的流控模式。该模式纪念价值大于实际使用价值 +- `xtls-rprx-origin-udp443`：同 `xtls-rprx-origin`, 但放行了目标为 443 端口的 UDP 流量 +- `xtls-rprx-direct`：所有平台皆可使用的典型流控模式 +- `xtls-rprx-direct-udp443`：同 `xtls-rprx-direct`, 但是放行了目标为 443 端口的 UDP 流量 +- `xtls-rprx-splice`：Linux 平台下最建议使用的流控模式 +- `xtls-rprx-splice-udp443`：同 `xtls-rprx-splice`, 但是放行了目标为 443 端口的 UDP 流量 此外，目前 XTLS 仅支持 TCP、mKCP、DomainSocket 这三种传输方式。 diff --git a/docs/config/outbounds/vless.md b/docs/config/outbounds/vless.md index f5b0d84..9d603cd 100644 --- a/docs/config/outbounds/vless.md +++ b/docs/config/outbounds/vless.md @@ -100,15 +100,12 @@ VLESS 的用户 ID，可以是任意小于 30 字节的字符串, 也可以是 目前出站协议中有以下流控模式可选： -- `xtls-rprx-origin`：最初的流控模式。该模式纪念价值大于实际使用价值 -- `xtls-rprx-origin-udp443`：同 `xtls-rprx-origin`, 但放行了目标为 443 端口的 UDP 流量 -- `xtls-rprx-direct`：所有平台皆可使用的典型流控模式 -- `xtls-rprx-direct-udp443`：同 `xtls-rprx-direct`, 但是放行了目标为 443 端口的 UDP 流量 -- `xtls-rprx-splice`：Linux 平台下最建议使用的流控模式 -- `xtls-rprx-splice-udp443`：同 `xtls-rprx-splice`, 但是放行了目标为 443 端口的 UDP 流量 - -::: warning 注意 -当 `flow` 被指定时，还需要将该出站协议的 `streamSettings.security` 一项指定为 `xtls`，`tlsSettings` 改为 `xtlsSettings`。详情请参考 [streamSettings](../transport.md#streamsettingsobject)。 +- `xtls-rprx-origin`：最初的流控模式。该模式纪念价值大于实际使用价值 +- `xtls-rprx-origin-udp443`：同 `xtls-rprx-origin`, 但放行了目标为 443 端口的 UDP 流量 +- `xtls-rprx-direct`：所有平台皆可使用的典型流控模式 +- `xtls-rprx-direct-udp443`：同 `xtls-rprx-direct`, 但是放行了目标为 443 端口的 UDP 流量 +- `xtls-rprx-splice`：Linux 平台下最建议使用的流控模式 +- `xtls-rprx-splice-udp443`：同 `xtls-rprx-splice`, 但是放行了目标为 443 端口的 UDP 流量 此外，目前 XTLS 仅支持 TCP、mKCP、DomainSocket 这三种传输方式。 ::: diff --git a/docs/config/transport.md b/docs/config/transport.md index dc5639d..7fe52f2 100644 --- a/docs/config/transport.md +++ b/docs/config/transport.md @@ -67,7 +67,6 @@ "network": "tcp", "security": "none", "tlsSettings": {}, - "xtlsSettings": {}, "tcpSettings": {}, "kcpSettings": {}, "wsSettings": {}, @@ -97,7 +96,7 @@ - `"none"` 表示不加密（默认值） - `"tls"` 表示使用 [TLS](https://en.wikipedia.org/wiki/base/transport_Layer_Security)。 -- `"xtls"` 表示使用 [XTLS](./features/xtls.md)。 +- `"xtls"` 表示使用 [XTLS](./features/xtls.md)。 > `tlsSettings`: [TLSObject](#tlsobject) @@ -105,8 +104,9 @@ TLS 配置。TLS 由 Golang 提供，通常情况下 TLS 协商的结果为使 > `xtlsSettings`: [XTLSObject](#tlsobject) + + XTLS 配置。XTLS 是 Xray 的原创黑科技, 也是使 Xray 性能一骑绝尘的核心动力。 XTLS 与 TLS 有相同的安全性, 配置方式也和 TLS 一致. -点击此处查看 [XTLS 的技术细节剖析](./features/xtls.md) ::: tip TLS / XTLS 是目前最安全的传输加密方案, 且外部看来流量类型和正常上网具有一致性。 启用 XTLS 并且配置合适的 XTLS 流控模式, 可以在保持和 TLS 相同的安全性的前提下, diff --git a/docs/config/transports/README.md b/docs/config/transports/README.md deleted file mode 100644 index 5632656..0000000 --- a/docs/config/transports/README.md +++ /dev/null @@ -1,33 +0,0 @@ -# 传输方式 - -这个章节包含了目前所有的传输方式及相关的具体配置. - -## 传输方式列表 - -> `tcpSettings`: [TcpObject](./tcp.md) - -针对 TCP 连接的配置。 - -> `wsSettings`: [WebSocketObject](./websocket.md) - -针对 WebSocket 连接的配置。 - -> `dsSettings`: [DomainSocketObject](./domainsocket.md) - -针对 Domain Socket 连接的配置。 - -> `kcpSettings`: [KcpObject](./mkcp.md) - -针对 mKCP 连接的配置。 - -> `httpSettings`: [HttpObject](./h2.md) - -针对 HTTP/2 连接的配置。 - -> `quicSettings`: [QuicObject](./quic.md) - -针对 QUIC 连接的配置。 - -> `grpcSettings`: [GRPCObject](./grpc.md) - -针对 gRPC 连接的配置。 diff --git a/docs/en/config/api.md b/docs/en/config/api.md index 9692e21..add4040 100644 --- a/docs/en/config/api.md +++ b/docs/en/config/api.md @@ -88,3 +88,7 @@ API 接口配置提供了一些基于 [gRPC](https://grpc.io/)的 API 接口供 ### StatsService 内置的数据统计服务，详见 [统计信息](./stats.md)。 + +## API 调用示例 + +[Xray-API-documents](https://github.com/XTLS/Xray-API-documents) @crossfw diff --git a/docs/en/config/features/env.md b/docs/en/config/features/env.md index 5958352..2ad6736 100644 --- a/docs/en/config/features/env.md +++ b/docs/en/config/features/env.md @@ -4,6 +4,8 @@ Xray 提供以下环境变量以供修改 Xray 的一些底层配置。 ## XTLS 信息显示 + + ### VLESS - 名称：`xray.vless.xtls.show` 或 `XRAY_VLESS_XTLS_SHOW`。 diff --git a/docs/en/config/inbounds/README.md b/docs/en/config/inbounds/README.md deleted file mode 100644 index e6f1e82..0000000 --- a/docs/en/config/inbounds/README.md +++ /dev/null @@ -1,33 +0,0 @@ -# Inbounds Protocols - -> 这个章节包含了目前所有可用于 Inbounds 的协议及具体配置细节. - -## 协议列表 - -> [Dokodemo-door](./dokodemo.md) - -Dokodemo door（任意门）可以监听一个本地端口，并把所有进入此端口的数据发送至指定服务器的一个端口，从而达到端口映射的效果。 - -> [HTTP](./http.md) - -HTTP 协议 - -> [Socks](./socks.md) - -标准 Socks 协议实现，兼容 [Socks 4](http://ftp.icm.edu.pl/packages/socks/socks4/SOCKS4.protocol)、Socks 4a 和 [Socks 5](http://ftp.icm.edu.pl/packages/socks/socks4/SOCKS4.protocol)。 - -> [VLESS](./vless.md) - -VLESS 是一个无状态的轻量传输协议，可以作为 Xray 客户端和服务器之间的桥梁。 - -> [VMess](./vmess.md) - -[VMess](../development/protocols/vmess.md) 是一个加密传输协议，，可以作为 Xray 客户端和服务器之间的桥梁。 - -> [Trojan](./trojan.md) - -[Trojan](https://trojan-gfw.github.io/trojan/protocol) 协议 - -> [Shadowsocks](./shadowsocks.md) - -[Shadowsocks](https://zh.wikipedia.org/wiki/Shadowsocks) 协议。 diff --git a/docs/en/config/inbounds/trojan.md b/docs/en/config/inbounds/trojan.md index 267fcb2..767cf7e 100644 --- a/docs/en/config/inbounds/trojan.md +++ b/docs/en/config/inbounds/trojan.md @@ -77,11 +77,7 @@ userLevel 的值, 对应 [policy](../policy.md#policyobject) 中 `level` 的值 目前入站协议中有以下流控模式可选： -- `xtls-rprx-origin`：最初的流控模式，此时客户端仅可选择 `xtls-rprx-origin` 和 `xtls-rprx-origin-udp443` 这两种流控模式。该模式纪念价值大于实际使用价值。 -- `xtls-rprx-direct`：**推荐**，所有平台皆可使用的典型流控方式，此时客户端可选择任何流控模式 - -::: warning 注意 -当 `flow` 被指定时，还需要将该入站协议的 `streamSettings.security` 一项指定为 `xtls`，`tlsSettings` 改为 `xtlsSettings`。详情请参考 [streamSettings](../transport.md#streamsettingsobject)。 -::: +- `xtls-rprx-origin`：最初的流控模式，此时客户端仅可选择 `xtls-rprx-origin` 和 `xtls-rprx-origin-udp443` 这两种流控模式。该模式纪念价值大于实际使用价值。 +- `xtls-rprx-direct`：**推荐**，所有平台皆可使用的典型流控方式，此时客户端可选择任何流控模式 此外，目前 XTLS 仅支持 TCP、mKCP、DomainSocket 这三种传输方式。 diff --git a/docs/en/config/inbounds/vless.md b/docs/en/config/inbounds/vless.md index 48b0920..1998456 100644 --- a/docs/en/config/inbounds/vless.md +++ b/docs/en/config/inbounds/vless.md @@ -90,11 +90,7 @@ level 的值, 对应 [policy](../policy.md#policyobject) 中 `level` 的值。 目前入站协议中有以下流控模式可选： -- `xtls-rprx-origin`：最初的流控模式，此时客户端仅可选择 `xtls-rprx-origin` 和 `xtls-rprx-origin-udp443` 这两种流控模式。该模式纪念价值大于实际使用价值。 -- `xtls-rprx-direct`：**推荐**，所有平台皆可使用的典型流控方式，此时客户端可选择任何流控模式 - -::: warning 注意 -当 `flow` 被指定时，还需要将该入站协议的 `streamSettings.security` 一项指定为 `xtls`，`tlsSettings` 改为 `xtlsSettings`。详情请参考 [streamSettings](../transport.md#streamsettingsobject)。 -::: +- `xtls-rprx-origin`：最初的流控模式，此时客户端仅可选择 `xtls-rprx-origin` 和 `xtls-rprx-origin-udp443` 这两种流控模式。该模式纪念价值大于实际使用价值。 +- `xtls-rprx-direct`：**推荐**，所有平台皆可使用的典型流控方式，此时客户端可选择任何流控模式 此外，目前 XTLS 仅支持 TCP、mKCP、DomainSocket 这三种传输方式。 diff --git a/docs/en/config/outbounds/README.md b/docs/en/config/outbounds/README.md deleted file mode 100644 index d2dff91..0000000 --- a/docs/en/config/outbounds/README.md +++ /dev/null @@ -1,41 +0,0 @@ -# Outbound Protocols - -> **这个章节包含了目前所有可用于 Outbounds 的协议及具体配置细节.** - -## 协议列表 - -> [Blackhole](./blackhole.md) - -Blackhole（黑洞）是一个出站数据协议，它会阻碍所有数据的出站，配合 [路由（Routing）](../routing.md) 一起使用，可以达到禁止访问某些网站的效果。 - -> [DNS](./dns.md) - -DNS 是一个出站协议，主要用于拦截和转发 DNS 查询。此出站协议只能接收 DNS 流量（包含基于 UDP 和 TCP 协议的查询），其它类型的流量会导致错误。 - -> [Freedom](./freedom.md) - -Freedom 是一个出站协议，可以用来向任意网络发送（正常的） TCP 或 UDP 数据。 - -> [HTTP](./http.md) - -HTTP 协议 - -> [Socks](./socks.md) - -标准 Socks 协议实现，兼容 [Socks 4](http://ftp.icm.edu.pl/packages/socks/socks4/SOCKS4.protocol)、Socks 4a 和 [Socks 5](http://ftp.icm.edu.pl/packages/socks/socks4/SOCKS4.protocol)。 - -> [VLESS](./vless.md) - -VLESS 是一个无状态的轻量传输协议，可以作为 Xray 客户端和服务器之间的桥梁。 - -> [VMess](./vmess.md) - -[VMess](../development/protocols/vmess.md) 是一个加密传输协议，可以作为 Xray 客户端和服务器之间的桥梁。 - -> [Trojan](./trojan.md) - -[Trojan](https://trojan-gfw.github.io/trojan/protocol) 协议。 - -> [Shadowsocks](./shadowsocks.md) - -[Shadowsocks](https://zh.wikipedia.org/wiki/Shadowsocks) 协议。 diff --git a/docs/en/config/outbounds/trojan.md b/docs/en/config/outbounds/trojan.md index 0e89752..1ff0ea4 100644 --- a/docs/en/config/outbounds/trojan.md +++ b/docs/en/config/outbounds/trojan.md @@ -62,16 +62,12 @@ Trojan 被设计工作在正确配置的加密 TLS 隧道 目前出站协议中有以下流控模式可选： -- `xtls-rprx-origin`：最初的流控模式。该模式纪念价值大于实际使用价值 -- `xtls-rprx-origin-udp443`：同 `xtls-rprx-origin`, 但放行了目标为 443 端口的 UDP 流量 -- `xtls-rprx-direct`：所有平台皆可使用的典型流控模式 -- `xtls-rprx-direct-udp443`：同 `xtls-rprx-direct`, 但是放行了目标为 443 端口的 UDP 流量 -- `xtls-rprx-splice`：Linux 平台下最建议使用的流控模式 -- `xtls-rprx-splice-udp443`：同 `xtls-rprx-splice`, 但是放行了目标为 443 端口的 UDP 流量 - -::: warning 注意 -当 `flow` 被指定时，还需要将该出站协议的 `streamSettings.security` 一项指定为 `xtls`，`tlsSettings` 改为 `xtlsSettings`。详情请参考 [streamSettings](../transport.md#streamsettingsobject)。 -::: +- `xtls-rprx-origin`：最初的流控模式。该模式纪念价值大于实际使用价值 +- `xtls-rprx-origin-udp443`：同 `xtls-rprx-origin`, 但放行了目标为 443 端口的 UDP 流量 +- `xtls-rprx-direct`：所有平台皆可使用的典型流控模式 +- `xtls-rprx-direct-udp443`：同 `xtls-rprx-direct`, 但是放行了目标为 443 端口的 UDP 流量 +- `xtls-rprx-splice`：Linux 平台下最建议使用的流控模式 +- `xtls-rprx-splice-udp443`：同 `xtls-rprx-splice`, 但是放行了目标为 443 端口的 UDP 流量 此外，目前 XTLS 仅支持 TCP、mKCP、DomainSocket 这三种传输方式。 diff --git a/docs/en/config/outbounds/vless.md b/docs/en/config/outbounds/vless.md index f5b0d84..9d603cd 100644 --- a/docs/en/config/outbounds/vless.md +++ b/docs/en/config/outbounds/vless.md @@ -100,15 +100,12 @@ VLESS 的用户 ID，可以是任意小于 30 字节的字符串, 也可以是 目前出站协议中有以下流控模式可选： -- `xtls-rprx-origin`：最初的流控模式。该模式纪念价值大于实际使用价值 -- `xtls-rprx-origin-udp443`：同 `xtls-rprx-origin`, 但放行了目标为 443 端口的 UDP 流量 -- `xtls-rprx-direct`：所有平台皆可使用的典型流控模式 -- `xtls-rprx-direct-udp443`：同 `xtls-rprx-direct`, 但是放行了目标为 443 端口的 UDP 流量 -- `xtls-rprx-splice`：Linux 平台下最建议使用的流控模式 -- `xtls-rprx-splice-udp443`：同 `xtls-rprx-splice`, 但是放行了目标为 443 端口的 UDP 流量 - -::: warning 注意 -当 `flow` 被指定时，还需要将该出站协议的 `streamSettings.security` 一项指定为 `xtls`，`tlsSettings` 改为 `xtlsSettings`。详情请参考 [streamSettings](../transport.md#streamsettingsobject)。 +- `xtls-rprx-origin`：最初的流控模式。该模式纪念价值大于实际使用价值 +- `xtls-rprx-origin-udp443`：同 `xtls-rprx-origin`, 但放行了目标为 443 端口的 UDP 流量 +- `xtls-rprx-direct`：所有平台皆可使用的典型流控模式 +- `xtls-rprx-direct-udp443`：同 `xtls-rprx-direct`, 但是放行了目标为 443 端口的 UDP 流量 +- `xtls-rprx-splice`：Linux 平台下最建议使用的流控模式 +- `xtls-rprx-splice-udp443`：同 `xtls-rprx-splice`, 但是放行了目标为 443 端口的 UDP 流量 此外，目前 XTLS 仅支持 TCP、mKCP、DomainSocket 这三种传输方式。 ::: diff --git a/docs/en/config/transport.md b/docs/en/config/transport.md index 5a5439f..936ced0 100644 --- a/docs/en/config/transport.md +++ b/docs/en/config/transport.md @@ -67,7 +67,6 @@ "network": "tcp", "security": "none", "tlsSettings": {}, - "xtlsSettings": {}, "tcpSettings": {}, "kcpSettings": {}, "wsSettings": {}, @@ -96,7 +95,7 @@ - `"none"` 表示不加密（默认值） - `"tls"` 表示使用 [TLS](https://en.wikipedia.org/wiki/base/transport_Layer_Security)。 -- `"xtls"` 表示使用 [XTLS](./features/xtls.md)。 +- `"xtls"` 表示使用 [XTLS](./features/xtls.md)。 > `tlsSettings`: [TLSObject](#tlsobject) @@ -104,8 +103,9 @@ TLS 配置。TLS 由 Golang 提供，通常情况下 TLS 协商的结果为使 > `xtlsSettings`: [XTLSObject](#tlsobject) + + XTLS 配置。XTLS 是 Xray 的原创黑科技, 也是使 Xray 性能一骑绝尘的核心动力。 XTLS 与 TLS 有相同的安全性, 配置方式也和 TLS 一致. -点击此处查看 [XTLS 的技术细节剖析](./features/xtls.md) ::: tip TLS / XTLS 是目前最安全的传输加密方案, 且外部看来流量类型和正常上网具有一致性。 启用 XTLS 并且配置合适的 XTLS 流控模式, 可以在保持和 TLS 相同的安全性的前提下, diff --git a/docs/en/config/transports/README.md b/docs/en/config/transports/README.md deleted file mode 100644 index 5632656..0000000 --- a/docs/en/config/transports/README.md +++ /dev/null @@ -1,33 +0,0 @@ -# 传输方式 - -这个章节包含了目前所有的传输方式及相关的具体配置. - -## 传输方式列表 - -> `tcpSettings`: [TcpObject](./tcp.md) - -针对 TCP 连接的配置。 - -> `wsSettings`: [WebSocketObject](./websocket.md) - -针对 WebSocket 连接的配置。 - -> `dsSettings`: [DomainSocketObject](./domainsocket.md) - -针对 Domain Socket 连接的配置。 - -> `kcpSettings`: [KcpObject](./mkcp.md) - -针对 mKCP 连接的配置。 - -> `httpSettings`: [HttpObject](./h2.md) - -针对 HTTP/2 连接的配置。 - -> `quicSettings`: [QuicObject](./quic.md) - -针对 QUIC 连接的配置。 - -> `grpcSettings`: [GRPCObject](./grpc.md) - -针对 gRPC 连接的配置。