docs: s/ipfs dht/amino dht/
Marcin Rataj committed
Sep 21, 2023 at 22:57 UTC
5c0508b8dd127070a2ab436eccd45034b2241b5c
3 files changed
+27
-18
docs/config.md
+11
-11
@@ -251,10 +251,10 @@ documented in `ipfs config profile --help`.
251
252
Reduces daemon overhead on the system. Affects node
253
functionality - performance of content discovery and data
254
- fetching may be degraded. Local data won't be announced on routing systems like DHT.
254
+ fetching may be degraded. Local data won't be announced on routing systems like Amino DHT.
255
256
- `Swarm.ConnMgr` set to maintain minimum number of p2p connections at a time.
257
- - Disables [`Reprovider`](#reprovider) service → no CID will be announced on DHT and other routing systems(!)
257
+ - Disables [`Reprovider`](#reprovider) service → no CID will be announced on Amino DHT and other routing systems(!)
258
- Disables AutoNAT.
259
260
Use this profile with caution.
@@ -1006,7 +1006,7 @@ Type: `optionalInteger` (byte count, `null` means default which is 1MB)
1006
### `Internal.Bitswap.ProviderSearchDelay`
1007
1008
This parameter determines how long to wait before looking for providers outside of bitswap.
1009
-Other routing systems like the DHT are able to provide results in less than a second, so lowering
1009
+Other routing systems like the Amino DHT are able to provide results in less than a second, so lowering
1010
this number will allow faster peers lookups in some cases.
1011
1012
Type: `optionalDuration` (`null` means default which is 1s)
@@ -1348,7 +1348,7 @@ The set of peers with which to peer.
1348
}
1349
```
1350
1351
-Where `ID` is the peer ID and `Addrs` is a set of known addresses for the peer. If no addresses are specified, the DHT will be queried.
1351
+Where `ID` is the peer ID and `Addrs` is a set of known addresses for the peer. If no addresses are specified, the Amino DHT will be queried.
1352
1353
Additional fields may be added in the future.
1354
@@ -1395,7 +1395,7 @@ Contains options for content, peer, and IPNS routing mechanisms.
1395
1396
There are multiple routing options: "auto", "autoclient", "none", "dht", "dhtclient", and "custom".
1397
1398
-* **DEFAULT:** If unset, or set to "auto", your node will use the IPFS DHT
1398
+* **DEFAULT:** If unset, or set to "auto", your node will use the public IPFS DHT (aka "Amino")
1399
and parallel HTTP routers listed below for additional speed.
1400
1401
* If set to "autoclient", your node will behave as in "auto" but without running a DHT server.
@@ -1403,7 +1403,7 @@ There are multiple routing options: "auto", "autoclient", "none", "dht", "dhtcli
1403
* If set to "none", your node will use _no_ routing system. You'll have to
1404
explicitly connect to peers that have the content you're looking for.
1405
1406
-* If set to "dht" (or "dhtclient"/"dhtserver"), your node will ONLY use the IPFS DHT (no HTTP routers).
1406
+* If set to "dht" (or "dhtclient"/"dhtserver"), your node will ONLY use the Amino DHT (no HTTP routers).
1407
1408
* If set to "custom", all default routers are disabled, and only ones defined in `Routing.Routers` will be used.
1409
@@ -1421,7 +1421,7 @@ When `Routing.Type` is set to `auto` or `dht`, your node will start as a DHT cli
1421
switch to a DHT server when and if it determines that it's reachable from the
1422
public internet (e.g., it's not behind a firewall).
1423
1424
-To force a specific DHT-only mode, client or server, set `Routing.Type` to
1424
+To force a specific Amino DHT-only mode, client or server, set `Routing.Type` to
1425
`dhtclient` or `dhtserver` respectively. Please do not set this to `dhtserver`
1426
unless you're sure your node is reachable from the public network.
1427
@@ -1439,7 +1439,7 @@ Type: `optionalString` (`null`/missing means the default)
1439
1440
### `Routing.AcceleratedDHTClient`
1441
1442
-This alternative DHT client with a Full-Routing-Table strategy will
1442
+This alternative Amino DHT client with a Full-Routing-Table strategy will
1443
do a complete scan of the DHT every hour and record all nodes found.
1444
Then when a lookup is tried instead of having to go through multiple Kad hops it
1445
is able to find the 20 final nodes by looking up the in-memory recorded network table.
@@ -1489,7 +1489,7 @@ Type: `bool` (missing means `false`)
1489
1490
Map of additional Routers.
1491
1492
-Allows for extending the default routing (DHT) with alternative Router
1492
+Allows for extending the default routing (Amino DHT) with alternative Router
1493
implementations.
1494
1495
The map key is a name of a Router, and the value is its configuration.
@@ -1524,7 +1524,7 @@ HTTP:
1524
- `MaxProvideConcurrency`: It determines the number of threads used when providing content. GOMAXPROCS by default.
1525
1526
DHT:
1527
- - `"Mode"`: Mode used by the DHT. Possible values: "server", "client", "auto"
1527
+ - `"Mode"`: Mode used by the Amino DHT. Possible values: "server", "client", "auto"
1528
- `"AcceleratedDHTClient"`: Set to `true` if you want to use the acceleratedDHT.
1529
- `"PublicIPNetwork"`: Set to `true` to create a `WAN` DHT. Set to `false` to create a `LAN` DHT.
1530
@@ -1558,7 +1558,7 @@ Type: `object[string->object]`
1558
1559
**Examples:**
1560
1561
-Complete example using 2 Routers, DHT (LAN/WAN) and parallel.
1561
+Complete example using 2 Routers, Amino DHT (LAN/WAN) and parallel.
1562
1563
```
1564
$ ipfs config Routing.Type --json '"custom"'
docs/delegated-routing.md
+14
-5
@@ -4,12 +4,21 @@
4
- Related Issues:
5
- https://github.com/ipfs/kubo/issues/9188
6
- https://github.com/ipfs/kubo/issues/9079
7
+ - https://github.com/ipfs/kubo/pull/9877
8
9
## Summary
10
10
-Previously we only used DHT for content routing and content providing. After kubo-0.14.0 release we added support for [delegated routing using Reframe protocol](https://github.com/ipfs/kubo/pull/8997).
11
+Previously we only used the Amino DHT for content routing and content
12
+providing.
13
12
-Now we need a better way to add different routers using different protocols like Reframe or DHT, and be able to configure them to cover different use cases.
14
+Kubo 0.14 introduced experimental support for [delegated routing using Reframe protocol](https://github.com/ipfs/kubo/pull/8997).
15
+Since then, Reframe got deprecated and superseded by [Routing V1 HTTP API](https://specs.ipfs.tech/routing/http-routing-v1/).
16
+
17
+Kubo 0.23.0 release added support for [self-hosting Routing V1 HTTP API server](https://github.com/ipfs/kubo/blob/master/docs/changelogs/v0.23.md#self-hosting-routingv1-endpoint-for-delegated-routing-needs).
18
+
19
+Now we need a better way to add different routers using different protocols
20
+like [Routing V1](https://specs.ipfs.tech/routing/http-routing-v1/) or Amino
21
+DHT, and be able to configure them (future routing systems to come) to cover different use cases.
22
23
## Motivation
24
@@ -43,12 +52,12 @@ Params:
52
53
- `"Endpoint"`: URL endpoint implementing Reframe protocol.
54
46
-##### DHT
55
+##### Amino DHT
56
57
Params:
49
-- `"Mode"`: Mode used by the DHT. Possible values: "server", "client", "auto"
58
+- `"Mode"`: Mode used by the Amino DHT. Possible values: "server", "client", "auto"
59
- `"AcceleratedDHTClient"`: Set to `true` if you want to use the experimentalDHT.
51
-- `"PublicIPNetwork"`: Set to `true` to create a `WAN` DHT. Set to `false` to create a `LAN` DHT.
60
+- `"PublicIPNetwork"`: Set to `true` to create a `WAN` Amino DHT. Set to `false` to create a `LAN` DHT.
61
62
##### Parallel
63
docs/experimental-features.md
+2
-2
@@ -556,7 +556,7 @@ Stable, enabled by default
556
557
Experimental, disabled by default.
558
559
-When the DHT client tries to store a provider in the DHT, it typically searches for the 20 peers that are closest to the
559
+When the Amino DHT client tries to store a provider in the DHT, it typically searches for the 20 peers that are closest to the
560
target key. However, this process can be time-consuming, as the search terminates only after no closer peers are found
561
among the three currently (during the query) known closest ones. In cases where these closest peers are slow to respond
562
(which often happens if they are located at the edge of the DHT network), the query gets blocked by the slowest peer.
@@ -569,7 +569,7 @@ ones. This heuristic approach can significantly speed up the process, resulting
569
570
When it is enabled:
571
572
-- DHT provide operations should complete much faster than with it disabled
572
+- Amino DHT provide operations should complete much faster than with it disabled
573
- This can be tested with commands such as `ipfs routing provide`
574
575
**Tradeoffs**