coosld/kubo
1
0
Fork 0
mirror of https://github.com/ipfs/kubo.git synced 2026-02-21 18:37:45 +08:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

doc(config): sort sections

Browse Source
This commit is contained in:
Steven Allen 2020-05-19 19:13:50 -07:00
parent 167c834976
commit 6719e124bb
1 changed files with 44 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

88
docs/config.md
View File

@ -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.