Document the AddrFilters option
Shouldn't have to scan through an old issue to figure out what is happening and why this is super important.
Hector Sanjuan committed
Jun 21, 2019 at 11:20 UTC
010336c89f980687004dde96c6a037f0b3da3f1b
1 file changed
+12
-4
docs/config.md
+12
-4
@@ -342,10 +342,18 @@ Tells reprovider what should be announced. Valid strategies are:
342
343
Options for configuring the swarm.
344
345
-- `AddrFilters`
346
-An array of address filters (multiaddr netmasks) to filter dials to.
347
-See [this issue](https://github.com/ipfs/go-ipfs/issues/1226#issuecomment-120494604) for more
348
-information.
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.
351
+
352
+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.
356
+
357
358
- `DisableBandwidthMetrics`
359
A boolean value that when set to true, will cause ipfs to not keep track of