From d63ead640d45941222e1489c71d55a716dbc4e76 Mon Sep 17 00:00:00 2001 From: Tom Limoncelli Date: Wed, 2 Feb 2022 10:39:58 -0500 Subject: [PATCH] DOCS: Clarify nameserver examples (#1390) --- docs/index.md | 9 ++++++--- docs/nameservers.md | 22 ++++++++++++++++++++-- 2 files changed, 26 insertions(+), 5 deletions(-) diff --git a/docs/index.md b/docs/index.md index c8187b206..eba1aa4a1 100644 --- a/docs/index.md +++ b/docs/index.md @@ -93,9 +93,6 @@ title: DNSControl
  • Migrating: Migrating zones to DNSControl
    • -
  • - CLI variables: Passing variables from CLI to JS -
    • @@ -144,6 +141,12 @@ title: DNSControl
  • Code Tricks: Safely use macros and loops.
    • +
  • + CLI variables: Passing variables from CLI to JS +
    • +
  • + Nameservers & Delegation: Many examples. +
    • diff --git a/docs/nameservers.md b/docs/nameservers.md index e7b583c6d..ad6e53c8d 100644 --- a/docs/nameservers.md +++ b/docs/nameservers.md @@ -39,13 +39,17 @@ var DNS_BIND = NewDnsProvider("bind", "BIND"); // ========== Domains: -// "Keep it simple": Use the same provider as a registrar and DNS service. +// ========== Same provider for REG and DNS. + +// Keep it simple: Use the same provider as a registrar and DNS service. // Why? Simplicity. D("example1.com", REG_NAMECOM, DnsProvider(DNS_NAMECOM), A("@", "10.2.3.4") ); +// ========== Different provider for REG and DNS. + // "Separate DNS server": Use one provider as registrar, a different for DNS service. // Why? Use any registrar but a preferred DNS provider. // This is the most common situation. @@ -54,7 +58,9 @@ D("example1.com", REG_NAMECOM, A("@", "10.2.3.4") ); -// Let someone else manage the NS records for a dommain. +// ========== Registrar is elsewhere. + +// "DNS only": Let someone else manage the NS records for a dommain. // Why? Because you don't have access to the registrar, or the registrar is not // supported by DNSControl. However you do have API access for // updating the zone's records (most likely at a different provider). @@ -63,6 +69,8 @@ D("example1.com", REG_THIRDPARTY, A("@", "10.2.3.4") ); +// ========== Zone is elsewhere. + // "Registrar only": Direct the registrar to point to some other DNS provider. // Why? In this example we're pointing the domain to the nsone.net DNS // service, which someone else is controlling. @@ -73,6 +81,8 @@ D("example1.com", REG_NAMECOM, NAMESERVER("dns4.p03.nsone.net."), ); +// ========== Override nameservers. + // "Custom nameservers": Ignore the provider's default nameservers and substitute our own. // Why? Rarely used unless the DNS provider's API does not support // querying what the nameservers are, or the API is returning invalid @@ -84,6 +94,8 @@ D("example1.com", REG_NAMECOM, A("@", "10.2.3.4") ); +// ========== Add nameservers. + // "Add additional nameservers." Use the default nameservers from the registrar but add additional ones. // Why? Usually only to correct a bug or misconfiguration elsewhere. D("example1.com", REG_NAMECOM, @@ -92,6 +104,8 @@ D("example1.com", REG_NAMECOM, A("@", "10.2.3.4") ); +// ========== Shadow nameservers. + // "Shadow DNS servers." Secretly send your DNS records to another server. // Why? Many possibilities: / * You are preparing to move to a different DNS provider and want to test it before you cut over. @@ -104,6 +118,8 @@ D("example1.com", REG_NAMECOM, A("@", "10.2.3.4") ); +// ========== Backup your zone. + // "Zonefile backups." Make backups of the exact DNS records in zone-file format. // Why? In addition to the usual configuration, write out a BIND-style // zonefile perhaps for debugging, historical, or auditing purposes. @@ -114,6 +130,8 @@ D("example1.com", REG_NAMECOM, A("@", "10.2.3.4") ); +// ========== Dual DNS Providers. + // "Dual DNS Providers": Use two different DNS services: // Why? Diversity. If one DNS provider goes down, the other will be used. // Little known fact: Most DNS recursive resolvers monitor which DNS