Skip to content

Commit 9bf4113

Browse files
committed
tunspace: some minimal config documentation
1 parent c7c2bb5 commit 9bf4113

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

packages/tunspace/tunspace.defaults

+9
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,21 @@ if [ ! -f /etc/config/tunspace ]; then
55
package 'tunspace'
66
77
config tunspace "tunspace"
8+
# Namespace where the uplink will live.
89
option uplink_netns "uplink"
10+
# Existing interface that we'll use as the uplink.
911
option uplink_ifname "br-wan"
12+
# How the uplink in the namespace is constructed.
13+
# - bridge: creates a macvlan child in bridge mode, useful for creating multiple uplinks from the same original uplink interface.
14+
# - direct: moves the original uplink interface into the namespace directly, useful for wonky cheap USB sticks with broken drivers.
1015
option uplink_mode "bridge"
16+
# Our own static uplink IPv4 address in CIDR format. Leave empty to use DHCP.
1117
option uplink_ipv4 ""
18+
# IPv4 address of the gateway. Required in combination with uplink_ipv4, ignored when using DHCP.
1219
option uplink_gateway ""
20+
# Maintenance consists of checking the uplink, refreshing the DHCP lease, checking the tunnel endpoints, and switching endpoints if neccessary.
1321
option maintenance_interval "15"
22+
# Enables detailed output of Tunspace's operations. If disabled, only tunnel endpoint changes are reported.
1423
option debug "0"
1524
1625
config wg-server

0 commit comments

Comments
 (0)