Docs Config Tunnels

Tunnels

Forwards TCP/UDP traffic received on a local port straight to a fixed target address, optionally routed through a proxy/proxy group — commonly used to port-forward an internal service or a remote DNS server.

Two Formats

Single-Line Format

config.yaml YAML

tunnels:
  - tcp/udp,127.0.0.1:6553,8.8.8.8:53,proxy

Multi-Line Format

config.yaml YAML

tunnels:
  - network: [tcp, udp]
    address: 127.0.0.1:6553
    target: 8.8.8.8:53
    proxy: proxy

The single-line format maps in order to the multi-line format's network/address/target/proxy fields. In the example above: connecting to 127.0.0.1:6553 on this machine is equivalent to accessing 8.8.8.8:53 through the proxy outbound proxy/proxy group.

Field Reference

networkRequired

The network type to listen on — tcp/udp, or both.

addressRequired

The local address to listen on.

targetRequired

The actual target address to forward to.

proxyOptional

Forwards traffic through a specific outbound proxy/proxy group; connects directly if left blank.