Skip to content

Commit

Permalink
docs: s/ipfs dht/amino dht/
Browse files Browse the repository at this point in the history
  • Loading branch information
lidel authored and hacdias committed Sep 22, 2023
1 parent c079a09 commit 5c0508b
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 18 deletions.
22 changes: 11 additions & 11 deletions docs/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -251,10 +251,10 @@ documented in `ipfs config profile --help`.

Reduces daemon overhead on the system. Affects node
functionality - performance of content discovery and data
fetching may be degraded. Local data won't be announced on routing systems like DHT.
fetching may be degraded. Local data won't be announced on routing systems like Amino DHT.

- `Swarm.ConnMgr` set to maintain minimum number of p2p connections at a time.
- Disables [`Reprovider`](#reprovider) service → no CID will be announced on DHT and other routing systems(!)
- Disables [`Reprovider`](#reprovider) service → no CID will be announced on Amino DHT and other routing systems(!)
- Disables AutoNAT.

Use this profile with caution.
Expand Down Expand Up @@ -1006,7 +1006,7 @@ Type: `optionalInteger` (byte count, `null` means default which is 1MB)
### `Internal.Bitswap.ProviderSearchDelay`

This parameter determines how long to wait before looking for providers outside of bitswap.
Other routing systems like the DHT are able to provide results in less than a second, so lowering
Other routing systems like the Amino DHT are able to provide results in less than a second, so lowering
this number will allow faster peers lookups in some cases.

Type: `optionalDuration` (`null` means default which is 1s)
Expand Down Expand Up @@ -1348,7 +1348,7 @@ The set of peers with which to peer.
}
```

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

Additional fields may be added in the future.

Expand Down Expand Up @@ -1395,15 +1395,15 @@ Contains options for content, peer, and IPNS routing mechanisms.

There are multiple routing options: "auto", "autoclient", "none", "dht", "dhtclient", and "custom".

* **DEFAULT:** If unset, or set to "auto", your node will use the IPFS DHT
* **DEFAULT:** If unset, or set to "auto", your node will use the public IPFS DHT (aka "Amino")
and parallel HTTP routers listed below for additional speed.

* If set to "autoclient", your node will behave as in "auto" but without running a DHT server.

* 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 ONLY use the IPFS DHT (no HTTP routers).
* If set to "dht" (or "dhtclient"/"dhtserver"), your node will ONLY use the Amino DHT (no HTTP routers).

* If set to "custom", all default routers are disabled, and only ones defined in `Routing.Routers` will be used.

Expand All @@ -1421,7 +1421,7 @@ When `Routing.Type` is set to `auto` or `dht`, your node will start as a DHT cli
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-only mode, client or server, set `Routing.Type` to
To force a specific Amino DHT-only 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.

Expand All @@ -1439,7 +1439,7 @@ Type: `optionalString` (`null`/missing means the default)

### `Routing.AcceleratedDHTClient`

This alternative DHT client with a Full-Routing-Table strategy will
This alternative Amino DHT client with a Full-Routing-Table strategy will
do a complete scan of the DHT every hour and record all nodes found.
Then when a lookup is tried instead of having to go through multiple Kad hops it
is able to find the 20 final nodes by looking up the in-memory recorded network table.
Expand Down Expand Up @@ -1489,7 +1489,7 @@ Type: `bool` (missing means `false`)

Map of additional Routers.

Allows for extending the default routing (DHT) with alternative Router
Allows for extending the default routing (Amino DHT) with alternative Router
implementations.

The map key is a name of a Router, and the value is its configuration.
Expand Down Expand Up @@ -1524,7 +1524,7 @@ HTTP:
- `MaxProvideConcurrency`: It determines the number of threads used when providing content. GOMAXPROCS by default.

DHT:
- `"Mode"`: Mode used by the DHT. Possible values: "server", "client", "auto"
- `"Mode"`: Mode used by the Amino DHT. Possible values: "server", "client", "auto"
- `"AcceleratedDHTClient"`: Set to `true` if you want to use the acceleratedDHT.
- `"PublicIPNetwork"`: Set to `true` to create a `WAN` DHT. Set to `false` to create a `LAN` DHT.

Expand Down Expand Up @@ -1558,7 +1558,7 @@ Type: `object[string->object]`

**Examples:**

Complete example using 2 Routers, DHT (LAN/WAN) and parallel.
Complete example using 2 Routers, Amino DHT (LAN/WAN) and parallel.

```
$ ipfs config Routing.Type --json '"custom"'
Expand Down
19 changes: 14 additions & 5 deletions docs/delegated-routing.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,21 @@
- Related Issues:
- https://github.com/ipfs/kubo/issues/9188
- https://github.com/ipfs/kubo/issues/9079
- https://github.com/ipfs/kubo/pull/9877

## Summary

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).
Previously we only used the Amino DHT for content routing and content
providing.

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.
Kubo 0.14 introduced experimental support for [delegated routing using Reframe protocol](https://github.com/ipfs/kubo/pull/8997).
Since then, Reframe got deprecated and superseded by [Routing V1 HTTP API](https://specs.ipfs.tech/routing/http-routing-v1/).

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

Now we need a better way to add different routers using different protocols
like [Routing V1](https://specs.ipfs.tech/routing/http-routing-v1/) or Amino
DHT, and be able to configure them (future routing systems to come) to cover different use cases.

## Motivation

Expand Down Expand Up @@ -43,12 +52,12 @@ Params:

- `"Endpoint"`: URL endpoint implementing Reframe protocol.

##### DHT
##### Amino DHT

Params:
- `"Mode"`: Mode used by the DHT. Possible values: "server", "client", "auto"
- `"Mode"`: Mode used by the Amino DHT. Possible values: "server", "client", "auto"
- `"AcceleratedDHTClient"`: Set to `true` if you want to use the experimentalDHT.
- `"PublicIPNetwork"`: Set to `true` to create a `WAN` DHT. Set to `false` to create a `LAN` DHT.
- `"PublicIPNetwork"`: Set to `true` to create a `WAN` Amino DHT. Set to `false` to create a `LAN` DHT.

##### Parallel

Expand Down
4 changes: 2 additions & 2 deletions docs/experimental-features.md
Original file line number Diff line number Diff line change
Expand Up @@ -556,7 +556,7 @@ Stable, enabled by default

Experimental, disabled by default.

When the DHT client tries to store a provider in the DHT, it typically searches for the 20 peers that are closest to the
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
target key. However, this process can be time-consuming, as the search terminates only after no closer peers are found
among the three currently (during the query) known closest ones. In cases where these closest peers are slow to respond
(which often happens if they are located at the edge of the DHT network), the query gets blocked by the slowest peer.
Expand All @@ -569,7 +569,7 @@ ones. This heuristic approach can significantly speed up the process, resulting

When it is enabled:

- DHT provide operations should complete much faster than with it disabled
- Amino DHT provide operations should complete much faster than with it disabled
- This can be tested with commands such as `ipfs routing provide`

**Tradeoffs**
Expand Down

0 comments on commit 5c0508b

Please sign in to comment.