Remove legacy timeout config (#577)

* Remove `timeout` field in dokodemo-door

* Remove `timeout` field in HTTP inbound

* Minor fixes to The Great Chronicles

* Force update wireguard inbound to russian docs
This commit is contained in:
Kobe Arthur Scofield
2024-09-15 18:22:25 +08:00
committed by GitHub
parent 1587d41ba3
commit 45353cd860
11 changed files with 137 additions and 67 deletions
+26 -5
View File
@@ -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.
-7
View File
@@ -23,7 +23,6 @@ In Linux, you can use the following environment variables to enable global HTTP
```json
{
"timeout": 0,
"accounts": [
{
"user": "my-username",
@@ -35,12 +34,6 @@ In Linux, you can use the following environment variables to enable global HTTP
}
```
> `timeout`: number
The idle timeout in seconds. The default value is `300`, and 0 means no timeout.
When handling a connection, if no data is transmitted within the timeout period, the connection will be terminated.
> `accounts`: \[[AccountObject](#accountobject)\]
An array where each element represents a user account. The default value is an empty array.