diff --git a/docs/config/api.md b/docs/config/api.md index 0c8df9ef..0fb7176c 100644 --- a/docs/config/api.md +++ b/docs/config/api.md @@ -54,7 +54,7 @@ API 服务监听的 IP 和端口。这是一个可选配置项。 "port": 10085, "protocol": "dokodemo-door", "settings": { - "address": "127.0.0.1" + "rewriteAddress": "127.0.0.1" }, "tag": "api" } diff --git a/docs/config/inbounds/tunnel.md b/docs/config/inbounds/tunnel.md index 0b3496fa..1c54f782 100644 --- a/docs/config/inbounds/tunnel.md +++ b/docs/config/inbounds/tunnel.md @@ -6,34 +6,34 @@ Tunnel(隧道),旧称 dokodemo-door(任意门),可以监听数个本 ```json { - "address": "8.8.8.8", - "port": 53, + "allowedNetwork": "tcp", + "rewriteAddress": "8.8.8.8", + "rewritePort": 53, "portMap": { "5555": "1.1.1.1:7777", "5556": ":8888", // overrides port only "5557": "example.com:" // overrides address only }, - "network": "tcp", "followRedirect": false, "userLevel": 0 } ``` -> `address`: address +> `allowedNetwork`: "tcp" | "udp" | "tcp,udp" + +可接收的网络协议类型。比如当指定为 `"tcp"` 时,仅会接收 TCP 流量。默认值为 `"tcp"`。 + +> `rewriteAddress`: address 将流量转发到此地址。可以是一个 IP 地址,形如 `"1.2.3.4"`,或者一个域名,形如 `"xray.com"`。字符串类型,默认为 `"localhost"`. -> `port`: number +> `rewritePort`: number 将流量转发到目标地址的指定端口,范围 \[0, 65535\],数值类型。不填或者为 0 时默认为监听端口。 > `portMap`: map[string]string -一个map, 映射本地端口和需要的远程地址/端口(如果 inbound 监听了数个端口), 如果本地端口未包含在其中则按 `address`/`port` 设置处理。 - -> `network`: "tcp" | "udp" | "tcp,udp" - -可接收的网络协议类型。比如当指定为 `"tcp"` 时,仅会接收 TCP 流量。默认值为 `"tcp"`。 +一个map, 映射本地端口和需要的远程地址/端口(如果 inbound 监听了数个端口), 如果本地端口未包含在其中则按 `rewriteAddress`/`rewritePort` 设置处理。 > `followRedirect`: true | false @@ -61,9 +61,9 @@ userLevel 的值, 对应 [policy](../policy.md#policyobject) 中 `level` 的值. "port": 25565, "protocol": "tunnel", "settings": { - "address": "mc.hypixel.net", - "port": 25565, - "network": "tcp", + "allowedNetwork": "tcp", + "rewriteAddress": "mc.hypixel.net", + "rewritePort": 25565, "followRedirect": false, "userLevel": 0 }, diff --git a/docs/config/reverse.md b/docs/config/reverse.md index f05d94c7..6f98a164 100644 --- a/docs/config/reverse.md +++ b/docs/config/reverse.md @@ -212,9 +212,9 @@ inbound: "port": 80, "protocol": "dokodemo-door", "settings": { - "address": "127.0.0.1", - "port": 80, - "network": "tcp" + "allowedNetwork": "tcp", + "rewriteAddress": "127.0.0.1", + "rewritePort": 80 } } ``` diff --git a/docs/document/level-2/iptables_gid.md b/docs/document/level-2/iptables_gid.md index c3306dca..1dc5f0aa 100644 --- a/docs/document/level-2/iptables_gid.md +++ b/docs/document/level-2/iptables_gid.md @@ -100,7 +100,7 @@ iptables -t mangle -A OUTPUT -m owner ! --gid-owner 23333 -j XRAY_SELF "port": 12345, "protocol": "dokodemo-door", "settings": { - "network": "tcp,udp", + "allowedNetwork": "tcp,udp", "followRedirect": true }, "streamSettings": { diff --git a/docs/document/level-2/nginx_or_haproxy_tls_tunnel.md b/docs/document/level-2/nginx_or_haproxy_tls_tunnel.md index 2cd76f22..d5bfa8b6 100644 --- a/docs/document/level-2/nginx_or_haproxy_tls_tunnel.md +++ b/docs/document/level-2/nginx_or_haproxy_tls_tunnel.md @@ -161,7 +161,7 @@ WantedBy=multi-user.target "port": 12345, "protocol": "dokodemo-door", "settings": { - "network": "tcp,udp", + "allowedNetwork": "tcp,udp", "followRedirect": true }, "sniffing": { diff --git a/docs/document/level-2/redirect.md b/docs/document/level-2/redirect.md index beea4ac6..24517e42 100644 --- a/docs/document/level-2/redirect.md +++ b/docs/document/level-2/redirect.md @@ -109,7 +109,7 @@ lsmod | grep wireguard "port": , "protocol": "dokodemo-door", "settings": { - "address": "127.0.0.1" + "rewriteAddress": "127.0.0.1" }, "tag": "api" } diff --git a/docs/document/level-2/tproxy.md b/docs/document/level-2/tproxy.md index 9c69f122..b01c0be4 100644 --- a/docs/document/level-2/tproxy.md +++ b/docs/document/level-2/tproxy.md @@ -34,7 +34,7 @@ sudo curl -oL /usr/local/share/xray/geosite.dat https://github.com/Loyalsoldier/ "port": 12345, "protocol": "dokodemo-door", "settings": { - "network": "tcp,udp", + "allowedNetwork": "tcp,udp", "followRedirect": true }, "sniffing": { diff --git a/docs/document/level-2/tproxy_ipv4_and_ipv6.md b/docs/document/level-2/tproxy_ipv4_and_ipv6.md index 75c152e6..f3866169 100644 --- a/docs/document/level-2/tproxy_ipv4_and_ipv6.md +++ b/docs/document/level-2/tproxy_ipv4_and_ipv6.md @@ -36,7 +36,7 @@ "port": 12345, "protocol": "dokodemo-door", "settings": { - "network": "tcp,udp", + "allowedNetwork": "tcp,udp", "followRedirect": true }, "sniffing": { diff --git a/docs/document/level-2/transparent_proxy/transparent_proxy.md b/docs/document/level-2/transparent_proxy/transparent_proxy.md index c9c014df..c5520805 100644 --- a/docs/document/level-2/transparent_proxy/transparent_proxy.md +++ b/docs/document/level-2/transparent_proxy/transparent_proxy.md @@ -113,7 +113,7 @@ Linux 使用`Netfilter`来管理网络,`Netfilter`模型如下: "port": 12345, "protocol": "dokodemo-door", "settings": { - "network": "tcp,udp", + "allowedNetwork": "tcp,udp", "followRedirect": true }, "streamSettings": { diff --git a/docs/en/config/api.md b/docs/en/config/api.md index 81582e97..102f0bbe 100644 --- a/docs/en/config/api.md +++ b/docs/en/config/api.md @@ -54,7 +54,7 @@ You can add an `api` inbound in the `inbounds` configuration: "port": 10085, "protocol": "dokodemo-door", "settings": { - "address": "127.0.0.1" + "rewriteAddress": "127.0.0.1" }, "tag": "api" } diff --git a/docs/en/config/inbounds/tunnel.md b/docs/en/config/inbounds/tunnel.md index 6ba83cc3..3a674a84 100644 --- a/docs/en/config/inbounds/tunnel.md +++ b/docs/en/config/inbounds/tunnel.md @@ -6,34 +6,34 @@ Tunnel, formerly known as dokodemo-door (Arbitrary Door), can listen on multiple ```json { - "address": "8.8.8.8", - "port": 53, + "allowedNetwork": "tcp", + "rewriteAddress": "8.8.8.8", + "rewritePort": 53, "portMap": { "5555": "1.1.1.1:7777", "5556": ":8888", // overrides port only "5557": "example.com:" // overrides address only }, - "network": "tcp", "followRedirect": false, "userLevel": 0 } ``` -> `address`: address +> `allowedNetwork`: "tcp" | "udp" | "tcp,udp" + +Accepted network protocol types. For example, when specified as `"tcp"`, only TCP traffic will be received. Default value is `"tcp"`. + +> `rewriteAddress`: address Forward traffic to this address. It can be an IP address, like `"1.2.3.4"`, or a domain name, like `"xray.com"`. String type, defaults to `"localhost"`. -> `port`: number +> `rewritePort`: number Forward traffic to the specified port of the target address. Range \[0, 65535\], numeric type. If omitted or 0, it defaults to the listening port. > `portMap`: map[string]string -A map mapping local ports to required remote addresses/ports (if the inbound listens on multiple ports). If the local port is not included in this map, it is handled according to the `address`/`port` settings. - -> `network`: "tcp" | "udp" | "tcp,udp" - -Accepted network protocol types. For example, when specified as `"tcp"`, only TCP traffic will be received. Default value is `"tcp"`. +A map mapping local ports to required remote addresses/ports (if the inbound listens on multiple ports). If the local port is not included in this map, it is handled according to the `rewriteAddress`/`rewritePort` settings. > `followRedirect`: true | false @@ -61,9 +61,9 @@ For example, the following Config (assuming the default outbound is a valid prox "port": 25565, "protocol": "tunnel", "settings": { - "address": "mc.hypixel.net", - "port": 25565, - "network": "tcp", + "allowedNetwork": "tcp", + "rewriteAddress": "mc.hypixel.net", + "rewritePort": 25565, "followRedirect": false, "userLevel": 0 }, diff --git a/docs/en/config/reverse.md b/docs/en/config/reverse.md index c421045f..835a7fd5 100644 --- a/docs/en/config/reverse.md +++ b/docs/en/config/reverse.md @@ -213,9 +213,9 @@ Inbounds: "port": 80, "protocol": "dokodemo-door", "settings": { - "address": "127.0.0.1", - "port": 80, - "network": "tcp" + "allowedNetwork": "tcp", + "rewriteAddress": "127.0.0.1", + "rewritePort": 80 } } ``` diff --git a/docs/en/document/level-2/iptables_gid.md b/docs/en/document/level-2/iptables_gid.md index a8d160d7..3d978e4d 100644 --- a/docs/en/document/level-2/iptables_gid.md +++ b/docs/en/document/level-2/iptables_gid.md @@ -96,7 +96,7 @@ Configure Xray `dokodemo-door` to listen on port 12345, enable `followRedirect` "port": 12345, "protocol": "dokodemo-door", "settings": { - "network": "tcp,udp", + "allowedNetwork": "tcp,udp", "followRedirect": true }, "streamSettings": { diff --git a/docs/en/document/level-2/nginx_or_haproxy_tls_tunnel.md b/docs/en/document/level-2/nginx_or_haproxy_tls_tunnel.md index 6e3b11c8..df02be32 100644 --- a/docs/en/document/level-2/nginx_or_haproxy_tls_tunnel.md +++ b/docs/en/document/level-2/nginx_or_haproxy_tls_tunnel.md @@ -160,7 +160,7 @@ Enable auto-start on boot: "port": 12345, "protocol": "dokodemo-door", "settings": { - "network": "tcp,udp", + "allowedNetwork": "tcp,udp", "followRedirect": true }, "sniffing": { diff --git a/docs/en/document/level-2/redirect.md b/docs/en/document/level-2/redirect.md index 020c1590..848688f7 100644 --- a/docs/en/document/level-2/redirect.md +++ b/docs/en/document/level-2/redirect.md @@ -108,7 +108,7 @@ lsmod | grep wireguard "port": , "protocol": "dokodemo-door", "settings": { - "address": "127.0.0.1" + "rewriteAddress": "127.0.0.1" }, "tag": "api" } diff --git a/docs/en/document/level-2/tproxy.md b/docs/en/document/level-2/tproxy.md index ed57c4ce..e305212c 100644 --- a/docs/en/document/level-2/tproxy.md +++ b/docs/en/document/level-2/tproxy.md @@ -34,7 +34,7 @@ sudo curl -oL /usr/local/share/xray/geosite.dat https://github.com/Loyalsoldier/ "port": 12345, "protocol": "dokodemo-door", "settings": { - "network": "tcp,udp", + "allowedNetwork": "tcp,udp", "followRedirect": true }, "sniffing": { diff --git a/docs/en/document/level-2/tproxy_ipv4_and_ipv6.md b/docs/en/document/level-2/tproxy_ipv4_and_ipv6.md index e46f2902..dc372881 100644 --- a/docs/en/document/level-2/tproxy_ipv4_and_ipv6.md +++ b/docs/en/document/level-2/tproxy_ipv4_and_ipv6.md @@ -36,7 +36,7 @@ If the Xray program is not installed on the side router, you can manually downlo "port": 12345, "protocol": "dokodemo-door", "settings": { - "network": "tcp,udp", + "allowedNetwork": "tcp,udp", "followRedirect": true }, "sniffing": { diff --git a/docs/en/document/level-2/transparent_proxy/transparent_proxy.md b/docs/en/document/level-2/transparent_proxy/transparent_proxy.md index b37989dd..df8c6833 100644 --- a/docs/en/document/level-2/transparent_proxy/transparent_proxy.md +++ b/docs/en/document/level-2/transparent_proxy/transparent_proxy.md @@ -113,7 +113,7 @@ The configuration file should listen on port 12345 and enable tproxy: "port": 12345, "protocol": "dokodemo-door", "settings": { - "network": "tcp,udp", + "allowedNetwork": "tcp,udp", "followRedirect": true }, "streamSettings": { diff --git a/docs/ru/config/api.md b/docs/ru/config/api.md index f26b4089..32bb8cb3 100644 --- a/docs/ru/config/api.md +++ b/docs/ru/config/api.md @@ -58,7 +58,7 @@ IP-адрес и порт, на котором прослушивает API-се "port": 10085, "protocol": "dokodemo-door", "settings": { - "address": "127.0.0.1" + "rewriteAddress": "127.0.0.1" }, "tag": "api" } diff --git a/docs/ru/config/inbounds/tunnel.md b/docs/ru/config/inbounds/tunnel.md index 0e07761c..61628447 100644 --- a/docs/ru/config/inbounds/tunnel.md +++ b/docs/ru/config/inbounds/tunnel.md @@ -6,36 +6,36 @@ ```json { - "address": "8.8.8.8", - "port": 53, + "allowedNetwork": "tcp", + "rewriteAddress": "8.8.8.8", + "rewritePort": 53, "portMap": { "5555": "1.1.1.1:7777", "5556": ":8888", // overrides port only "5557": "example.com:" // overrides address only }, - "network": "tcp", "followRedirect": false, "userLevel": 0 } ``` -> `address`: address +> `allowedNetwork`: "tcp" | "udp" | "tcp,udp" + +Поддерживаемые типы сетевых протоколов. Например, если указано `"tcp"`, то будет приниматься только трафик TCP. Значение по умолчанию: `"tcp"`. + +> `rewriteAddress`: address Перенаправлять трафик на этот адрес. Может быть IP-адресом, например, `"1.2.3.4"`, или доменным именем, например, `"xray.com"`, по умолчанию `"localhost"`. -Если `followRedirect` (см. ниже) равно `true`, то `address` может быть пустым. +Если `followRedirect` (см. ниже) равно `true`, то `rewriteAddress` может быть пустым. -> `port`: number +> `rewritePort`: number Перенаправляет трафик на указанный порт целевого адреса, диапазон `[0, 65535]`, числовой тип. Если не заполнено или равно `0`, по умолчанию используется порт прослушиваемого адреса. > `portMap`: map[string]string -Представляет собой `map`, который сопоставляет локальные порты с требуемыми удаленными адресами/портами (в случае, если `inbound` прослушивает несколько портов). Если локальный порт не указан в этом `map`, обработка будет производиться в соответствии с настройками `address`/`port`. - -> `network`: "tcp" | "udp" | "tcp,udp" - -Поддерживаемые типы сетевых протоколов. Например, если указано `"tcp"`, то будет приниматься только трафик TCP. Значение по умолчанию: `"tcp"`. +Представляет собой `map`, который сопоставляет локальные порты с требуемыми удаленными адресами/портами (в случае, если `inbound` прослушивает несколько портов). Если локальный порт не указан в этом `map`, обработка будет производиться в соответствии с настройками `rewriteAddress`/`rewritePort`. > `followRedirect`: true | false @@ -63,9 +63,9 @@ "port": 25565, "protocol": "tunnel", "settings": { - "address": "mc.hypixel.net", - "port": 25565, - "network": "tcp", + "allowedNetwork": "tcp", + "rewriteAddress": "mc.hypixel.net", + "rewritePort": 25565, "followRedirect": false, "userLevel": 0 }, diff --git a/docs/ru/config/reverse.md b/docs/ru/config/reverse.md index bcd0af61..6e20e4f8 100644 --- a/docs/ru/config/reverse.md +++ b/docs/ru/config/reverse.md @@ -213,9 +213,9 @@ inbound: "port": 80, "protocol": "dokodemo-door", "settings": { - "address": "127.0.0.1", - "port": 80, - "network": "tcp" + "allowedNetwork": "tcp", + "rewriteAddress": "127.0.0.1", + "rewritePort": 80 } } ``` diff --git a/docs/ru/document/level-2/iptables_gid.md b/docs/ru/document/level-2/iptables_gid.md index a31a7781..dc319e59 100644 --- a/docs/ru/document/level-2/iptables_gid.md +++ b/docs/ru/document/level-2/iptables_gid.md @@ -98,7 +98,7 @@ iptables -t mangle -A OUTPUT -m owner ! --gid-owner 23333 -j XRAY_SELF "port": 12345, "protocol": "dokodemo-door", "settings": { - "network": "tcp,udp", + "allowedNetwork": "tcp,udp", "followRedirect": true }, "streamSettings": { diff --git a/docs/ru/document/level-2/nginx_or_haproxy_tls_tunnel.md b/docs/ru/document/level-2/nginx_or_haproxy_tls_tunnel.md index 7c345f1c..c05b23fd 100644 --- a/docs/ru/document/level-2/nginx_or_haproxy_tls_tunnel.md +++ b/docs/ru/document/level-2/nginx_or_haproxy_tls_tunnel.md @@ -161,7 +161,7 @@ WantedBy=multi-user.target "port": 12345, "protocol": "dokodemo-door", "settings": { - "network": "tcp,udp", + "allowedNetwork": "tcp,udp", "followRedirect": true }, "sniffing": { diff --git a/docs/ru/document/level-2/redirect.md b/docs/ru/document/level-2/redirect.md index cc5ba71a..c35f2d5f 100644 --- a/docs/ru/document/level-2/redirect.md +++ b/docs/ru/document/level-2/redirect.md @@ -108,7 +108,7 @@ lsmod | grep wireguard "port": , "protocol": "dokodemo-door", "settings": { - "address": "127.0.0.1" + "rewriteAddress": "127.0.0.1" }, "tag": "api" } diff --git a/docs/ru/document/level-2/tproxy.md b/docs/ru/document/level-2/tproxy.md index efb27aee..55cd8b04 100644 --- a/docs/ru/document/level-2/tproxy.md +++ b/docs/ru/document/level-2/tproxy.md @@ -35,7 +35,7 @@ sudo curl -oL /usr/local/share/xray/geosite.dat https://github.com/Loyalsoldier/ "port": 12345, "protocol": "dokodemo-door", "settings": { - "network": "tcp,udp", + "allowedNetwork": "tcp,udp", "followRedirect": true }, "sniffing": { diff --git a/docs/ru/document/level-2/tproxy_ipv4_and_ipv6.md b/docs/ru/document/level-2/tproxy_ipv4_and_ipv6.md index 1a187d66..8418cf56 100644 --- a/docs/ru/document/level-2/tproxy_ipv4_and_ipv6.md +++ b/docs/ru/document/level-2/tproxy_ipv4_and_ipv6.md @@ -36,7 +36,7 @@ "port": 12345, "protocol": "dokodemo-door", "settings": { - "network": "tcp,udp", + "allowedNetwork": "tcp,udp", "followRedirect": true }, "sniffing": { diff --git a/docs/ru/document/level-2/transparent_proxy/transparent_proxy.md b/docs/ru/document/level-2/transparent_proxy/transparent_proxy.md index 24c090b7..af091f61 100644 --- a/docs/ru/document/level-2/transparent_proxy/transparent_proxy.md +++ b/docs/ru/document/level-2/transparent_proxy/transparent_proxy.md @@ -107,7 +107,7 @@ Linux использует `Netfilter` для управления сетью, "port": 12345, "protocol": "dokodemo-door", "settings": { - "network": "tcp,udp", + "allowedNetwork": "tcp,udp", "followRedirect": true }, "streamSettings": {