docs(config): explain what multiaddr is
Marcin Rataj committed
Oct 23, 2024 at 00:08 UTC
8913a1c1e599d144a8cf9ed102773a94ed3d259b
1 file changed
+21
-17
docs/config.md
+21
-17
@@ -204,7 +204,7 @@ Contains information about various listener addresses to be used by this node.
204
205
### `Addresses.API`
206
207
-Multiaddr or array of multiaddrs describing the address to serve
207
+[Multiaddr][multiaddr] or array of multiaddrs describing the address to serve
208
the local [Kubo RPC API](https://docs.ipfs.tech/reference/kubo/rpc/) (`/api/v0`).
209
210
Supported Transports:
@@ -214,11 +214,11 @@ Supported Transports:
214
215
Default: `/ip4/127.0.0.1/tcp/5001`
216
217
-Type: `strings` (multiaddrs)
217
+Type: `strings` ([multiaddrs][multiaddr])
218
219
### `Addresses.Gateway`
220
221
-Multiaddr or array of multiaddrs describing the address to serve
221
+[Multiaddr][multiaddr] or array of multiaddrs describing the address to serve
222
the local [HTTP gateway](https://specs.ipfs.tech/http-gateways/) (`/ipfs`, `/ipns`) on.
223
224
Supported Transports:
@@ -228,11 +228,11 @@ Supported Transports:
228
229
Default: `/ip4/127.0.0.1/tcp/8080`
230
231
-Type: `strings` (multiaddrs)
231
+Type: `strings` ([multiaddrs][multiaddr])
232
233
### `Addresses.Swarm`
234
235
-An array of multiaddrs describing which addresses to listen on for p2p swarm
235
+An array of [multiaddrs][multiaddr] describing which addresses to listen on for p2p swarm
236
connections.
237
238
Supported Transports:
@@ -256,7 +256,7 @@ Default:
256
]
257
```
258
259
-Type: `array[string]` (multiaddrs)
259
+Type: `array[string]` ([multiaddrs][multiaddr])
260
261
### `Addresses.Announce`
262
@@ -265,7 +265,7 @@ network. If empty, the daemon will announce inferred swarm addresses.
265
266
Default: `[]`
267
268
-Type: `array[string]` (multiaddrs)
268
+Type: `array[string]` ([multiaddrs][multiaddr])
269
270
### `Addresses.AppendAnnounce`
271
@@ -274,7 +274,7 @@ override inferred swarm addresses if non-empty.
274
275
Default: `[]`
276
277
-Type: `array[string]` (multiaddrs)
277
+Type: `array[string]` ([multiaddrs][multiaddr])
278
279
### `Addresses.NoAnnounce`
280
@@ -284,12 +284,12 @@ Takes precedence over `Addresses.Announce` and `Addresses.AppendAnnounce`.
284
> [!TIP]
285
> The [`server` configuration profile](#server-profile) fills up this list with sensible defaults,
286
> preventing announcement of non-routable IP addresses (e.g., `/ip4/192.168.0.0/ipcidr/16`,
287
-> which is the multiaddress representation of `192.168.0.0/16`) but you should always
287
+> which is the [multiaddress][multiaddr] representation of `192.168.0.0/16`) but you should always
288
> check settings against your own network and/or hosting provider.
289
290
Default: `[]`
291
292
-Type: `array[string]` (multiaddrs)
292
+Type: `array[string]` ([multiaddrs][multiaddr])
293
294
## `API`
295
@@ -451,11 +451,11 @@ Type: `duration` (when `0`/unset, the default value is used)
451
452
## `Bootstrap`
453
454
-Bootstrap is an array of multiaddrs of trusted nodes that your node connects to, to fetch other nodes of the network on startup.
454
+Bootstrap is an array of [multiaddrs][multiaddr] of trusted nodes that your node connects to, to fetch other nodes of the network on startup.
455
456
Default: The ipfs.io bootstrap nodes
457
458
-Type: `array[string]` (multiaddrs)
458
+Type: `array[string]` ([multiaddrs][multiaddr])
459
460
## `Datastore`
461
@@ -1671,7 +1671,7 @@ trigger netscan alerts on some hosting providers or cause strain in some setups.
1671
> [!TIP]
1672
> The [`server` configuration profile](#server-profile) fills up this list with sensible defaults,
1673
> preventing dials to all non-routable IP addresses (e.g., `/ip4/192.168.0.0/ipcidr/16`,
1674
-> which is the multiaddress representation of `192.168.0.0/16`) but you should always
1674
+> which is the [multiaddress][multiaddr] representation of `192.168.0.0/16`) but you should always
1675
> check settings against your own network and/or hosting provider.
1676
1677
Default: `[]`
@@ -1991,12 +1991,12 @@ Type: `optionalInteger`
1991
1992
#### `Swarm.ResourceMgr.Allowlist`
1993
1994
-A list of multiaddrs that can bypass normal system limits (but are still limited by the allowlist scope).
1994
+A list of [multiaddrs][libp2p-multiaddrs] that can bypass normal system limits (but are still limited by the allowlist scope).
1995
Convenience config around [go-libp2p-resource-manager#Allowlist.Add](https://pkg.go.dev/github.com/libp2p/go-libp2p/p2p/host/resource-manager#Allowlist.Add).
1996
1997
Default: `[]`
1998
1999
-Type: `array[string]` (multiaddrs)
1999
+Type: `array[string]` ([multiaddrs][multiaddr])
2000
2001
### `Swarm.Transports`
2002
@@ -2068,7 +2068,7 @@ Listen Addresses:
2068
[Libp2p Relay](https://github.com/libp2p/specs/tree/master/relay) proxy
2069
transport that forms connections by hopping between multiple libp2p nodes.
2070
Allows IPFS node to connect to other peers using their `/p2p-circuit`
2071
-multiaddrs. This transport is primarily useful for bypassing firewalls and
2071
+[multiaddrs][libp2p-multiaddrs]. This transport is primarily useful for bypassing firewalls and
2072
NATs.
2073
2074
See also:
@@ -2218,7 +2218,7 @@ Please remove this option from your config.
2218
2219
## `DNS`
2220
2221
-Options for configuring DNS resolution for [DNSLink](https://docs.ipfs.tech/concepts/dnslink/) and `/dns*` [Multiaddrs](https://github.com/multiformats/multiaddr/).
2221
+Options for configuring DNS resolution for [DNSLink](https://docs.ipfs.tech/concepts/dnslink/) and `/dns*` [Multiaddrs][libp2p-multiaddrs].
2222
2223
### `DNS.Resolvers`
2224
@@ -2578,3 +2578,7 @@ an implicit default when missing from the config file:
2578
2579
- `null`/missing will apply the default value defined in Kubo sources (`.WithDefault("1h2m3s")`)
2580
- a string with a valid [go duration](#duration) (e.g, `"1d2h4m40.01s"`).
2581
+
2582
+----
2583
+
2584
+[multiaddr]: https://docs.ipfs.tech/concepts/glossary/#multiaddr