docs(config): add useful references
Marcin Rataj committed
Sep 20, 2024 at 15:54 UTC
58434ecbd15a34fcac0a1ddfa2e43a02df7eb2b8
1 file changed
+14
-7
docs/config.md
+14
-7
@@ -278,6 +278,12 @@ Type: `array[string]` (multiaddrs)
278
An array of swarm addresses not to announce to the network.
279
Takes precedence over `Addresses.Announce` and `Addresses.AppendAnnounce`.
280
281
+> [!TIP]
282
+> The [`server` configuration profile](#server-profile) fills up this list with sensible defaults,
283
+> preventing announcement of non-routable IP addresses (e.g., `/ip4/192.168.0.0/ipcidr/16`,
284
+> which is the multiaddress representation of `192.168.0.0/16`) but you should always
285
+> check settings against your own network and/or hosting provider.
286
+
287
Default: `[]`
288
289
Type: `array[string]` (multiaddrs)
@@ -1645,10 +1651,11 @@ node will try to connect to one or more private IP addresses whenever dialing
1651
another node, even if this other node is on a different network. This may
1652
trigger netscan alerts on some hosting providers or cause strain in some setups.
1653
1648
-The `server` configuration profile fills up this list with sensible defaults,
1649
-preventing dials to all non-routable IP addresses (e.g., `/ip4/192.168.0.0/ipcidr/16`,
1650
-which is the multiaddress representation of `192.168.0.0/16`) but you should always
1651
-check settings against your own network and/or hosting provider.
1654
+> [!TIP]
1655
+> The [`server` configuration profile](#server-profile) fills up this list with sensible defaults,
1656
+> preventing dials to all non-routable IP addresses (e.g., `/ip4/192.168.0.0/ipcidr/16`,
1657
+> which is the multiaddress representation of `192.168.0.0/16`) but you should always
1658
+> check settings against your own network and/or hosting provider.
1659
1660
Default: `[]`
1661
@@ -1666,7 +1673,7 @@ Type: `bool`
1673
1674
### `Swarm.DisableNatPortMap`
1675
1669
-Disable automatic NAT port forwarding.
1676
+Disable automatic NAT port forwarding (turn off [UPnP](https://en.wikipedia.org/wiki/Universal_Plug_and_Play)).
1677
1678
When not disabled (default), Kubo asks NAT devices (e.g., routers), to open
1679
up an external port and forward it to the port Kubo is running on. When this
@@ -2337,10 +2344,10 @@ documented in `ipfs config profile --help`.
2344
2345
### `server` profile
2346
2340
-Disables local [`Discovery.MDNS`](#discoverymdns) and blocks connections to
2347
+Disables local [`Discovery.MDNS`](#discoverymdns), [turns off uPnP NAT port mapping](#swarmdisablenatportmap), and blocks connections to
2348
IPv4 and IPv6 prefixes that are [private, local only, or unrouteable](https://github.com/ipfs/kubo/blob/b71cf0d15904bdef21fe2eee5f1118a274309a4d/config/profile.go#L24-L43).
2349
2343
-Recommended when running IPFS on machines with public IPv4 addresses
2350
+Recommended when running IPFS on machines with public IPv4 addresses (no NAT, no uPnP)
2351
at providers that interpret local IPFS discovery and traffic as netscan abuse ([example](https://github.com/ipfs/kubo/issues/10327)).
2352
2353
### `randomports` profile