From 1c463dff6e0a75332d7d8dab96d4f9aca0dfb68c Mon Sep 17 00:00:00 2001 From: Kobe Arthur Scofield <26771058+KobeArthurScofield@users.noreply.github.com> Date: Sun, 15 Sep 2024 17:29:15 +0800 Subject: [PATCH] Remove `timeout` field in dokodemo-door --- docs/config/inbounds/dokodemo.md | 6 ------ docs/en/config/inbounds/dokodemo.md | 31 ++++++++++++++++++++++++----- docs/ru/config/inbounds/dokodemo.md | 6 ------ 3 files changed, 26 insertions(+), 17 deletions(-) diff --git a/docs/config/inbounds/dokodemo.md b/docs/config/inbounds/dokodemo.md index 5fa512e..bed3954 100644 --- a/docs/config/inbounds/dokodemo.md +++ b/docs/config/inbounds/dokodemo.md @@ -9,7 +9,6 @@ Dokodemo door（任意门）可以监听一个本地端口，并把所有进入 "address": "8.8.8.8", "port": 53, "network": "tcp", - "timeout": 0, "followRedirect": false, "userLevel": 0 } @@ -29,10 +28,6 @@ Dokodemo door（任意门）可以监听一个本地端口，并把所有进入 可接收的网络协议类型。比如当指定为 `"tcp"` 时，仅会接收 TCP 流量。默认值为 `"tcp"`。 -> `timeout`: number - -连接空闲的时间限制。单位为秒。默认值为 `300`。处理一个连接时，如果在 `timeout` 时间内，没有任何数据被传输，则中断该连接。 - > `followRedirect`: true | false 当值为 `true` 时，dokodemo-door 会识别出由 iptables 转发而来的数据，并转发到相应的目标地址。 @@ -62,7 +57,6 @@ userLevel 的值, 对应 [policy](../policy.md#policyobject) 中 `level` 的值. "address": "mc.hypixel.net", "port": 25565, "network": "tcp", - "timeout": 0, "followRedirect": false, "userLevel": 0 }, diff --git a/docs/en/config/inbounds/dokodemo.md b/docs/en/config/inbounds/dokodemo.md index b61cb2c..8327255 100644 --- a/docs/en/config/inbounds/dokodemo.md +++ b/docs/en/config/inbounds/dokodemo.md @@ -9,7 +9,6 @@ Dokodemo door (Anywhere Door) can listen to a local port and forward all incomin "address": "8.8.8.8", "port": 53, "network": "tcp", - "timeout": 0, "followRedirect": false, "userLevel": 0 } @@ -29,10 +28,6 @@ The specified port on the destination address to forward the traffic to. It shou The supported network protocol type. For example, when specified as `"tcp"`, it will only receive TCP traffic. The default value is `"tcp"`. -> `timeout`: number - -The idle timeout in seconds. The default value is `300`. When handling a connection, if no data is transmitted within the timeout period, the connection will be terminated. - > `followRedirect`: true | false When set to `true`, dokodemo-door will recognize data forwarded by iptables and forward it to the corresponding destination address. @@ -45,6 +40,32 @@ The user level that the connection will use to determine the corresponding [Loca The value of `userLevel` corresponds to the value of `level` in the [policy](../policy.md#policyobject). If not specified, the default value is 0. +## Usage + +Dokodemo-door can be used as Transparent proxy (in the next section) and can be used to mapping a port. + +Some services does not support proxy likes SOCKS5, but using Tun or Tproxy could be too complicated. If these services only communicate with only one port (like iperf, Minecraft server, Wireguard endpoint, etc.), dokodemo-door can be used. + +Below is an example config (if the default outbound is an effective proxy): + +```json +{ + "listen": "127.0.0.1", + "port": 25565, + "protocol": "dokodemo-door", + "settings": { + "address": "mc.hypixel.net", + "port": 25565, + "network": "tcp", + "followRedirect": false, + "userLevel": 0 + }, + "tag": "mc" +} +``` + +The core will listen at `127.0.0.1:25565`, and the traffic coming in through this inbound will be send to `mc.hypixel.net:25565` (a Minecraft server) through the default outbound. Then you can connect the Minecraft client to the Hypixel server through the proxy by set the game server to `127.0.0.1:25565` in the Minecraft client. + ## Transparent Proxy Configuration Example Please refer to the [Transparent Proxy (TProxy) Configuration Tutorial](../../document/level-2/tproxy) for this section. diff --git a/docs/ru/config/inbounds/dokodemo.md b/docs/ru/config/inbounds/dokodemo.md index c36fc81..4b62cdd 100644 --- a/docs/ru/config/inbounds/dokodemo.md +++ b/docs/ru/config/inbounds/dokodemo.md @@ -9,7 +9,6 @@ Dokodemo door может прослушивать локальный порт и "address": "8.8.8.8", "port": 53, "network": "tcp", - "timeout": 0, "followRedirect": false, "userLevel": 0 } @@ -29,10 +28,6 @@ Dokodemo door может прослушивать локальный порт и Поддерживаемые типы сетевых протоколов. Например, если указано `"tcp"`, то будет приниматься только трафик TCP. Значение по умолчанию: `"tcp"`. -> `timeout`: number - -Ограничение времени простоя соединения. Измеряется в секундах. Значение по умолчанию: `300`. Если во время обработки соединения в течение `timeout` секунд не передается никаких данных, соединение разрывается. - > `followRedirect`: true | false Если значение равно `true`, dokodemo-door будет распознавать данные, перенаправленные iptables, и пересылать их на соответствующий целевой адрес. @@ -62,7 +57,6 @@ Dokodemo door может прослушивать локальный порт и "address": "mc.hypixel.net", "port": 25565, "network": "tcp", - "timeout": 0, "followRedirect": false, "userLevel": 0 },