doc: cleanup experimental features a bit
Steven Allen committed
Apr 6, 2020 at 13:57 UTC
3e6f0a79426173c1a53828716ede7cfccb2a83bc
2 files changed
+35
-15
docs/config.md
+24
-8
@@ -316,18 +316,34 @@ A number of seconds to wait between discovery checks.
316
317
## `Routing`
318
319
-Contains options for content routing mechanisms.
319
+Contains options for content, peer, and IPNS routing mechanisms.
320
321
### `Routing.Type`
322
323
-Content routing mode. Can be overridden with daemon `--routing` flag. When set
324
-to `dhtclient`, the node won't join the DHT but can still use it to find
325
-content.
323
+Content routing mode. Can be overridden with daemon `--routing` flag.
324
327
-Valid modes are:
328
- - `dht` (default)
329
- - `dhtclient`
330
- - `none`
325
+There are two core routing options: "none" and "dht" (default).
326
+
327
+* If set to "none", your node will use _no_ routing system. You'll have to
328
+ explicitly connect to peers that have the content you're looking for.
329
+* If set to "dht" (or "dhtclient"/"dhtserver"), your node will use the IPFS DHT.
330
+
331
+When the DHT is enabled, it can operate in two modes: client and server.
332
+
333
+* In server mode, your node will query other peers for DHT records, and will
334
+ respond to requests from other peers (both requests to store records and
335
+ requests to retrieve records).
336
+* In client mode, your node will query the DHT as a client but will not respond
337
+ to requests from other peers. This mode is less resource intensive than server
338
+ mode.
339
+
340
+When `Routing.Type` is set to `dht`, your node will start as a DHT client, and
341
+switch to a DHT server when and if it determines that it's reachable from the
342
+public internet (e.g., it's not behind a firewall).
343
+
344
+To force a specific DHT mode, client or server, set `Routing.Type` to
345
+`dhtclient` or `dhtserver` respectively. Please do not set this to `dhtserver`
346
+unless you're sure your node is reachable from the public network.
347
348
**Example:**
349
docs/experimental-features.md
+11
-7
@@ -82,21 +82,20 @@ signed) by running:
82
---
83
84
## Client mode DHT routing
85
+
86
Allows the dht to be run in a mode that doesn't serve requests to the network,
87
saving bandwidth.
88
89
### State
89
-experimental.
90
+stable
91
92
### In Version
92
-0.4.5
93
+
94
+0.5.0
95
96
### How to enable
95
-run your daemon with the `--routing=dhtclient` flag.
97
97
-### Road to being a real feature
98
-- [ ] Needs more people to use and report on how well it works.
99
-- [ ] Needs analysis of effect it has on the network as a whole.
98
+run your daemon with the `--routing=dhtclient` flag.
99
100
---
101
@@ -507,6 +506,8 @@ See [Plugin docs](./plugins.md)
506
- [ ] More plugins and plugin types
507
- [ ] Feedback on stability
508
509
+---
510
+
511
## Badger datastore
512
513
### In Version
@@ -591,7 +592,7 @@ run your daemon with the `--enable-namesys-pubsub` flag; enables pubsub.
592
so that we don't have to hit the DHT for the initial resolution.
593
Alternatively, we could republish the last record periodically.
594
594
-
595
+---
596
597
## QUIC
598
@@ -662,6 +663,7 @@ ipfs config --json Swarm.EnableAutoNATService true
663
664
Stable
665
666
+---
667
668
## Strategic Providing
669
@@ -688,6 +690,8 @@ ipfs config --json Experimental.StrategicProviding true
690
- [ ] provide roots
691
- [ ] provide all
692
- [ ] provide strategic
693
+
694
+---
695
696
## GraphSync
697