docs: clarify DNS.Resolvers
- document implicit defaults for eth and crypto TLDs - be very honest and link to ToS of cloudflare-eth.com - provide suggestion that one should run own resolver if they really care about decentralization
Marcin Rataj committed
Apr 14, 2021 at 16:45 UTC
35fe392491558bf661153778e47615cb24f27331
1 file changed
+15
-5
docs/config.md
+15
-5
@@ -1440,17 +1440,15 @@ Options for configuring DNS resolution for [DNSLink](https://docs.ipfs.io/concep
1440
1441
Map of [FQDNs](https://en.wikipedia.org/wiki/Fully_qualified_domain_name) to custom resolver URLs.
1442
1443
-- This allows for overriding the default cleartext DNS resolver provided by the operating system,
1444
- and using different resolvers per domain or TLD (including ones from alternative, non-ICANN naming systems).
1445
-- Currently only `https://` URLs for [DNS over HTTPS](https://en.wikipedia.org/wiki/DNS_over_HTTPS) endpoints are supported.
1446
-- The default resolver can be overriden by adding an entry for the DNS root indicated by `.`
1443
+This allows for overriding the default DNS resolver provided by the operating system,
1444
+and using different resolvers per domain or TLD (including ones from alternative, non-ICANN naming systems).
1445
1446
Example:
1447
```json
1448
{
1449
"DNS": {
1450
"Resolvers": {
1453
- "eth.": "https://different-ens.example.net/dns-query",
1451
+ "eth.": "https://eth.link/dns-query",
1452
"crypto.": "https://resolver.unstoppable.io/dns-query",
1453
"libre.": "https://ns1.iriseden.fr/dns-query",
1454
".": "https://doh-ch.blahdns.com:4443/dns-query"
@@ -1459,6 +1457,18 @@ Example:
1457
}
1458
```
1459
1460
+Be mindful that:
1461
+- Currently only `https://` URLs for [DNS over HTTPS (DoH)](https://en.wikipedia.org/wiki/DNS_over_HTTPS) endpoints are supported as values.
1462
+- The default catch-all resolver is the cleartext one provided by your operating system. It can be overriden by adding a DoH entry for the DNS root indicated by `.` as illustrated above.
1463
+- Out-of-the-box support for selected decentralized TLDs relies on a [centralized service which is provided on best-effort basis](https://www.cloudflare.com/distributed-web-gateway-terms/). The implicit DoH resolvers are:
1464
+ ```json
1465
+ {
1466
+ "eth.": "https://resolver.cloudflare-eth.com/dns-query",
1467
+ "crypto.": "https://resolver.cloudflare-eth.com/dns-query
1468
+ }
1469
+ ```
1470
+ To get all the benefits of a decentralized naming system we strongly suggest setting DoH endpoint to an empty string and running own decentralized resolver as catch-all one on localhost.
1471
+
1472
Default: `{}`
1473
1474
Type: `object[string -> string]`