@cryptotaxi247 / kubo / commits / 6719e124b

doc(config): sort sections

Steven Allen committed May 19, 2020 at 19:13 UTC 6719e124bb92e4defa445a5e96dc25a612d0b10f
1 file changed +44 -44
docs/config.md
+44 -44
@@ -117,8 +117,6 @@ documented in `ipfs config profile --help`.
117 - [`Discovery.MDNS`](#discoverymdns)
118 - [`Discovery.MDNS.Enabled`](#discoverymdnsenabled)
119 - [`Discovery.MDNS.Interval`](#discoverymdnsinterval)
120 -- [`Routing`](#routing)
121 - - [`Routing.Type`](#routingtype)
120 - [`Gateway`](#gateway)
121 - [`Gateway.NoFetch`](#gatewaynofetch)
122 - [`Gateway.NoDNSLink`](#gatewaynodnslink)
@@ -141,6 +139,8 @@ documented in `ipfs config profile --help`.
139 - [`Reprovider`](#reprovider)
140 - [`Reprovider.Interval`](#reproviderinterval)
141 - [`Reprovider.Strategy`](#reproviderstrategy)
142 +- [`Routing`](#routing)
143 + - [`Routing.Type`](#routingtype)
144 - [`Swarm`](#swarm)
145 - [`Swarm.AddrFilters`](#swarmaddrfilters)
146 - [`Swarm.DisableBandwidthMetrics`](#swarmdisablebandwidthmetrics)
@@ -391,48 +391,6 @@ Default: `true`
391
392 A number of seconds to wait between discovery checks.
393
394 -## `Routing`
395 -
396 -Contains options for content, peer, and IPNS routing mechanisms.
397 -
398 -### `Routing.Type`
399 -
400 -Content routing mode. Can be overridden with daemon `--routing` flag.
401 -
402 -There are two core routing options: "none" and "dht" (default).
403 -
404 -* If set to "none", your node will use _no_ routing system. You'll have to
405 - explicitly connect to peers that have the content you're looking for.
406 -* If set to "dht" (or "dhtclient"/"dhtserver"), your node will use the IPFS DHT.
407 -
408 -When the DHT is enabled, it can operate in two modes: client and server.
409 -
410 -* In server mode, your node will query other peers for DHT records, and will
411 - respond to requests from other peers (both requests to store records and
412 - requests to retrieve records).
413 -* In client mode, your node will query the DHT as a client but will not respond
414 - to requests from other peers. This mode is less resource intensive than server
415 - mode.
416 -
417 -When `Routing.Type` is set to `dht`, your node will start as a DHT client, and
418 -switch to a DHT server when and if it determines that it's reachable from the
419 -public internet (e.g., it's not behind a firewall).
420 -
421 -To force a specific DHT mode, client or server, set `Routing.Type` to
422 -`dhtclient` or `dhtserver` respectively. Please do not set this to `dhtserver`
423 -unless you're sure your node is reachable from the public network.
424 -
425 -**Example:**
426 -
427 -```json
428 -{
429 - "Routing": {
430 - "Type": "dhtclient"
431 - }
432 -}
433 -```
434 -
435 -
394 ## `Gateway`
395
396 Options for the HTTP gateway.
@@ -722,6 +680,48 @@ Tells reprovider what should be announced. Valid strategies are:
680 - "pinned" - only announce pinned data
681 - "roots" - only announce directly pinned keys and root keys of recursive pins
682
683 +## `Routing`
684 +
685 +Contains options for content, peer, and IPNS routing mechanisms.
686 +
687 +### `Routing.Type`
688 +
689 +Content routing mode. Can be overridden with daemon `--routing` flag.
690 +
691 +There are two core routing options: "none" and "dht" (default).
692 +
693 +* If set to "none", your node will use _no_ routing system. You'll have to
694 + explicitly connect to peers that have the content you're looking for.
695 +* If set to "dht" (or "dhtclient"/"dhtserver"), your node will use the IPFS DHT.
696 +
697 +When the DHT is enabled, it can operate in two modes: client and server.
698 +
699 +* In server mode, your node will query other peers for DHT records, and will
700 + respond to requests from other peers (both requests to store records and
701 + requests to retrieve records).
702 +* In client mode, your node will query the DHT as a client but will not respond
703 + to requests from other peers. This mode is less resource intensive than server
704 + mode.
705 +
706 +When `Routing.Type` is set to `dht`, your node will start as a DHT client, and
707 +switch to a DHT server when and if it determines that it's reachable from the
708 +public internet (e.g., it's not behind a firewall).
709 +
710 +To force a specific DHT mode, client or server, set `Routing.Type` to
711 +`dhtclient` or `dhtserver` respectively. Please do not set this to `dhtserver`
712 +unless you're sure your node is reachable from the public network.
713 +
714 +**Example:**
715 +
716 +```json
717 +{
718 + "Routing": {
719 + "Type": "dhtclient"
720 + }
721 +}
722 +```
723 +
724 +
725 ## `Swarm`
726
727 Options for configuring the swarm.