Skip to content

Releases: ipfs/kubo

v0.33.1

04 Feb 21:35
@lidel lidel
v0.33.1
This tag was signed with the committer’s verified signature.
lidel Marcin Rataj
GPG key ID: 222B6784D5A79E42
Verified
Learn about vigilant mode.
9bfbc4e
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.
Compare
Choose a tag to compare
v0.33.1 Latest
Latest

This is a patch release with an important boxo/bitswap fix that we believe should reach you without waiting for 0.34 :)
See 0.33.0 for full list of changes since 0.32.1.

🔦 Highlights

Bitswap improvements from Boxo

This release includes boxo/bitswap performance and reliability improvements and fixes for minor resource leaks. One of the performance changes greatly improves the bitswap clients ability to operate under high load, that could previously result in an out of memory condition.

Improved IPNS interop

Improved compatibility with third-party IPNS publishers by restoring support for compact binary CIDs in the Value field of IPNS Records (IPNS Specs). As long the signature is valid, Kubo will now resolve such records (likely created by non-Kubo nodes) and convert raw CIDs into valid /ipfs/cid content paths.
Note: This only adds support for resolving externally created records—Kubo’s IPNS record creation remains unchanged. IPNS records with empty Value fields default to zero-length /ipfs/bafkqaaa to maintain backward compatibility with code expecting a valid content path.

📦️ Important dependency updates

🗣 Discuss

This release was brought to you by the Shipyard team.

If you have comments, questions, or feedback on this release, please post here.

If you experienced any bugs with the release, please post an issue.

📝 Changelog

Full Changelog v0.33.1

👨‍👩‍👧‍👦 Contributors

Contributor Commits Lines ± Files Changed
Dreamacro 1 +304/-376 119
Andrew Gillis 7 +306/-200 20
Guillaume Michel 5 +122/-98 14
Marcin Rataj 2 +113/-7 4
gammazero 6 +41/-11 6
Sergey Gorbunov 1 +14/-2 2
Daniel Norman 1 +9/-0 1
Assets 50

v0.33.0

29 Jan 22:14
@lidel lidel
v0.33.0
This tag was signed with the committer’s verified signature.
lidel Marcin Rataj
GPG key ID: 222B6784D5A79E42
Verified
Learn about vigilant mode.
8b65738
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.
Compare
Choose a tag to compare
v0.33.0

This release was brought to you by the Shipyard team.

🗣 Discuss

If you have comments, questions, or feedback on this release, please post here.

If you experienced any bugs with the release, please post an issue.

🔦 Highlights

Shared TCP listeners

Kubo now supports sharing the same TCP port (4001 by default) by both raw TCP and WebSockets libp2p transports.

This feature is not yet compatible with Private Networks and can be disabled by setting LIBP2P_TCP_MUX=false if causes any issues.

AutoTLS takes care of Secure WebSockets setup

It is no longer necessary to manually add /tcp/../ws listeners to Addresses.Swarm when AutoTLS.Enabled is set to true. Kubo will detect if /ws listener is missing and add one on the same port as pre-existing TCP (e.g. /tcp/4001), removing the need for any extra configuration.

Tip

Give it a try:

$ ipfs config --json AutoTLS.Enabled true

And restart the node. If you are behind NAT, make sure your node is publicly diallable (uPnP or port forwarding), and wait a few minutes to pass all checks and for the changes to take effect.

See AutoTLS for more information.

Bitswap improvements from Boxo

This release includes some refactorings and improvements affecting Bitswap which should improve reliability. One of the changes affects blocks providing. Previously, the bitswap layer took care itself of announcing new blocks -added or received- with the configured provider (i.e. DHT). This bypassed the "Reprovider", that is, the system that manages precisely "providing" the blocks stored by Kubo. The Reprovider knows how to take advantage of the AcceleratedDHTClient, is able to handle priorities, logs statistics and is able to resume on daemon reboot where it left off. From now on, Bitswap will not be doing any providing on-the-side and all announcements are managed by the reprovider. In some cases, when the reproviding queue is full with other elements, this may cause additional delays, but more likely this will result in improved block-providing behaviour overall.

Using default libp2p_rcmgr metrics

Bespoke rcmgr metrics were removed, Kubo now exposes only the default libp2p_rcmgr metrics from go-libp2p.
This makes it easier to compare Kubo with custom implementations based on go-libp2p.
If you depended on removed ones, please fill an issue to add them to the upstream go-libp2p.

Flatfs does not sync on each write

New repositories initialized with flatfs in Datastore.Spec will have sync set to false.

The old default was overly conservative and caused performance issues in big repositories that did a lot of writes. There is usually no need to flush on every block write to disk before continuing. Setting this to false is safe as kubo will automatically flush writes to disk before and after performing critical operations like pinning. However, we still provide users with ability to set this to true to be extra-safe (at the cost of a slowdown when adding files in bulk).

ipfs add --to-files no longer works with --wrap

Onboarding files and directories with ipfs add --to-files now requires non-empty names. due to this, The --to-files and --wrap options are now mutually exclusive (#10612).

ipfs --api supports HTTPS RPC endpoints

CLI and RPC client now supports accessing Kubo RPC over https:// protocol when multiaddr ending with /https or /tls/http is passed to ipfs --api:

$ ipfs id --api /dns/kubo-rpc.example.net/tcp/5001/tls/http
# → https://kubo-rpc.example.net:5001

New options for faster writes: WriteThrough, BlockKeyCacheSize, BatchMaxNodes, BatchMaxSize

Now that Kubo supports pebble as an experimental datastore backend, it becomes very useful to expose some additional configuration options for how the blockservice/blockstore/datastore combo behaves.

Usually, LSM-tree based datastore like Pebble or Badger have very fast write performance (blocks are streamed to disk) while incurring in read-amplification penalties (blocks need to be looked up in the index to know where they are on disk), specially noticiable on spinning disks.

Prior to this version, BlockService and Blockstore implementations performed a Has(cid) for every block that was going to be written, skipping the writes altogether if the block was already present in the datastore. The performance impact of this Has() call can vary. The Datastore implementation itself might include block-caching and things like bloom-filters to speed up lookups and mitigate read-penalties. Our Blockstore implementation also supports a bloom-filter (controlled by BloomFilterSize and disabled by default), and a two-queue cache for keys and block sizes. If we assume that most of the blocks added to Kubo are new blocks, not already present in the datastore, or that the datastore itself includes mechanisms to optimize writes and avoid writing the same data twice, the calls to Has() at both BlockService and Blockstore layers seem superflous to they point they even harm write performance.

For these reasons, from now on, the default is to use a "write-through" mode for the Blockservice and the Blockstore. We have added a new option Datastore.WriteThrough, which defaults to true. Previous behaviour can be obtained by manually setting it to false.

We have also made the size of the two-queue blockstore cache configurable with another option: Datastore.BlockKeyCacheSize, which defaults to 65536 (64KiB). Additionally, this caching layer can be disabled altogether by setting it to 0. In particular, this option controls the size of a blockstore caching layer that records whether the blockstore has certain block and their sizes (but does not cache the contents, so it stays relativey small in general).

Finally, we have added two new options to the Import section to control the maximum size of write-batches: BatchMaxNodes and BatchMaxSize. These are set by default to 128 nodes and 20MiB. Increasing them will batch more items together when importing data with ipfs dag import, which can speed things up. It is importance to find a balance between available memory (used to hold the batch), disk latencies (when writing the batch) and processing power (when preparing the batch, as nodes are sorted and duplicates removed).

As a reminder, details from all the options are explained in the configuration documentation.

We recommend users trying Pebble as a datastore backend to disable both blockstore bloom-filter and key caching layers and enable write through as a way to evaluate the raw performance of the underlying datastore, which includes its own bloom-filter and caching layers (default cache size is 8MiB and can be configured in the options.

MFS stability with large number of writes

We have fixed a number of issues that were triggered by writing or copying many files onto an MFS folder: increased memory usage first, then CPU, disk usage, and eventually a deadlock on write operations. The details of the fixes can be read at #10630 and #10623. The result is that writing large amounts of files to an MFS folder should now be possible without major issues. It is possible, as before, to speed up the operations using the `ipfs fi...

Read more
Assets 50
Loading

v0.33.0-rc3

23 Jan 20:48
@lidel lidel
v0.33.0-rc3
This tag was signed with the committer’s verified signature.
lidel Marcin Rataj
GPG key ID: 222B6784D5A79E42
Verified
Learn about vigilant mode.
4c23919
This commit was signed with the committer’s verified signature.
lidel Marcin Rataj
GPG key ID: 222B6784D5A79E42
Verified
Learn about vigilant mode.
Compare
Choose a tag to compare
v0.33.0-rc3 Pre-release
Pre-release

This is the Third Release Candidate (RC3) with boxo and quic-go fixes.

See the draft changelog: docs/changelogs/v0.33.md

Related: release issue, discussion forum topic

This Kubo release is brought to you by the Shipyard team.

Assets 50
Loading

v0.33.0-rc2

22 Jan 23:58
@lidel lidel
v0.33.0-rc2
This tag was signed with the committer’s verified signature.
lidel Marcin Rataj
GPG key ID: 222B6784D5A79E42
Verified
Learn about vigilant mode.
6426e19
This commit was signed with the committer’s verified signature.
lidel Marcin Rataj
GPG key ID: 222B6784D5A79E42
Verified
Learn about vigilant mode.
Compare
Choose a tag to compare
v0.33.0-rc2 Pre-release
Pre-release

Caution

We've identified a regression, working on a fix, there may be RC3 later this week.

This is second Release Candidate (RC2) with multiple fixes since RC1.

See the related issue: #10580, discussion forum topic and the draft changelog: docs/changelogs/v0.33.md

This release was brought to you by the Shipyard team.

Assets 50
Loading

v0.33.0-rc1

20 Dec 19:49
@lidel lidel
v0.33.0-rc1
This tag was signed with the committer’s verified signature.
lidel Marcin Rataj
GPG key ID: 222B6784D5A79E42
Verified
Learn about vigilant mode.
1b5aa0b
This commit was signed with the committer’s verified signature.
lidel Marcin Rataj
GPG key ID: 222B6784D5A79E42
Verified
Learn about vigilant mode.
Compare
Choose a tag to compare
v0.33.0-rc1 Pre-release
Pre-release

This is a Release Candidate we managed to ship before holiday break :-)

See the related issue: #10580 + discussion forum topic

And the draft changelog: docs/changelogs/v0.33.md

This release was brought to you by the Shipyard team.

Assets 50
Loading

v0.32.1

15 Nov 20:50
@lidel lidel
v0.32.1
This tag was signed with the committer’s verified signature.
lidel Marcin Rataj
GPG key ID: 222B6784D5A79E42
Verified
Learn about vigilant mode.
9017453
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.
Compare
Choose a tag to compare
v0.32.1

This release was brought to you by the Shipyard team.

Overview

This is a bugfix release on top of v0.32.0 to include go-libp2p-kad-dht v0.28.1.
If you run with Routing.AcceleratedDHTClient=true make sure to update.

Release v0.32 issue #10547

🗣 Discuss

If you have comments, questions, or feedback on this release, please post here.

If you experienced any bugs with the release, please post an issue.

🔦 Highlights

🎯 AutoTLS: Automatic Certificates for libp2p WebSockets via libp2p.direct

This release introduces an experimental feature that significantly improves how browsers (Helia, Service Worker) can connect to Kubo node.

Opt-in configuration allows a publicly dialable Kubo nodes (public IP, port forwarding, or NAT with uPnP) to obtain CA-signed TLS certificates for libp2p Secure WebSocket (WSS) connections automatically.

Tip

To enable this feature, set AutoTLS.Enabled to true and add a listener for /tls/sni/*.libp2p.direct/ws on a separate TCP port:

{
+ "AutoTLS": { "Enabled": true },
  "Addresses": {
    "Swarm": {
      "/ip4/0.0.0.0/tcp/4001",
+     "/ip4/0.0.0.0/tcp/4002/tls/sni/*.libp2p.direct/ws",
      "/ip6/::/tcp/4001",
+     "/ip6/::/tcp/4002/tls/sni/*.libp2p.direct/ws",

After restarting your node for the first time you may need to wait 5-15 minutes to pass all checks and for the changes to take effect.
We are working on sharing the same TCP port with other transports (go-libp2p#2984).

See AutoTLS configuration for more details how to enable it and what to expect.

This is an early preview, we appreciate you testing and filling bug reports or feedback in the tracking issue at kubo#10560.

📦️ Dependency updates

  • update ipfs-webui to v4.4.0
  • update boxo to v0.24.1 + v0.24.2 + v0.24.3
    • This includes a number of fixes and bitswap improvements, and support for filtering from IPIP-484 in delegated HTTP routing and IPNI queries.
  • update go-libp2p to v0.37.0
    • This update required removal of Swarm.RelayService.MaxReservationsPerPeer configuration option from Kubo. If you had it set, remove it from your configuration file.
  • update go-libp2p-kad-dht to v0.27.0 + v0.28.0 + v0.28.1
  • update go-libp2p-pubsub to v0.12.0
  • update p2p-forge/client to v0.0.2
  • removed go-homedir
    • The github.com/mitchellh/go-homedir repo is archived, no longer needed, and no longer maintained.
    • homedir.Dir is replaced by the stdlib os.UserHomeDir
    • homedir.Expand is replaced by fsutil.ExpandHome in the github.com/ipfs/kubo/misc/fsutil package.
    • The new github.com/ipfs/kubo/misc/fsutil package contains file utility code previously located elsewhere in kubo.

📝 Changelog

Full Changelog
Read more
Assets 50
Loading

v0.32.0

14 Nov 01:36
@lidel lidel
v0.32.0
This tag was signed with the committer’s verified signature.
lidel Marcin Rataj
GPG key ID: 222B6784D5A79E42
Verified
Learn about vigilant mode.
ad1055c
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.
Compare
Choose a tag to compare
v0.32.0

Warning

If you depend on Routing.AcceleratedDHTClient=true this release contains a regression where accelerated client does not crawl the network correctly and the regular one is used instead as a fallback, making announcements slower than expected.

The fix for Routing.AcceleratedDHTClient=true is in v0.32.1.

If you don't use Routing.AcceleratedDHTClient=true, this release is perfectly fine to use as-is.

This release was brought to you by the Shipyard team.

Overview

Release v0.32.0 issue #10547

🗣 Discuss

If you have comments, questions, or feedback on this release, please post here.

If you experienced any bugs with the release, please post an issue.

🔦 Highlights

🎯 AutoTLS: Automatic Certificates for libp2p WebSockets via libp2p.direct

This release introduces an experimental feature that significantly improves how browsers (Helia, Service Worker) can connect to Kubo node.

Opt-in configuration allows a publicly dialable Kubo nodes (public IP, port forwarding, or NAT with uPnP) to obtain CA-signed TLS certificates for libp2p Secure WebSocket (WSS) connections automatically.

Tip

To enable this feature, set AutoTLS.Enabled to true and add a listener for /tls/sni/*.libp2p.direct/ws on a separate TCP port:

{
+ "AutoTLS": { "Enabled": true },
  "Addresses": {
    "Swarm": {
      "/ip4/0.0.0.0/tcp/4001",
+     "/ip4/0.0.0.0/tcp/4002/tls/sni/*.libp2p.direct/ws",
      "/ip6/::/tcp/4001",
+     "/ip6/::/tcp/4002/tls/sni/*.libp2p.direct/ws",

After restarting your node for the first time you may need to wait 5-15 minutes to pass all checks and for the changes to take effect.
We are working on sharing the same TCP port with other transports (go-libp2p#2984).

See AutoTLS configuration for more details how to enable it and what to expect.

This is an early preview, we appreciate you testing and filling bug reports or feedback in the tracking issue at kubo#10560.

📦️ Dependency updates

  • update ipfs-webui to v4.4.0
  • update boxo to v0.24.1 + v0.24.2 + v0.24.3
    • This includes a number of fixes and bitswap improvements, and support for filtering from IPIP-484 in delegated HTTP routing and IPNI queries.
  • update go-libp2p to v0.37.0
    • This update required removal of Swarm.RelayService.MaxReservationsPerPeer configuration option from Kubo. If you had it set, remove it from your configuration file.
  • update go-libp2p-kad-dht to v0.27.0 + v0.28.0
  • update go-libp2p-pubsub to v0.12.0
  • update p2p-forge/client to v0.0.2
  • removed go-homedir
    • The github.com/mitchellh/go-homedir repo is archived, no longer needed, and no longer maintained.
    • homedir.Dir is replaced by the stdlib os.UserHomeDir
    • homedir.Expand is replaced by fsutil.ExpandHome in the github.com/ipfs/kubo/misc/fsutil package.
    • The new github.com/ipfs/kubo/misc/fsutil package contains file utility code previously located elsewhere in kubo.

📝 Changelog

Full Changelog
Read more
Assets 50
Loading

v0.32.0-rc2

08 Nov 00:42
@lidel lidel
v0.32.0-rc2
This tag was signed with the committer’s verified signature.
lidel Marcin Rataj
GPG key ID: 222B6784D5A79E42
Verified
Learn about vigilant mode.
4f06b6a
This commit was signed with the committer’s verified signature.
lidel Marcin Rataj
GPG key ID: 222B6784D5A79E42
Verified
Learn about vigilant mode.
Compare
Choose a tag to compare
v0.32.0-rc2 Pre-release
Pre-release

See the related issue: #10547

And the draft changelog: docs/changelogs/v0.32.md

If you are brave, consider enabling AutoTLS and provide feedback.

Assets 50
Loading

v0.32.0-rc1

30 Oct 18:23
@lidel lidel
v0.32.0-rc1
This tag was signed with the committer’s verified signature.
lidel Marcin Rataj
GPG key ID: 222B6784D5A79E42
Verified
Learn about vigilant mode.
60fa6cd
This commit was signed with the committer’s verified signature.
lidel Marcin Rataj
GPG key ID: 222B6784D5A79E42
Verified
Learn about vigilant mode.
Compare
Choose a tag to compare
v0.32.0-rc1 Pre-release
Pre-release

See the related issue: #10547

And the draft changelog: docs/changelogs/v0.32.md

If you are brave, consider enabling AutoTLS and provide feedback.

Assets 50
Loading

v0.31.0

16 Oct 19:23
@gammazero gammazero
v0.31.0
5a32936
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.
Compare
Choose a tag to compare
v0.31.0

This release was brought to you by the Shipyard team.

Overview

Release v0.31.0 issue #10499

🗣 Discuss

If you have comments, questions, or feedback on this release, please post here.

If you experienced any bugs with the release, please post an issue.

🔦 Highlights

Experimental Pebble Datastore

Pebble visits Kubo

Pebble provides a high-performance alternative to leveldb as the datastore, and provides a modern replacement for legacy badgerv1.

A fresh Kubo node can be initialized with pebbleds profile via ipfs init --profile pebbleds.

There are a number of parameters available for tuning pebble's performance to your specific needs. Default values are used for any parameters that are not configured or are set to their zero-value.
For a description of the available tuning parameters, see kubo/docs/datastores.md#pebbleds.

New metrics

lowpower profile no longer breaks DHT announcements

We've notices users were applying lowpower profile, and then reporting content routing issues. This was because lowpower disabled reprovider system and locally hosted data was no longer announced on Amino DHT.

This release changes lowpower profile to not change reprovider settings, ensuring the new users are not sabotaging themselves. It also adds annouce-on and announce-off profiles for controlling announcement settings separately.

Important

If you've ever applied the lowpower profile before, there is a high chance your node is not announcing to DHT anymore.
If you have Reprovider.Interval set to 0 you may want to set it to 22h (or run ipfs config profile apply announce-on) to fix your system.

As a convenience, ipfs daemon will warn if reprovide system is disabled, creating oportinity to fix configuration if it was not intentional.

go 1.23, boxo 0.24 and go-libp2p 0.36.5

Various bugfixes. Please update.

📝 Changelog

Full Changelog
Read more
Assets 50
Loading