@cryptotaxi247 / kubo / commits / aa355da33

docs: changelog cleanup

Marcin Rataj committed Sep 11, 2024 at 16:14 UTC aa355da3382f4ca2ff1fc112bae89749c515a4d6
1 file changed +37 -37
docs/changelogs/v0.30.md
+37 -37
@@ -9,12 +9,12 @@
9 - [Improved P2P connectivity](#improved-p2p-connectivity)
10 - [Refactored Bitswap and dag-pb chunker](#refactored-bitswap-and-dag-pb-chunker)
11 - [WebRTC-Direct Transport enabled by default](#webrtc-direct-transport-enabled-by-default)
12 + - [UnixFS 1.5: Mode and Modification Time Support](#unixfs-15-mode-and-modification-time-support)
13 - [AutoNAT V2 Service Introduced Alongside V1](#autonat-v2-service-introduced-alongside-v1)
14 - [Automated `ipfs version check`](#automated-ipfs-version-check)
15 - [Version Suffix Configuration](#version-suffix-configuration)
16 - [`/unix/` socket support in `Addresses.API`](#unix-socket-support-in-addressesapi)
17 - [Cleaned Up `ipfs daemon` Startup Log](#cleaned-up-ipfs-daemon-startup-log)
17 - - [UnixFS 1.5: Mode and Modification Time Support](#unixfs-15-mode-and-modification-time-support)
18 - [Commands Preserve Specified Hostname](#commands-preserve-specified-hostname)
19 - [📝 Changelog](#-changelog)
20 - [👨‍👩‍👧‍👦 Contributors](#-contributors)
@@ -30,9 +30,9 @@ This release took longer and is more packed with fixes and features than usual.
30
31 #### Improved P2P connectivity
32
33 -This release comes with significant go-libp2p update from v0.34.1 to v0.36.3 ([release notes](https://github.com/ipfs/boxo/releases/)).
33 +This release comes with significant go-libp2p update from v0.34.1 to v0.36.3 ([release notes](https://github.com/libp2p/go-libp2p/releases/)).
34
35 -It includes multiple fixes to key protocols: QUIC/Webtransport/WebRTC, Connection Upgrades through Relay ([DCUtR](https://github.com/libp2p/specs/blob/master/relay/DCUtR.md)), and Secure WebSockets.
35 +It includes multiple fixes to key protocols: [QUIC](https://github.com/libp2p/specs/tree/master/quic)/[Webtransport](https://github.com/libp2p/specs/tree/master/webtransport)/[WebRTC](https://github.com/libp2p/specs/tree/master/webrtc), Connection Upgrades through Relay ([DCUtR](https://github.com/libp2p/specs/blob/master/relay/DCUtR.md)), and [Secure WebSockets](https://github.com/libp2p/specs/pull/624).
36
37 Also, peers that are behind certain types of NAT will now be more reachable. For this alone, Kubo users are highly encouraged to upgrade.
38
@@ -45,7 +45,7 @@ Some workloads may experience improved memory profile thanks to optimizations fr
45
46 #### WebRTC-Direct Transport enabled by default
47
48 -Kubo now ships with `/udp/4001/webrtc-direct` listener enabled by default.
48 +Kubo now ships with [WebRTC Direct](https://github.com/libp2p/specs/blob/master/webrtc/webrtc-direct.md) listener enabled by default: `/udp/4001/webrtc-direct`.
49
50 WebRTC Direct complements existing `/wss` (Secure WebSockets) and `/webtransport` transports. Unlike `/wss`, which requires a domain name and a CA-issued TLS certificate, WebRTC Direct works with IPs and can be enabled by default on all Kubo nodes.
51
@@ -54,9 +54,41 @@ Learn more: [`Swarm.Transports.Network.WebRTCDirect`](https://github.com/ipfs/ku
54 > [!NOTE]
55 > Kubo 0.30 includes a migration for existing users that adds `/webrtc-direct` listener on the same UDP port as `/udp/{port}/quic-v1`. This supports the WebRTC-Direct rollout by reusing preexisting UDP firewall settings and port mappings created for QUIC.
56
57 +#### UnixFS 1.5: Mode and Modification Time Support
58 +
59 +Kubo now allows users to opt-in to store mode and modification time for files, directories, and symbolic links.
60 +By default, if you do not opt-in, the old behavior remains unchanged, and the same CIDs will be generated as before.
61 +
62 +The `ipfs add` CLI options `--preserve-mode` and `--preserve-mtime` can be used to store the original mode and last modified time of the file being added, and `ipfs files stat /ipfs/CID` can be used for inspecting these optional attributes:
63 +
64 +```console
65 +$ touch ./file
66 +$ chmod 654 ./file
67 +$ ipfs add --preserve-mode --preserve-mtime -Q ./file
68 +QmczQr4XS1rRnWVopyg5Chr9EQ7JKpbhgnrjpb5kTQ1DKQ
69 +
70 +$ ipfs files stat /ipfs/QmczQr4XS1rRnWVopyg5Chr9EQ7JKpbhgnrjpb5kTQ1DKQ
71 +QmczQr4XS1rRnWVopyg5Chr9EQ7JKpbhgnrjpb5kTQ1DKQ
72 +Size: 0
73 +CumulativeSize: 22
74 +ChildBlocks: 0
75 +Type: file
76 +Mode: -rw-r-xr-- (0654)
77 +Mtime: 13 Aug 2024, 21:15:31 UTC
78 +```
79 +
80 +The CLI and HTTP RPC options `--mode`, `--mtime` and `--mtime-nsecs` can be used to set them to arbitrary values.
81 +
82 +Opt-in support for `mode` and `mtime` was also added to MFS (`ipfs files --help`). For more information see `--help` text of `ipfs files touch|stat|chmod` commands.
83 +
84 +Modification time support was also added to the Gateway. If present, value from file's dag-pb is returned in `Last-Modified` HTTP header and requests made with `If-Modified-Since` can produce HTTP 304 not modified response.
85 +
86 +> [!NOTE]
87 +> Storing `mode` and `mtime` requires root block to be `dag-pb` and disabled `raw-leaves` setting to create envelope for storing the metadata.
88 +
89 #### AutoNAT V2 Service Introduced Alongside V1
90
59 -The AutoNAT service enables nodes to determine their public reachability on the internet. AutoNAT V2 enhances this protocol with improved features. In this release, Kubo will offer both V1 and V2 services to other peers, although it will continue to use only V1 when acting as a client. Future releases will phase out V1, transitioning clients to utilize V2 exclusively.
91 +The AutoNAT service enables nodes to determine their public reachability on the internet. [AutoNAT V2](https://github.com/libp2p/specs/pull/538) enhances this protocol with improved features. In this release, Kubo will offer both V1 and V2 services to other peers, although it will continue to use only V1 when acting as a client. Future releases will phase out V1, transitioning clients to utilize V2 exclusively.
92
93 For more details, see the [Deployment Plan for AutoNAT V2](https://github.com/ipfs/kubo/issues/10091) and [`AutoNAT`](https://github.com/ipfs/kubo/blob/master/docs/config.md#autonat) configuration options.
94
@@ -120,38 +152,6 @@ The previous lengthy listing of all listener and announced multiaddrs has been r
152 The output now features a simplified list of swarm listeners, displayed in the format `host:port (TCP+UDP)`, which provides essential information for debugging connectivity issues, particularly related to port forwarding.
153 Announced libp2p addresses are no longer printed on startup, because libp2p may change or augument them based on AutoNAT, relay, and UPnP state. Instead, users are prompted to run `ipfs id` to obtain up-to-date list of listeners and announced multiaddrs in libp2p format.
154
123 -#### UnixFS 1.5: Mode and Modification Time Support
124 -
125 -Kubo now allows users to opt-in to store mode and modification time for files, directories, and symbolic links.
126 -By default, if you do not opt-in, the old behavior remains unchanged, and the same CIDs will be generated as before.
127 -
128 -The `ipfs add` CLI options `--preserve-mode` and `--preserve-mtime` can be used to store the original mode and last modified time of the file being added, and `ipfs files stat /ipfs/CID` can be used for inspecting these optional attributes:
129 -
130 -```console
131 -$ touch ./file
132 -$ chmod 654 ./file
133 -$ ipfs add --preserve-mode --preserve-mtime -Q ./file
134 -QmczQr4XS1rRnWVopyg5Chr9EQ7JKpbhgnrjpb5kTQ1DKQ
135 -
136 -$ ipfs files stat /ipfs/QmczQr4XS1rRnWVopyg5Chr9EQ7JKpbhgnrjpb5kTQ1DKQ
137 -QmczQr4XS1rRnWVopyg5Chr9EQ7JKpbhgnrjpb5kTQ1DKQ
138 -Size: 0
139 -CumulativeSize: 22
140 -ChildBlocks: 0
141 -Type: file
142 -Mode: -rw-r-xr-- (0654)
143 -Mtime: 13 Aug 2024, 21:15:31 UTC
144 -```
145 -
146 -The CLI and HTTP RPC options `--mode`, `--mtime` and `--mtime-nsecs` can be used to set them to arbitrary values.
147 -
148 -Opt-in support for `mode` and `mtime` was also added to MFS (`ipfs files --help`). For more information see `--help` text of `ipfs files touch|stat|chmod` commands.
149 -
150 -Modification time support was also added to the Gateway. If present, value from file's dag-pb is returned in `Last-Modified` HTTP header and requests made with `If-Modified-Since` can produce HTTP 304 not modified response.
151 -
152 -> [!NOTE]
153 -> Storing `mode` and `mtime` requires root block to be `dag-pb` and disabled `raw-leaves` setting to create envelope for storing the metadata.
154 -
155 #### Commands Preserve Specified Hostname
156
157 When executing a [CLI command](https://docs.ipfs.tech/reference/kubo/cli/) over [Kubo RPC API](https://docs.ipfs.tech/reference/kubo/rpc/), if a hostname is specified by `--api=/dns4/<domain>/` the resulting HTTP request now contains the hostname, instead of the the IP address that the hostname resolved to, as was the previous behavior. This makes it easier for those trying to run Kubo behind a reverse proxy using hostname-based rules.