Skip to content

Commit 8f7ad38

Browse files
lidelmarten-seemann
authored andcommitted
docs: Swarm.EnableHolePunching
1 parent 2d54d32 commit 8f7ad38

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

docs/config.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,7 @@ config file at runtime.
9999
- [`Swarm.AddrFilters`](#swarmaddrfilters)
100100
- [`Swarm.DisableBandwidthMetrics`](#swarmdisablebandwidthmetrics)
101101
- [`Swarm.DisableNatPortMap`](#swarmdisablenatportmap)
102+
- [`Swarm.EnableHolePunching`](#swarmenableholepunching)
102103
- [`Swarm.EnableAutoRelay`](#swarmenableautorelay)
103104
- [`Swarm.RelayClient`](#swarmrelayclient)
104105
- [`Swarm.RelayClient.Enabled`](#swarmrelayclientenabled)
@@ -1279,6 +1280,21 @@ Default: `false`
12791280

12801281
Type: `bool`
12811282

1283+
### `Swarm.EnableHolePunching`
1284+
1285+
Enable hole punching for NAT traversal
1286+
when port forwarding is not possible.
1287+
1288+
When enabled, go-ipfs will coordinate with the counterparty using
1289+
a [relayed connection](https://github.com/libp2p/specs/blob/master/relay/circuit-v2.md),
1290+
to [upgrade to a direct connection](https://github.com/libp2p/specs/blob/master/relay/DCUtR.md)
1291+
through a NAT/firewall whenever possible.
1292+
For good results, use with `RelayClient.Enabled` set to `true`.
1293+
1294+
Default: `false`
1295+
1296+
Type: `flag`
1297+
12821298
### `Swarm.EnableAutoRelay`
12831299

12841300
Deprecated: Set `Swarm.RelayClient.Enabled` to `true`.

0 commit comments

Comments
 (0)