8.0 KiB
KCP Proxy
EasyTier typically uses the UDP protocol to transmit IP packets within the virtual network. However, some ISPs restrict UDP, which can lead to high packet loss and affect TCP performance within the virtual network.
To address this issue, EasyTier provides a KCP proxy feature that can proxy TCP connections in the virtual network and convert them to KCP for transmission. Thanks to KCP's more aggressive retransmission mechanism, it effectively reduces packet loss and improves TCP transmission speeds within the virtual network.
Network Topology
Assume the network topology is as follows:
graph LR
A[Application Client] -->|TCP| B(EasyTier<br/>Node A)
B -->|KCP over UDP| C(EasyTier<br/>Node B)
C -->|TCP| D[Application Server]
classDef endpoint fill:#1e90ff,stroke:#ffffff,color:#ffffff
classDef easy fill:#4682b4,stroke:#ffffff,color:#ffffff
classDef transport stroke:#ffa500,stroke-width:2px
class A,D endpoint
class B,C easy
linkStyle 1 stroke:#ffa500,stroke-width:2px,stroke-dasharray:5 5
style B stroke-width:2px
style C stroke-width:2px
Using KCP Proxy
Enable KCP Proxy
To proxy TCP traffic on Node A to the KCP protocol, simply start EasyTier on Node A with the --enable-kcp-proxy parameter.
::: code-group
sudo easytier-core --enable-kcp-proxy
[flags]
enable_kcp_proxy = true
:::
Save the configuration above as config.toml, then start it with sudo easytier-core -c ./config.toml.
--enable-kcp-proxyenables the KCP proxy feature.
The KCP proxy ensures version compatibility by automatically reverting to the TCP protocol if it detects that the counterpart node does not support the KCP proxy.
Switch to User-Space Network Stack
By default, the KCP proxy uses the kernel's network stack, which may not work correctly due to system firewall settings. You can try using the --use-smoltcp parameter to switch to the user-space network stack.
::: code-group
sudo easytier-core --enable-kcp-proxy --use-smoltcp
[flags]
enable_kcp_proxy = true
use_smoltcp = true
:::
Save the configuration above as config.toml, then start it with sudo easytier-core -c ./config.toml.
--use-smoltcpswitches to the user-space network stack.
Disable KCP Input
If you do not want traffic destined for a specific node to use the KCP protocol, start EasyTier on the target node with the --disable-kcp-input parameter.
For example, if you do not want Node B to receive KCP traffic, start EasyTier on Node B with the following command:
::: code-group
sudo easytier-core --disable-kcp-input
[flags]
disable_kcp_input = true
:::
Save the configuration above as config.toml, then start it with sudo easytier-core -c ./config.toml.
--disable-kcp-inputdisables KCP inbound traffic.
In this case, even if Node A has enabled the KCP proxy, the traffic from Node A to Node B will continue to use the TCP protocol.
Subnet-to-Subnet KCP Support
If Node A is a router, and the subnet under A needs to access other EasyTier nodes or other proxied subnets, it can also use the KCP proxy. However, Node A must use the user-space network stack by specifying the --use-smoltcp parameter.
::: code-group
sudo easytier-core --enable-kcp-proxy --use-smoltcp
[flags]
enable_kcp_proxy = true
use_smoltcp = true
:::
Save the configuration above as config.toml, then start it with sudo easytier-core -c ./config.toml.
Otherwise, the TCP protocol will still be used.
Checking KCP Proxy Status
You can check the status of KCP proxy connections using the EasyTier CLI tool.
$ easytier-cli proxy
┌────────────────────┬───────────────────┬─────────────────────────┬───────────┬────────────────┐
│ src │ dst │ start_time │ state │ transport_type │
├────────────────────┼───────────────────┼─────────────────────────┼───────────┼────────────────┤
│ 10.126.126.7:51838 │ 10.147.223.128:22 │ 2025-02-07 10:39:08 UTC │ Connected │ Tcp │
├────────────────────┼───────────────────┼─────────────────────────┼───────────┼────────────────┤
│ 0.0.0.0:0 │ 10.147.223.1:80 │ 2025-02-07 10:41:28 UTC │ Connected │ Kcp │
├────────────────────┼───────────────────┼─────────────────────────┼───────────┼────────────────┤
│ 0.0.0.0:0 │ 10.147.223.1:80 │ 2025-02-07 10:41:18 UTC │ Connected │ Kcp │
└────────────────────┴───────────────────┴─────────────────────────┴───────────┴────────────────┘
QUIC Proxy
EasyTier v2.3.2 introduced support for QUIC proxy, which works similarly to KCP proxy, but QUIC's BBR algorithm can achieve higher bandwidth in high packet loss environments (while KCP proxy can significantly reduce latency, but has a lower bandwidth ceiling).
QUIC proxy can be enabled on the connection initiator side using the --enable-quic-proxy parameter.
::: code-group
sudo easytier-core --enable-quic-proxy
[flags]
enable_quic_proxy = true
:::
Save the configuration above as config.toml, then start it with sudo easytier-core -c ./config.toml.
QUIC proxy on the receiving end can be disabled using the --disable-quic-input parameter.
::: code-group
sudo easytier-core --disable-quic-input
[flags]
disable_quic_input = true
:::
Save the configuration above as config.toml, then start it with sudo easytier-core -c ./config.toml.
Both the sender and receiver can check the QUIC proxy connection status using the easytier-cli proxy command.
$ easytier-cli proxy
┌────────────────────┬───────────────────┬─────────────────────────┬───────────┬────────────────┐
│ src │ dst │ start_time │ state │ transport_type │
├────────────────────┼───────────────────┼─────────────────────────┼───────────┼────────────────┤
│ 10.126.126.7:51838 │ 10.147.223.128:22 │ 2025-02-07 10:39:08 UTC │ Connected │ Quic │
└────────────────────┴───────────────────┴─────────────────────────┴───────────┴────────────────┘
::: tip Note QUIC and KCP proxies can be enabled simultaneously, but KCP proxy takes precedence over QUIC proxy.
When both are enabled, QUIC proxy will only take effect after the destination end closes KCP input. :::