From 73a133c1828d87a11562f91ace6e0031f2b86a2d Mon Sep 17 00:00:00 2001
From: Marcin Rataj <lidel@lidel.org>
Date: Wed, 24 Nov 2021 17:42:11 +0100
Subject: [PATCH] docs: Swarm.EnableHolePunching

---
 docs/config.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/docs/config.md b/docs/config.md
index 3a9fb90127c..49b282c1b49 100644
--- a/docs/config.md
+++ b/docs/config.md
@@ -99,6 +99,7 @@ config file at runtime.
     - [`Swarm.AddrFilters`](#swarmaddrfilters)
     - [`Swarm.DisableBandwidthMetrics`](#swarmdisablebandwidthmetrics)
     - [`Swarm.DisableNatPortMap`](#swarmdisablenatportmap)
+    - [`Swarm.EnableHolePunching`](#swarmenableholepunching)
     - [`Swarm.EnableAutoRelay`](#swarmenableautorelay)
     - [`Swarm.RelayClient`](#swarmrelayclient)
       - [`Swarm.RelayClient.Enabled`](#swarmrelayclientenabled)
@@ -1279,6 +1280,21 @@ Default: `false`
 
 Type: `bool`
 
+### `Swarm.EnableHolePunching`
+
+Enable hole punching for NAT traversal
+when port forwarding is not possible.
+
+When enabled, go-ipfs will coordinate with the counterparty using
+a [relayed connection](https://github.com/libp2p/specs/blob/master/relay/circuit-v2.md),
+to [upgrade to a direct connection](https://github.com/libp2p/specs/blob/master/relay/DCUtR.md)
+through a NAT/firewall whenever possible.
+For good results, use with `RelayClient.Enabled` set to `true`.
+
+Default: `false`
+
+Type: `flag`
+
 ### `Swarm.EnableAutoRelay`
 
 Deprecated: Set `Swarm.RelayClient.Enabled` to `true`.