Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Deprecate Reframe on docs. #9401

Merged
merged 1 commit into from
Nov 15, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 13 additions & 48 deletions docs/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -1299,8 +1299,7 @@ Contains options for content, peer, and IPNS routing mechanisms.
Map of additional Routers.

Allows for extending the default routing (DHT) with alternative Router
implementations, such as custom DHTs and delegated routing based
on the [reframe protocol](https://github.com/ipfs/specs/tree/main/reframe#readme).
implementations.

The map key is a name of a Router, and the value is its configuration.

Expand All @@ -1316,7 +1315,7 @@ It specifies the routing type that will be created.

Currently supported types:

- `reframe` (delegated routing based on the [reframe protocol](https://github.com/ipfs/specs/tree/main/reframe#readme))
- `reframe` **(DEPRECATED)** (delegated routing based on the [reframe protocol](https://github.com/ipfs/specs/tree/main/reframe#readme))
- `dht`
- `parallel` and `sequential`: Helpers that can be used to run several routers sequentially or in parallel.

Expand All @@ -1328,7 +1327,7 @@ Type: `string`

Parameters needed to create the specified router. Supported params per router type:

Reframe:
Reframe **(DEPRECATED)**:
- `Endpoint` (mandatory): URL that will be used to connect to a specified router.

DHT:
Expand All @@ -1351,21 +1350,6 @@ Sequential:
- `IgnoreErrors:bool`: It will specify if that router should be ignored if an error occurred.
- `Timeout:duration`: Global timeout. It accepts strings compatible with Go `time.ParseDuration(string)`.

**Examples:**

To add router provided by _Store the Index_ team at [cid.contact](https://cid.contact):

```console
$ ipfs config Routing.Routers.CidContact --json '{
"Type": "reframe",
"Parameters": {
"Endpoint": "https://cid.contact/reframe"
}
}'
```

Anyone can create and run their own Reframe endpoint, and experiment with custom routing logic. See [`someguy`](https://github.com/aschmahmann/someguy) example, which proxies requests to BOTH the IPFS Public DHT AND an Indexer node. Protocol Labs provides a public instance at `https://routing.delegate.ipfs.io/reframe`.

Default: `{}` (use the safe implicit defaults)

Type: `object[string->string]`
Expand All @@ -1381,44 +1365,25 @@ Type: `object[string->object]`

**Examples:**

To use the previously added `CidContact` reframe router on all methods:

```console
$ ipfs config Routing.Methods --json '{
"find-peers": {
"RouterName": "CidContact"
},
"find-providers": {
"RouterName": "CidContact"
},
"get-ipns": {
"RouterName": "CidContact"
},
"provide": {
"RouterName": "CidContact"
},
"put-ipns": {
"RouterName": "CidContact"
}
}'
```
Complete example using 3 Routers, reframe, DHT and parallel.
Complete example using 2 Routers, DHT (LAN/WAN) and parallel.

```
$ ipfs config Routing.Type --json '"custom"'

$ ipfs config Routing.Routers.CidContact --json '{
"Type": "reframe",
$ ipfs config Routing.Routers.WanDHT --json '{
"Type": "dht",
"Parameters": {
"Endpoint": "https://cid.contact/reframe"
"Mode": "auto",
"PublicIPNetwork": true,
"AcceleratedDHTClient": false
}
}'

$ ipfs config Routing.Routers.WanDHT --json '{
$ ipfs config Routing.Routers.LanDHT --json '{
"Type": "dht",
"Parameters": {
"Mode": "auto",
"PublicIPNetwork": true,
"PublicIPNetwork": false,
"AcceleratedDHTClient": false
}
}'
Expand All @@ -1428,7 +1393,7 @@ $ ipfs config Routing.Routers.ParallelHelper --json '{
"Parameters": {
"Routers": [
{
"RouterName" : "CidContact",
"RouterName" : "LanDHT",
"IgnoreErrors" : true,
"Timeout": "3s"
},
Expand All @@ -1453,7 +1418,7 @@ ipfs config Routing.Methods --json '{
"RouterName": "ParallelHelper"
},
"provide": {
"RouterName": "WanDHT"
"RouterName": "ParallelHelper"
},
"put-ipns": {
"RouterName": "ParallelHelper"
Expand Down