document autorelay

License: MIT
Signed-off-by: vyzo <vyzo@hackzen.org>

docs/config.md

@@ -334,6 +334,17 @@ Disables the p2p-circuit relay transport.
 Enables HOP relay for the node. If this is enabled, the node will act as
 an intermediate (Hop Relay) node in relay circuits for connected peers.
 
+- `EnableAutoRelay`
+Enables automatic relay for this node.
+If the node is a HOP relay (`EnableRelayHop` is true) then it will advertise itself as a relay through the DHT.
+Otherwise, the node will test its own NAT situation (dialability) using passively discovered AutoNAT services.
+If the node is not publicly reachable, then it will seek HOP relays advertised through the DHT and override its public address(es) with relay addresses.
+
+- `EnableAutoNATService`
+Enables the AutoNAT service for this node.
+The service allows peers to discover their NAT situation by requesting dial backs to their public addresses.
+This should only be enabled on publicly reachable nodes.
+
 ### `ConnMgr`
 
 The connection manager determines which and how many connections to keep and can be configured to keep.

docs/experimental-features.md

@@ -27,6 +27,7 @@ the above issue.
 - [Directory Sharding / HAMT](#directory-sharding-hamt)
 - [IPNS PubSub](#ipns-pubsub)
 - [QUIC](#quic)
+- [AutoRelay](#autorelay)
 
 ---
 
@@ -649,3 +650,33 @@ For listening on a QUIC address, add it the swarm addresses, e.g. `/ip4/0.0.0.0/
 - [ ] Make sure QUIC connections work reliably
 - [ ] Make sure QUIC connection offer equal or better performance than TCP connections on real world networks
 - [ ] Finalize libp2p-TLS handshake spec.
+
+
+## AutoRelay
+
+### In Version
+
+0.4.19-dev
+
+### State
+
+Experimental, disabled by default.
+
+Automatically discovers relays and advertises relay addresses when the node is behind an impenetrable NAT.
+
+### How to enable
+
+Modify your ipfs config:
+
+```
+ipfs config --json Swarm.EnableAutoRelay true
+```
+
+Bootstrappers (and other public nodes) need to also enable the AutoNATService:
+```
+ipfs config --json Swarm.EnableAutoNATService true
+```
+
+### Road to being a real feature
+
+- [ ] needs testing