docs: ipns ttl change

This commit is contained in:
Marcin Rataj 2025-03-14 19:57:34 +01:00
parent ca4b6121ef
commit 180f6224e3
No known key found for this signature in database
GPG Key ID: 222B6784D5A79E42

View File

@ -10,6 +10,7 @@
- [New WebUI features](#new-webui-features)
- [RPC and CLI command changes](#rpc-and-cli-command-changes)
- [Bitswap improvements from Boxo](#bitswap-improvements-from-boxo)
- [IPNS publishing TTL change](#ipns-publishing-ttl-change)
- [`IPFS_LOG_LEVEL` deprecated](#ipfs_log_level-deprecated)
- [Pebble datastore format update](#pebble-datastore-format-update)
- [Badger datastore update](#badger-datastore-update)
@ -60,6 +61,15 @@ The WebUI, accessible at http://127.0.0.1:5001/webui/, now includes support for
This release includes 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](https://github.com/ipfs/boxo/pull/817#pullrequestreview-2587207745), that could previously result in an out of memory condition.
#### IPNS publishing TTL change
Many complaints about IPNS being slow are tied to the default `--ttl` in `ipfs name publish`, which was set to 1 hour. To address this, weve lowered the default [IPNS Record TTL](https://specs.ipfs.tech/ipns/ipns-record/#ttl-uint64) during publishing to 5 minutes, matching similar TTL defaults in DNS. This update is now part of `boxo/ipfs` (GO, [boxo#859](https://github.com/ipfs/boxo/pull/859)) and `@helia/ipns` (JS, [helia#749](https://github.com/ipfs/helia/pull/749)).
> [!TIP]
> IPNS TTL recommendations when even faster update propagation is desired:
> - **As a Publisher:** Lower the `--ttl` (e.g., `ipfs name publish --ttl=1m`) to further reduce caching delays. If using DNSLink, ensure the DNS TXT record TTL matches the IPNS record TTL.
> - **As a Gateway Operator:** Override publisher TTLs for faster updates using configurations like [`Ipns.MaxCacheTTL`](https://github.com/ipfs/kubo/blob/master/docs/config.md#ipnsmaxcachettl) in Kubo or [`RAINBOW_IPNS_MAX_CACHE_TTL`](https://github.com/ipfs/rainbow/blob/main/docs/environment-variables.md#rainbow_ipns_max_cache_ttl) in [Rainbow](https://github.com/ipfs/rainbow/).
#### `IPFS_LOG_LEVEL` deprecated
The variable has been deprecated. Please use [`GOLOG_LOG_LEVEL`](https://github.com/ipfs/kubo/blob/master/docs/environment-variables.md#golog_log_level) instead for configuring logging levels.