docs/experimental-features.md: typo
@RubenKelevra committed
Mar 30, 2020 at 18:03 UTC
0c08e0678ca483162710915bd678b689d3455b4b
1 file changed
+27
-36
docs/experimental-features.md
+27
-36
@@ -8,7 +8,7 @@ removed.
8
9
Subscribe to https://github.com/ipfs/go-ipfs/issues/3397 to get updates.
10
11
-When you add a new experimental feature to go-ipfs, or change an experimental
11
+When you add a new experimental feature to go-ipfs or change an experimental
12
feature, you MUST please make a PR updating this document, and link the PR in
13
the above issue.
14
@@ -53,7 +53,7 @@ run your daemon with the `--enable-pubsub-experiment` flag. Then use the
53
54
Gossipsub is a new, experimental routing protocol for pubsub that
55
should waste less bandwidth than floodsub, the current pubsub
56
-protocol. It's backwards compatible with floodsub so enabling this
56
+protocol. It's backward compatible with floodsub so enabling this
57
feature shouldn't break compatibility with existing IPFS nodes.
58
59
You can enable gossipsub via configuration:
@@ -76,7 +76,7 @@ signed) by running:
76
77
### Road to being a real feature
78
- [ ] Needs more people to use and report on how well it works
79
-- [ ] Needs authenticated modes to be implemented
79
+- [ ] Needs authenticating modes to be implemented
80
- [ ] needs performance analyses to be done
81
82
---
@@ -168,7 +168,7 @@ filestore instead of copying the files into your local IPFS repo.
168
---
169
170
## ipfs urlstore
171
-Allows ipfs to retrieve blocks contents via a url instead of storing it in the datastore
171
+Allows ipfs to retrieve blocks contents via a URL instead of storing it in the datastore
172
173
### State
174
experimental.
@@ -195,7 +195,7 @@ And then add a file at a specific URL using `ipfs urlstore add <url>`
195
196
## Private Networks
197
198
-Allows ipfs to only connect to other peers who have a shared secret key.
198
+It allows ipfs to only connect to other peers who have a shared secret key.
199
200
### State
201
Experimental
@@ -249,7 +249,7 @@ configured, the daemon will fail to start.
249
## ipfs p2p
250
251
Allows tunneling of TCP connections through Libp2p streams. If you've ever used
252
-port forwarding with SSH (the `-L` option in openssh), this feature is quite
252
+port forwarding with SSH (the `-L` option in OpenSSH), this feature is quite
253
similar.
254
255
### State
@@ -262,7 +262,7 @@ master, 0.4.10
262
263
### How to enable
264
265
-The `p2p` command needs to be enabled in config:
265
+The `p2p` command needs to be enabled in the config:
266
267
```sh
268
> ipfs config --json Experimental.Libp2pStreamMounting true
@@ -354,13 +354,13 @@ with `ssh [user]@127.0.0.1 -p 2222`.
354
### Road to being a real feature
355
- [ ] Needs more people to use and report on how well it works / fits use cases
356
- [ ] More documentation
357
-- [ ] Support other protocols (e.g, unix domain sockets, websockets, etc.)
357
+- [ ] Support other protocols (e.g, Unix domain sockets, WebSockets, etc.)
358
359
---
360
361
## p2p http proxy
362
363
-Allows proxying of HTTP requests over p2p streams. This allows serving any standard http app over p2p streams.
363
+Allows proxying of HTTP requests over p2p streams. This allows serving any standard HTTP app over p2p streams.
364
365
### State
366
@@ -372,13 +372,13 @@ master, 0.4.19
372
373
### How to enable
374
375
-The `p2p` command needs to be enabled in config:
375
+The `p2p` command needs to be enabled in the config:
376
377
```sh
378
> ipfs config --json Experimental.Libp2pStreamMounting true
379
```
380
381
-On the client, the p2p http proxy needs to be enabled in the config:
381
+On the client, the p2p HTTP proxy needs to be enabled in the config:
382
383
```sh
384
> ipfs config --json Experimental.P2pHttpProxy true
@@ -427,10 +427,10 @@ the remote machine (which needs to be a http server!) with path `$FORWARDED_PATH
427
> curl http://localhost:8080/p2p/$SERVER_ID/http/
428
```
429
430
-You should now see the resulting http response: IPFS rocks!
430
+You should now see the resulting HTTP response: IPFS rocks!
431
432
### Custom protocol names
433
-We also support use of protocol names of the form /x/$NAME/http where $NAME doesn't contain any "/"'s
433
+We also support the use of protocol names of the form /x/$NAME/http where $NAME doesn't contain any "/"'s
434
435
### Road to being a real feature
436
- [ ] Needs p2p streams to graduate from experiments
@@ -453,7 +453,7 @@ master, 0.4.11
453
### How to enable
454
455
The relay transport is enabled by default, which allows peers to dial through
456
-relay and listens for incoming relay connections. The transport can be disabled
456
+a relay and listens for incoming relay connections. The transport can be disabled
457
by setting `Swarm.DisableRelay = true` in the configuration.
458
459
By default, peers don't act as intermediate nodes (relays). This can be enabled
@@ -463,7 +463,7 @@ already online node would have to be restarted.
463
464
### Basic Usage:
465
466
-In order to connect peers QmA and QmB through a relay node QmRelay:
466
+To connect peers QmA and QmB through a relay node QmRelay:
467
468
- Both peers should connect to the relay:
469
`ipfs swarm connect /transport/address/p2p/QmRelay`
@@ -483,8 +483,7 @@ Peers can see their (unspecific) relay address in the output of
483
- [ ] Advertise relay addresses to the DHT for NATed or otherwise unreachable
484
peers.
485
- [ ] Active relay discovery for specific relay address advertisement. We would
486
- like advertised relay addresses to designate specific relays for efficient
487
- dialing.
486
+ like advertised relay addresses to designate specific relays for efficient dialing.
487
- [ ] Dialing priorities for relay addresses; arguably, relay addresses should
488
have lower priority than direct dials.
489
@@ -496,7 +495,7 @@ Peers can see their (unspecific) relay address in the output of
495
### State
496
Experimental
497
499
-Plugins allow to add functionality without the need to recompile the daemon.
498
+Plugins allow adding functionality without the need to recompile the daemon.
499
500
### Basic Usage:
501
@@ -545,7 +544,7 @@ You can read more in the [datastore](./datastores.md#badgerds) documentation.
544
### State
545
Experimental
546
548
-Allows to create directories with unlimited number of entries - currently
547
+Allows to create directories with an unlimited number of entries - currently
548
size of unixfs directories is limited by the maximum block size
549
550
### Basic Usage:
@@ -571,20 +570,15 @@ ipfs config --json Experimental.ShardingEnabled true
570
571
Experimental, default-disabled.
572
574
-Utilizes pubsub for publishing ipns records in real time.
573
+Utilizes pubsub for publishing ipns records in real-time.
574
575
When it is enabled:
576
- IPNS publishers push records to a name-specific pubsub topic,
577
in addition to publishing to the DHT.
578
- IPNS resolvers subscribe to the name-specific topic on first
580
- resolution and receive subsequently published records through pubsub
581
- in real time. This makes subsequent resolutions instant, as they
582
- are resolved through the local cache. Note that the initial
583
- resolution still goes through the DHT, as there is no message
584
- history in pubsub.
579
+ resolution and receive subsequently published records through pubsub in real-time. This makes subsequent resolutions instant, as they are resolved through the local cache. Note that the initial resolution still goes through the DHT, as there is no message history in pubsub.
580
586
-Both the publisher and the resolver nodes need to have the feature enabled for it
587
-to work effectively.
581
+Both the publisher and the resolver nodes need to have the feature enabled for it to work effectively.
582
583
### How to enable
584
@@ -617,14 +611,14 @@ Modify your ipfs config:
611
ipfs config --json Experimental.QUIC true
612
```
613
620
-For listening on a QUIC address, add it the swarm addresses, e.g. `/ip4/0.0.0.0/udp/4001/quic`.
614
+For listening on a QUIC address, add it to the swarm addresses, e.g. `/ip4/0.0.0.0/udp/4001/quic`.
615
616
617
### Road to being a real feature
618
625
-- [ ] The IETF QUIC specification needs to be finalised.
619
+- [ ] The IETF QUIC specification needs to be finalized.
620
- [ ] Make sure QUIC connections work reliably
627
-- [ ] Make sure QUIC connection offer equal or better performance than TCP connections on real world networks
621
+- [ ] Make sure QUIC connection offer equal or better performance than TCP connections on real-world networks
622
- [ ] Finalize libp2p-TLS handshake spec.
623
624
@@ -687,9 +681,9 @@ ipfs config --json Experimental.StrategicProviding true
681
682
### Road to being a real feature
683
690
-- [ ] needs real world testing
684
+- [ ] needs real-world testing
685
- [ ] needs adoption
692
-- [ ] needs to support all providing features
686
+- [ ] needs to support all provided features
687
- [X] provide nothing
688
- [ ] provide roots
689
- [ ] provide all
@@ -717,7 +711,4 @@ ipfs config --json Experimental.GraphsyncEnabled true
711
712
### Road to being a real feature
713
720
-- [ ] We need to confirm that it can't be used to DoS a node. The server-side
721
- logic for GraphSync is quite complex and, if we're not careful, the server
722
- might end up performing unbounded work when responding to a malicious
723
- request.
714
+- [ ] We need to confirm that it can't be used to DoS a node. The server-side logic for GraphSync is quite complex and, if we're not careful, the server might end up performing unbounded work when responding to a malicious request.