Skip to content

Commit 1940803

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

File tree

1 file changed

+12
-5
lines changed

1 file changed

+12
-5
lines changed

docs/environment-variables.md

+12-5
Original file line numberDiff line numberDiff line change
@@ -80,11 +80,18 @@ 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/).
84-
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-
87-
Default: No upper bound, [TTL from IPNS Record](https://specs.ipfs.tech/ipns/ipns-record/#ttl-uint64)
83+
The maximum duration which entries are valid in the name system cache. They are
84+
applied to everything under the `/ipns/` namespace, and allows you to cap both
85+
the [Time-To-Live (TTL)](https://specs.ipfs.tech/ipns/ipns-record/#ttl-uint64)
86+
of [IPNS Records](https://specs.ipfs.tech/ipns/ipns-record/)
87+
and the [TTL of DNS TXT records](https://datatracker.ietf.org/doc/html/rfc2181#section-8)
88+
with [DNSLink](https://dnslink.dev/).
89+
90+
When `RAINBOW_IPNS_MAX_CACHE_TTL` is set, it defines the upper bound limit
91+
of how long a [IPNS Name](https://specs.ipfs.tech/ipns/ipns-record/#ipns-name)
92+
lookup result will be cached and read from cache before checking for updates.
93+
94+
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.
8895

8996
### `KUBO_RPC_URL`
9097

0 commit comments

Comments
 (0)