From 194080349c9fa1c529b5f69768fe78e478a4f6b8 Mon Sep 17 00:00:00 2001 From: Marcin Rataj Date: Mon, 19 Feb 2024 22:43:05 +0100 Subject: [PATCH] docs: clarify TTL cap also applies to DNSLink --- docs/environment-variables.md | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/docs/environment-variables.md b/docs/environment-variables.md index 315d84f..6e8ebef 100644 --- a/docs/environment-variables.md +++ b/docs/environment-variables.md @@ -80,11 +80,18 @@ Default: `0.3` (always keep 30% of the disk available) ## `RAINBOW_IPNS_MAX_CACHE_TTL` -The maximum duration which entries are valid in the name system cache. They are applied to everything under the `/ipns/` namespace, and allows you to cap the [Time-To-Live (TTL)](https://specs.ipfs.tech/ipns/ipns-record/#ttl-uint64) of [IPNS Records](https://specs.ipfs.tech/ipns/ipns-record/). - -When `RAINBOW_IPNS_MAX_CACHE_TTL` is set, it defines the upper bound limit of how long a [IPNS Name](https://specs.ipfs.tech/ipns/ipns-record/#ipns-name) lookup result will be cached and read from cache before checking for updates. - -Default: No upper bound, [TTL from IPNS Record](https://specs.ipfs.tech/ipns/ipns-record/#ttl-uint64) +The maximum duration which entries are valid in the name system cache. They are +applied to everything under the `/ipns/` namespace, and allows you to cap both +the [Time-To-Live (TTL)](https://specs.ipfs.tech/ipns/ipns-record/#ttl-uint64) +of [IPNS Records](https://specs.ipfs.tech/ipns/ipns-record/) +and the [TTL of DNS TXT records](https://datatracker.ietf.org/doc/html/rfc2181#section-8) +with [DNSLink](https://dnslink.dev/). + +When `RAINBOW_IPNS_MAX_CACHE_TTL` is set, it defines the upper bound limit +of how long a [IPNS Name](https://specs.ipfs.tech/ipns/ipns-record/#ipns-name) +lookup result will be cached and read from cache before checking for updates. + +Default: No upper bound, [TTL from IPNS Record](https://specs.ipfs.tech/ipns/ipns-record/#ttl-uint64) or [TTL from DNSLink](https://datatracker.ietf.org/doc/html/rfc2181#section-8) used as-is. ### `KUBO_RPC_URL`