diff --git a/docs/config.md b/docs/config.md index adc3541ff..d9add46e4 100644 --- a/docs/config.md +++ b/docs/config.md @@ -117,8 +117,6 @@ documented in `ipfs config profile --help`. - [`Discovery.MDNS`](#discoverymdns) - [`Discovery.MDNS.Enabled`](#discoverymdnsenabled) - [`Discovery.MDNS.Interval`](#discoverymdnsinterval) -- [`Routing`](#routing) - - [`Routing.Type`](#routingtype) - [`Gateway`](#gateway) - [`Gateway.NoFetch`](#gatewaynofetch) - [`Gateway.NoDNSLink`](#gatewaynodnslink) @@ -141,6 +139,8 @@ documented in `ipfs config profile --help`. - [`Reprovider`](#reprovider) - [`Reprovider.Interval`](#reproviderinterval) - [`Reprovider.Strategy`](#reproviderstrategy) +- [`Routing`](#routing) + - [`Routing.Type`](#routingtype) - [`Swarm`](#swarm) - [`Swarm.AddrFilters`](#swarmaddrfilters) - [`Swarm.DisableBandwidthMetrics`](#swarmdisablebandwidthmetrics) @@ -391,48 +391,6 @@ Default: `true` A number of seconds to wait between discovery checks. -## `Routing` - -Contains options for content, peer, and IPNS routing mechanisms. - -### `Routing.Type` - -Content routing mode. Can be overridden with daemon `--routing` flag. - -There are two core routing options: "none" and "dht" (default). - -* If set to "none", your node will use _no_ routing system. You'll have to - explicitly connect to peers that have the content you're looking for. -* If set to "dht" (or "dhtclient"/"dhtserver"), your node will use the IPFS DHT. - -When the DHT is enabled, it can operate in two modes: client and server. - -* In server mode, your node will query other peers for DHT records, and will - respond to requests from other peers (both requests to store records and - requests to retrieve records). -* In client mode, your node will query the DHT as a client but will not respond - to requests from other peers. This mode is less resource intensive than server - mode. - -When `Routing.Type` is set to `dht`, your node will start as a DHT client, and -switch to a DHT server when and if it determines that it's reachable from the -public internet (e.g., it's not behind a firewall). - -To force a specific DHT mode, client or server, set `Routing.Type` to -`dhtclient` or `dhtserver` respectively. Please do not set this to `dhtserver` -unless you're sure your node is reachable from the public network. - -**Example:** - -```json -{ - "Routing": { - "Type": "dhtclient" - } -} -``` - - ## `Gateway` Options for the HTTP gateway. @@ -722,6 +680,48 @@ Tells reprovider what should be announced. Valid strategies are: - "pinned" - only announce pinned data - "roots" - only announce directly pinned keys and root keys of recursive pins +## `Routing` + +Contains options for content, peer, and IPNS routing mechanisms. + +### `Routing.Type` + +Content routing mode. Can be overridden with daemon `--routing` flag. + +There are two core routing options: "none" and "dht" (default). + +* If set to "none", your node will use _no_ routing system. You'll have to + explicitly connect to peers that have the content you're looking for. +* If set to "dht" (or "dhtclient"/"dhtserver"), your node will use the IPFS DHT. + +When the DHT is enabled, it can operate in two modes: client and server. + +* In server mode, your node will query other peers for DHT records, and will + respond to requests from other peers (both requests to store records and + requests to retrieve records). +* In client mode, your node will query the DHT as a client but will not respond + to requests from other peers. This mode is less resource intensive than server + mode. + +When `Routing.Type` is set to `dht`, your node will start as a DHT client, and +switch to a DHT server when and if it determines that it's reachable from the +public internet (e.g., it's not behind a firewall). + +To force a specific DHT mode, client or server, set `Routing.Type` to +`dhtclient` or `dhtserver` respectively. Please do not set this to `dhtserver` +unless you're sure your node is reachable from the public network. + +**Example:** + +```json +{ + "Routing": { + "Type": "dhtclient" + } +} +``` + + ## `Swarm` Options for configuring the swarm.