Tunnel interface¶
The tunnel interface forwards a network address or Unix domain socket.
Both tunnel plugs and tunnel slots take a single attribute:
Key |
Value |
Description |
|---|---|---|
|
string |
Network address or Unix domain socket that forms one end of the tunnel.
Defaults to |
The endpoint value follows this grammar:
Field |
Format |
|---|---|
Endpoint |
|
Address |
|
Protocol |
Either |
Host |
An IPv4 or IPv6 address. When a port is supplied, IPv6 addresses must be enclosed in square brackets. Supported aliases: |
Port |
A TCP or UDP port number (1-65535). May be omitted, but only on one side of a connection; both sides then use the same port. For security, tunnel plugs in the system SDK cannot use privileged ports (1-1023). |
Path |
Absolute path to a Unix domain socket.
For security, tunnel plugs in the system SDK cannot listen on sockets outside these two directories. |
String |
An abstract socket name. |
Endpoints that start with [ or @ must be quoted in YAML:
endpoint: '[::1]:8080/tcp'
endpoint: '@abstract.sock'