doc(changelog): finish fleshing out the changelog
Steven Allen committed
Jun 16, 2020 at 21:57 UTC
ae5ef6de0849fdbaa3dd7a5cbf1e577bfecf9598
1 file changed
+20
-8
CHANGELOG.md
+20
-8
@@ -29,14 +29,26 @@ Unfortunately, this change isn't without drawbacks: the QUIC transport may not b
29
30
If you hit this performance issue on Linux, you should tune the `net.core.rmem_default` and `net.core.rmem_max` sysctl parameters to increase your UDP receive buffer sizes.
31
32
+If necessary, you can disable the QUIC transport by running:
33
+
34
+```bash
35
+> ipfs config --json Swarm.Transports.Network.QUIC false
36
+```
37
+
38
**NOTE:** The QUIC transport included in this release is backwards incompatible with the experimental QUIC transport included in previous releases. Unfortunately, the QUIC protocol underwent some significant breaking changes and supporting multiple versions wasn't an option. In practice this degrades gracefully as go-ipfs will simply fall back on the TCP transport when dialing nodes with incompatible QUIC versions.
39
34
-#### NOISE Transport
40
+#### Noise Transport
41
36
-* Quick "why noise"?
42
+This go-ipfs release introduces a new security transport: [libp2p Noise](https://github.com/libp2p/specs/tree/master/noise) (built from the [Noise Protocol Framework](http://www.noiseprotocol.org/)). While TLS1.3 remains the default go-ipfs security transport, Noise is simpler to implement from scratch and will be the standard cross-platform libp2p security transport going forward.
43
+
44
+This brings us one step closer to deprecating and removing support for SECIO.
45
+
46
+While enabled by default, Noise won't actually be _used_ by default it's negotiated. Given that TLS1.3 is still the default security transport for go-ipfs, this usually won't happen. If you'd like to prefer Noise over other security transports, you can change its priority in the [config](./docs/config.md) (`Swarm.Transports.Security.Noise`).
47
48
#### Gateway
49
50
+This release brings two gateway-relevant features: custom 404 pages and base36 support.
51
+
52
##### Custom 404
53
54
You can now customize `404 Not Found` error pages by including an `ipfs-404.html` file somewhere in the request path. When a requested file isn't found, go-ipfs will look for an `ipfs-404.html` in the same directory as the requested file, and in each ancestor directory. If found, this file will be returned (with a 404 status code) instead of the usual error message.
@@ -55,17 +67,17 @@ $ ipfs cid format -v 1 --codec libp2p-key -b base36 bafzaajaiaejca4syrpdu6gdx4ws
67
68
#### Gossipsub Upgrade
69
58
-* Summary paragraph and a link to the blog post?
70
+This release brings a new gossipsub protocol version: 1.1. You can read about it in the [blog post](https://blog.ipfs.io/2020-05-20-gossipsub-v1.1/).
71
72
#### Connectivity
73
62
-* "Peering" support.
74
+This release introduces a new ["peering"](./docs/config.md#peering) feature. The peering subsystem configures go-ipfs to connect to, remain connected to, and reconnect to a set of nodes. Nodes should use this subsystem to create "sticky" links between frequently useful peers to improve reliability.
75
64
-#### Libp2p Changes
76
+Use-cases:
77
66
-* Advertise fewer addresses.
67
-* Reduced allocations under load.
68
-* Improved routing table refresh logic.
78
+* An IPFS gateway connected to an IPFS cluster should peer to ensure that the gateway can always fetch content from the cluster.
79
+* A dapp may peer embedded go-ipfs nodes with a set of pinning services or textile cafes/hubs.
80
+* A set of friends may peer to ensure that they can always fetch each other's content.
81
82
### Changelog
83