Skip to content

Commit

Permalink
doc: correct the address filter documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Stebalien authored and Walter Beegle committed Jun 8, 2020
1 parent a437d2e commit a7d5a6f
Showing 1 changed file with 10 additions and 9 deletions.
19 changes: 10 additions & 9 deletions docs/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -342,17 +342,18 @@ Tells reprovider what should be announced. Valid strategies are:

Options for configuring the swarm.

- `AddrFilters` An array of address filters (multiaddr netmasks) to filter
automatic dials to. The ipfs daemon will otherwise attempt to randomly dial
the default listen port on every IP of the the local network IP range. This
improves autodiscovery of other daemons in the same network, but may also
trigger netscan alerts on some hosting providers or cause strain in some
setups.
- `AddrFilters`
An array of addresses (multiaddr netmasks) to not dial. By default, IPFS nodes advertise
_all_ addresses, even internal ones. This makes it easier for nodes on the same
network to reach each other. Unfortunately, this means that an IPFS node will
try to connect to one or more private IP addresses whenever dialing another
node, even if this other node is on a different network. This may may trigger
netscan alerts on some hosting providers or cause strain in some setups.

The `server` configuration profile fills up this list with sensible defaults,
preventing scans to most common local network (`10.0.0.0/8` or
`192.168.0.0/16`), but you should always check settings against your own
network and/or hosting provider.
preventing dials to all non-routable IP addresses (e.g., `192.168.0.0/16`) but
you should always check settings against your own network and/or hosting
provider.


- `DisableBandwidthMetrics`
Expand Down

0 comments on commit a7d5a6f

Please sign in to comment.