From 35fe392491558bf661153778e47615cb24f27331 Mon Sep 17 00:00:00 2001 From: Marcin Rataj Date: Wed, 14 Apr 2021 16:45:32 +0200 Subject: [PATCH] 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 --- docs/config.md | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/docs/config.md b/docs/config.md index dc30d88e2..e41c8b141 100644 --- a/docs/config.md +++ b/docs/config.md @@ -1440,17 +1440,15 @@ Options for configuring DNS resolution for [DNSLink](https://docs.ipfs.io/concep Map of [FQDNs](https://en.wikipedia.org/wiki/Fully_qualified_domain_name) to custom resolver URLs. -- This allows for overriding the default cleartext DNS resolver provided by the operating system, - and using different resolvers per domain or TLD (including ones from alternative, non-ICANN naming systems). -- Currently only `https://` URLs for [DNS over HTTPS](https://en.wikipedia.org/wiki/DNS_over_HTTPS) endpoints are supported. -- The default resolver can be overriden by adding an entry for the DNS root indicated by `.` +This allows for overriding the default DNS resolver provided by the operating system, +and using different resolvers per domain or TLD (including ones from alternative, non-ICANN naming systems). Example: ```json { "DNS": { "Resolvers": { - "eth.": "https://different-ens.example.net/dns-query", + "eth.": "https://eth.link/dns-query", "crypto.": "https://resolver.unstoppable.io/dns-query", "libre.": "https://ns1.iriseden.fr/dns-query", ".": "https://doh-ch.blahdns.com:4443/dns-query" @@ -1459,6 +1457,18 @@ Example: } ``` +Be mindful that: +- Currently only `https://` URLs for [DNS over HTTPS (DoH)](https://en.wikipedia.org/wiki/DNS_over_HTTPS) endpoints are supported as values. +- 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. +- 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: + ```json + { + "eth.": "https://resolver.cloudflare-eth.com/dns-query", + "crypto.": "https://resolver.cloudflare-eth.com/dns-query + } + ``` + 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. + Default: `{}` Type: `object[string -> string]`