doc: correct the address filter documentation
Steven Allen committed
Jul 11, 2019 at 19:03 UTC
72122a5dbfdce14533b1e04675e9ac516301b406
1 file changed
+10
-9
docs/config.md
+10
-9
@@ -342,17 +342,18 @@ Tells reprovider what should be announced. Valid strategies are:
342
343
Options for configuring the swarm.
344
345
-- `AddrFilters` An array of address filters (multiaddr netmasks) to filter
346
-automatic dials to. The ipfs daemon will otherwise attempt to randomly dial
347
-the default listen port on every IP of the the local network IP range. This
348
-improves autodiscovery of other daemons in the same network, but may also
349
-trigger netscan alerts on some hosting providers or cause strain in some
350
-setups.
345
+- `AddrFilters`
346
+An array of addresses (multiaddr netmasks) to not dial. By default, IPFS nodes advertise
347
+_all_ addresses, even internal ones. This makes it easier for nodes on the same
348
+network to reach each other. Unfortunately, this means that an IPFS node will
349
+try to connect to one or more private IP addresses whenever dialing another
350
+node, even if this other node is on a different network. This may may trigger
351
+netscan alerts on some hosting providers or cause strain in some setups.
352
353
The `server` configuration profile fills up this list with sensible defaults,
353
-preventing scans to most common local network (`10.0.0.0/8` or
354
-`192.168.0.0/16`), but you should always check settings against your own
355
-network and/or hosting provider.
354
+preventing dials to all non-routable IP addresses (e.g., `192.168.0.0/16`) but
355
+you should always check settings against your own network and/or hosting
356
+provider.
357
358
359
- `DisableBandwidthMetrics`