Skip to content

Commit 6a6c35d

Browse files
committed
docs: clarify TTL cap also applies to DNSLink
1 parent f96b6b9 commit 6a6c35d

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

docs/environment-variables.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -80,11 +80,16 @@ Default: `0.3` (always keep 30% of the disk available)
8080

8181
## `RAINBOW_IPNS_MAX_CACHE_TTL`
8282

83-
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/).
83+
When set, it defines the upper bound limit (in ms) of how long a `/ipns/{id}`
84+
lookup result will be cached and read from cache before checking for updates.
8485

85-
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.
86+
The limit is applied to everything under the `/ipns/` namespace, and allows to cap both
87+
the [Time-To-Live (TTL)](https://specs.ipfs.tech/ipns/ipns-record/#ttl-uint64)
88+
of [IPNS Records](https://specs.ipfs.tech/ipns/ipns-record/)
89+
and the [TTL of DNS TXT records](https://datatracker.ietf.org/doc/html/rfc2181#section-8)
90+
with [DNSLink](https://dnslink.dev/).
8691

87-
Default: No upper bound, [TTL from IPNS Record](https://specs.ipfs.tech/ipns/ipns-record/#ttl-uint64)
92+
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.
8893

8994
### `KUBO_RPC_URL`
9095

0 commit comments

Comments
 (0)