docs: Deprecate Reframe on docs. (#9401)
Antonio Navarro Perez committed
Nov 15, 2022 at 17:01 UTC
e58cde1789835422a588e91a133904d0a9216f1d
1 file changed
+13
-48
docs/config.md
+13
-48
@@ -1299,8 +1299,7 @@ Contains options for content, peer, and IPNS routing mechanisms.
1299
Map of additional Routers.
1300
1301
Allows for extending the default routing (DHT) with alternative Router
1302
-implementations, such as custom DHTs and delegated routing based
1303
-on the [reframe protocol](https://github.com/ipfs/specs/tree/main/reframe#readme).
1302
+implementations.
1303
1304
The map key is a name of a Router, and the value is its configuration.
1305
@@ -1316,7 +1315,7 @@ It specifies the routing type that will be created.
1315
1316
Currently supported types:
1317
1319
-- `reframe` (delegated routing based on the [reframe protocol](https://github.com/ipfs/specs/tree/main/reframe#readme))
1318
+- `reframe` **(DEPRECATED)** (delegated routing based on the [reframe protocol](https://github.com/ipfs/specs/tree/main/reframe#readme))
1319
- `dht`
1320
- `parallel` and `sequential`: Helpers that can be used to run several routers sequentially or in parallel.
1321
@@ -1328,7 +1327,7 @@ Type: `string`
1327
1328
Parameters needed to create the specified router. Supported params per router type:
1329
1331
-Reframe:
1330
+Reframe **(DEPRECATED)**:
1331
- `Endpoint` (mandatory): URL that will be used to connect to a specified router.
1332
1333
DHT:
@@ -1351,21 +1350,6 @@ Sequential:
1350
- `IgnoreErrors:bool`: It will specify if that router should be ignored if an error occurred.
1351
- `Timeout:duration`: Global timeout. It accepts strings compatible with Go `time.ParseDuration(string)`.
1352
1354
-**Examples:**
1355
-
1356
-To add router provided by _Store the Index_ team at [cid.contact](https://cid.contact):
1357
-
1358
-```console
1359
-$ ipfs config Routing.Routers.CidContact --json '{
1360
- "Type": "reframe",
1361
- "Parameters": {
1362
- "Endpoint": "https://cid.contact/reframe"
1363
- }
1364
-}'
1365
-```
1366
-
1367
-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`.
1368
-
1353
Default: `{}` (use the safe implicit defaults)
1354
1355
Type: `object[string->string]`
@@ -1381,44 +1365,25 @@ Type: `object[string->object]`
1365
1366
**Examples:**
1367
1384
-To use the previously added `CidContact` reframe router on all methods:
1385
-
1386
-```console
1387
-$ ipfs config Routing.Methods --json '{
1388
- "find-peers": {
1389
- "RouterName": "CidContact"
1390
- },
1391
- "find-providers": {
1392
- "RouterName": "CidContact"
1393
- },
1394
- "get-ipns": {
1395
- "RouterName": "CidContact"
1396
- },
1397
- "provide": {
1398
- "RouterName": "CidContact"
1399
- },
1400
- "put-ipns": {
1401
- "RouterName": "CidContact"
1402
- }
1403
- }'
1404
-```
1405
-Complete example using 3 Routers, reframe, DHT and parallel.
1368
+Complete example using 2 Routers, DHT (LAN/WAN) and parallel.
1369
1370
```
1371
$ ipfs config Routing.Type --json '"custom"'
1372
1410
-$ ipfs config Routing.Routers.CidContact --json '{
1411
- "Type": "reframe",
1373
+$ ipfs config Routing.Routers.WanDHT --json '{
1374
+ "Type": "dht",
1375
"Parameters": {
1413
- "Endpoint": "https://cid.contact/reframe"
1376
+ "Mode": "auto",
1377
+ "PublicIPNetwork": true,
1378
+ "AcceleratedDHTClient": false
1379
}
1380
}'
1381
1417
-$ ipfs config Routing.Routers.WanDHT --json '{
1382
+$ ipfs config Routing.Routers.LanDHT --json '{
1383
"Type": "dht",
1384
"Parameters": {
1385
"Mode": "auto",
1421
- "PublicIPNetwork": true,
1386
+ "PublicIPNetwork": false,
1387
"AcceleratedDHTClient": false
1388
}
1389
}'
@@ -1428,7 +1393,7 @@ $ ipfs config Routing.Routers.ParallelHelper --json '{
1393
"Parameters": {
1394
"Routers": [
1395
{
1431
- "RouterName" : "CidContact",
1396
+ "RouterName" : "LanDHT",
1397
"IgnoreErrors" : true,
1398
"Timeout": "3s"
1399
},
@@ -1453,7 +1418,7 @@ ipfs config Routing.Methods --json '{
1418
"RouterName": "ParallelHelper"
1419
},
1420
"provide": {
1456
- "RouterName": "WanDHT"
1421
+ "RouterName": "ParallelHelper"
1422
},
1423
"put-ipns": {
1424
"RouterName": "ParallelHelper"