CHANGELOG: add some more features
* AutoRelay/AutoNAt * Randomports * Hash in gateway directory listing * Badger datastore 1.0 License: MIT Signed-off-by: Steven Allen <steven@stebalien.com>
Steven Allen committed
Feb 18, 2019 at 16:22 UTC
e4208fd2b24c16aa4d303a3b8728dc4ee2047a7d
1 file changed
+54
-4
CHANGELOG.md
+54
-4
@@ -7,11 +7,49 @@ important fixes and a slew of new and improved features. Please upgrade ASAP.
7
8
### Features
9
10
-#### Autorelay
10
+#### Initializing With Random Ports
11
12
-This release pulls in a new feature from libp2p land.
12
+Go-ipfs can now be configured to listen on a random but _stable_ (across
13
+restarts) port using the new `randomports` configuration profile. This should be
14
+helpful when testing and/or running multiple go-ipfs instances on a single
15
+machine.
16
14
-TODO: WRITE THIS
17
+To initialize a go-ipfs instance with a randomly chosen port, run:
18
+
19
+```bash
20
+> ipfs init --profile=randomports
21
+```
22
+
23
+#### Gateway Directory Listing
24
+
25
+IPNS (and/or DNSLink) directory listings on the gateway, e.g.
26
+https://ipfs.io/ipns/dist.ipfs.io/go-ipfs/, will now display the _ipfs_ hash of
27
+the current directory. This way users can more easily create permanent links to
28
+otherwise mutable data.
29
+
30
+#### AutoRelay and AutoNAT
31
+
32
+This release introduces two new experimental features (courtesy of libp2p):
33
+AutoRelay and AutoNAT.
34
+
35
+AutoRelay is a new service that automatically chooses a public relay when it
36
+detects that the go-ipfs node is behind a NAT. While relaying connections
37
+through a third-party node isn't the most efficient way to route around NATs,
38
+it's a reliable fallback.
39
+
40
+To enable `AutoRelay`, set the `Swarm.EnableAutoRelay` option in the config.
41
+
42
+AutoNAT is the service AutoRelay uses to detect if the node is behind a NAT.
43
+It's enabled by default when you enable `AutoRelay` so you don't have to do
44
+anything.
45
+
46
+In this same config section, you may also notice options like `EnableRelayHop`,
47
+`EnableAutoNATService`, etc. You _do not_ need to enable these:
48
+
49
+* `EnableRelayHop` -- Allow _other_ nodes to use _your_ node as a relay
50
+ (disabled by default).
51
+* `EnableAutoNATService` -- Help _other_ nodes detect if they're behind a NAT
52
+ (disabled by default).
53
54
#### Offline Operation
55
@@ -169,7 +207,19 @@ In the past, our first suggestion to anyone experiencing weird resource or
207
connectivity issues was to disable `REUSEPORT` (set `IPFS_REUSEPORT` to false).
208
This should no longer be necessary.
209
172
-####
210
+#### Badger Datastore
211
+
212
+[Badger has reached 1.0][badger-release]. This release brings an audit and
213
+numerous reliability fixes. We are now reasonably confident that badger will
214
+become the default datastore in a future release.
215
+
216
+[badger-release]: https://blog.dgraph.io/post/releasing-v1.0/
217
+
218
+This release also adds a new `Truncate` configuration option for the badger
219
+datastore (enabled by default for new IPFS nodes). When enabled, badger will
220
+_delete_ any un-synced data on start instead of simply refusing to start. This
221
+should be safe on all filesystems where the `sync` operation is safe and removes
222
+the need for manual intervention when restarting an IPFS node after a crash.
223
224
### Refactors and Endeavors
225