mirror/stackexchange-dnscontrol
1
0
Fork 0
mirror of https://github.com/StackExchange/dnscontrol.git synced 2024-05-11 05:55:12 +00:00
Code Issues Releases Activity

DOCS: Improve consistency in code examples in language reference (#2439)

Browse Source 
Co-authored-by: Tom Limoncelli <tal@whatexit.org>
This commit is contained in:
Jeffrey Cafferata
2023-06-17 14:58:17 +02:00
committed by GitHub
parent 0bf24d0282
commit 7977a7b81c
58 changed files with 115 additions and 115 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
documentation/providers/autodns.md
View File

@@ -27,7 +27,7 @@ An example configuration:
var REG_NONE = NewRegistrar("none");
var DSP_AUTODNS = NewDnsProvider("autodns");
D("example.tld", REG_NONE, DnsProvider(DSP_AUTODNS),
D("example.com", REG_NONE, DnsProvider(DSP_AUTODNS),
A("test", "1.2.3.4")
);
```

16
documentation/providers/axfrddns.md
View File

@@ -92,10 +92,10 @@ the later allows `get-zones` to work properly.
```javascript
var DSP_AXFRDDNS = NewDnsProvider("axfrddns", {
"default_ns": [
"ns1.example.tld.",
"ns2.example.tld.",
"ns3.example.tld.",
"ns4.example.tld."
"ns1.example.com.",
"ns2.example.com.",
"ns3.example.com.",
"ns4.example.com."
]
}
}
@@ -107,7 +107,7 @@ var DSP_AXFRDDNS = NewDnsProvider("axfrddns", {
{
"axfrddns": {
"TYPE": "AXFRDDNS",
"nameservers": "ns1.example.tld.,ns2.example.tld.,ns3.example.tld.,ns4.example.tld."
"nameservers": "ns1.example.com.,ns2.example.com.,ns3.example.com.,ns4.example.com."
}
}
```
@@ -191,7 +191,7 @@ D("example.com", REG_NONE, DnsProvider(DNS),
### Bind9
Here is a sample `named.conf` example for an authauritative server on
zone `example.tld`. It uses a simple IP-based ACL for the AXFR
zone `example.com`. It uses a simple IP-based ACL for the AXFR
transfer and a conjunction of TSIG and IP-based ACL for the updates.
{% code title="named.conf" %}
@@ -210,9 +210,9 @@ options {
};
zone "example.tld" {
zone "example.com" {
type master;
file "/etc/bind/db.example.tld";
file "/etc/bind/db.example.com";
allow-transfer { example-transfer; };
allow-update { example-update; };
};

2
documentation/providers/azure_dns.md
View File

@@ -56,7 +56,7 @@ An example configuration:
var REG_NONE = NewRegistrar("none");
var DSP_AZURE_MAIN = NewDnsProvider("azuredns_main");
D("example.tld", REG_NONE, DnsProvider(DSP_AZURE_MAIN),
D("example.com", REG_NONE, DnsProvider(DSP_AZURE_MAIN),
A("test", "1.2.3.4")
);
```

14
documentation/providers/bind.md
View File

@@ -41,18 +41,18 @@ In this example we set the default SOA settings and NS records.
```javascript
var DSP_BIND = NewDnsProvider("bind", {
"default_soa": {
"master": "ns1.example.tld.",
"mbox": "spamtrap.example.tld.",
"master": "ns1.example.com.",
"mbox": "spamtrap.example.com.",
"refresh": 3600,
"retry": 600,
"expire": 604800,
"minttl": 1440,
},
"default_ns": [
"ns1.example.tld.",
"ns2.example.tld.",
"ns3.example.tld.",
"ns4.example.tld."
"ns1.example.com.",
"ns2.example.com.",
"ns3.example.com.",
"ns4.example.com."
]
})
```
@@ -109,7 +109,7 @@ Typical values:
* `db_example.com`
The last example will generate the same name for both
`D("example.tld!inside")` and `D("example.tld!outside")`. This
`D("example.com!inside")` and `D("example.com!outside")`. This
assumes two BIND providers are configured in `creds.json`, each with
a different `directory` setting. Otherwise `dnscontrol` will write
both domains to the same file, flapping between the two back and

8
documentation/providers/cloudflareapi.md
View File

@@ -158,7 +158,7 @@ The following example shows how to set meta variables with and without aliases:
var REG_NONE = NewRegistrar("none");
var DSP_CLOUDFLARE = NewDnsProvider("cloudflare");
D("example.tld", REG_NONE, DnsProvider(DSP_CLOUDFLARE),
D("example.com", REG_NONE, DnsProvider(DSP_CLOUDFLARE),
A("www1","1.2.3.11", CF_PROXY_ON), // turn proxy ON.
A("www2","1.2.3.12", CF_PROXY_OFF), // default is OFF, this is a no-op.
A("www3","1.2.3.13", {"cloudflare_proxy": "on"}) // Old format.
@@ -175,12 +175,12 @@ var REG_NONE = NewRegistrar("none");
var DSP_CLOUDFLARE = NewDnsProvider("cloudflare");
// Example domain where the CF proxy abides by the default (off).
D("example.tld", REG_NONE, DnsProvider(DSP_CLOUDFLARE),
D("example.com", REG_NONE, DnsProvider(DSP_CLOUDFLARE),
A("proxied", "1.2.3.4", CF_PROXY_ON),
A("notproxied", "1.2.3.5"),
A("another", "1.2.3.6", CF_PROXY_ON),
ALIAS("@", "www.example.tld.", CF_PROXY_ON),
CNAME("myalias", "www.example.tld.", CF_PROXY_ON)
ALIAS("@", "www.example.com.", CF_PROXY_ON),
CNAME("myalias", "www.example.com.", CF_PROXY_ON)
);
// Example domain where the CF proxy default is set to "on":

4
documentation/providers/cloudns.md
View File

@@ -40,7 +40,7 @@ Simply use the `CLOUDNS_WR` functions to make redirects like any other record:
var REG_NONE = NewRegistrar("none");
var DSP_CLOUDNS = NewDnsProvider("cloudns");
D("example.tld", REG_NONE, DnsProvider(DSP_CLOUDNS),
D("example.com", REG_NONE, DnsProvider(DSP_CLOUDNS),
CLOUDNS_WR("@", "http://example.com/"),
CLOUDNS_WR("www", "http://example.com/")
)
@@ -55,7 +55,7 @@ An example configuration:
var REG_NONE = NewRegistrar("none");
var DSP_CLOUDNS = NewDnsProvider("cloudns");
D("example.tld", REG_NONE, DnsProvider(DSP_CLOUDNS),
D("example.com", REG_NONE, DnsProvider(DSP_CLOUDNS),
A("test", "1.2.3.4")
);
```

4
documentation/providers/cscglobal.md
View File

@@ -22,7 +22,7 @@ Example:
"TYPE": "CSCGLOBAL",
"api-key": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"user-token": "yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy",
"notification_emails": "test@example.tld,hostmaster@example.tld"
"notification_emails": "test@example.com,hostmaster@example.com"
}
}
```
@@ -36,7 +36,7 @@ An example configuration:
var REG_CSCGLOBAL = NewRegistrar("cscglobal");
var DSP_BIND = NewDnsProvider("bind");
D("example.tld", REG_CSCGLOBAL, DnsProvider(DSP_BIND),
D("example.com", REG_CSCGLOBAL, DnsProvider(DSP_BIND),
A("test", "1.2.3.4")
);
```

2
documentation/providers/desec.md
View File

@@ -27,7 +27,7 @@ An example configuration:
var REG_NONE = NewRegistrar("none");
var DSP_DESEC = NewDnsProvider("desec");
D("example.tld", REG_NONE, DnsProvider(DSP_DESEC),
D("example.com", REG_NONE, DnsProvider(DSP_DESEC),
A("test", "1.2.3.4")
);
```

2
documentation/providers/digitalocean.md
View File

@@ -27,7 +27,7 @@ An example configuration:
var REG_NONE = NewRegistrar("none");
var DSP_DIGITALOCEAN = NewDnsProvider("mydigitalocean");
D("example.tld", REG_NONE, DnsProvider(DSP_DIGITALOCEAN),
D("example.com", REG_NONE, DnsProvider(DSP_DIGITALOCEAN),
A("test", "1.2.3.4")
);
```

2
documentation/providers/dnsimple.md
View File

@@ -34,7 +34,7 @@ An example configuration:
var REG_DNSIMPLE = NewRegistrar("dnsimple");
var DSP_DNSIMPLE = NewDnsProvider("dnsimple");
D("example.tld", REG_DNSIMPLE, DnsProvider(DSP_DNSIMPLE),
D("example.com", REG_DNSIMPLE, DnsProvider(DSP_DNSIMPLE),
A("test", "1.2.3.4")
);
```

2
documentation/providers/dnsmadeeasy.md
View File

@@ -36,7 +36,7 @@ An example configuration:
var REG_NONE = NewRegistrar("none");
var DSP_DNSMADEEASY = NewDnsProvider("dnsmadeeasy");
D("example.tld", REG_NONE, DnsProvider(DSP_DNSMADEEASY),
D("example.com", REG_NONE, DnsProvider(DSP_DNSMADEEASY),
A("test", "1.2.3.4")
);
```

2
documentation/providers/domainnameshop.md
View File

@@ -28,7 +28,7 @@ An example configuration:
var REG_NONE = NewRegistrar("none");
var DSP_DOMAINNAMESHOP = NewDnsProvider("mydomainnameshop");
D("example.tld", REG_NONE, DnsProvider(DSP_DOMAINNAMESHOP),
D("example.com", REG_NONE, DnsProvider(DSP_DOMAINNAMESHOP),
A("test", "1.2.3.4")
);
```

2
documentation/providers/gandi_v5.md
View File

@@ -58,7 +58,7 @@ An example configuration:
var REG_GANDI = NewRegistrar("gandi");
var DSP_GANDI = NewDnsProvider("gandi");
D("example.tld", REG_GANDI, DnsProvider(DSP_GANDI),
D("example.com", REG_GANDI, DnsProvider(DSP_GANDI),
A("test", "1.2.3.4")
);
```

2
documentation/providers/gcloud.md
View File

@@ -64,7 +64,7 @@ An example configuration:
var REG_NAMECOM = NewRegistrar("name.com");
var DSP_GCLOUD = NewDnsProvider("gcloud");
D("example.tld", REG_NAMECOM, DnsProvider(DSP_GCLOUD),
D("example.com", REG_NAMECOM, DnsProvider(DSP_GCLOUD),
A("test", "1.2.3.4")
);
```

2
documentation/providers/gcore.md
View File

@@ -27,7 +27,7 @@ An example configuration:
var REG_NONE = NewRegistrar("none");
var DSP_GCORE = NewDnsProvider("gcore");
D("example.tld", REG_NONE, DnsProvider(DSP_GCORE),
D("example.com", REG_NONE, DnsProvider(DSP_GCORE),
A("test", "1.2.3.4")
);
```

2
documentation/providers/hedns.md
View File

@@ -110,7 +110,7 @@ An example configuration:
var REG_NONE = NewRegistrar("none");
var DSP_HEDNS = NewDnsProvider("hedns");
D("example.tld", REG_NONE, DnsProvider(DSP_HEDNS),
D("example.com", REG_NONE, DnsProvider(DSP_HEDNS),
A("test", "1.2.3.4")
);
```

2
documentation/providers/hetzner.md
View File

@@ -30,7 +30,7 @@ An example configuration:
var REG_NONE = NewRegistrar("none");
var DSP_HETZNER = NewDnsProvider("hetzner");
D("example.tld", REG_NONE, DnsProvider(DSP_HETZNER),
D("example.com", REG_NONE, DnsProvider(DSP_HETZNER),
A("test", "1.2.3.4")
);
```

6
documentation/providers/hexonet.md
View File

@@ -73,8 +73,8 @@ You are free to decide if you want to use both of our provider technology or jus
{% code title="dnsconfig.js" %}
```javascript
var REG_HX = NewRegistrar("hexonet");
var DSP_HX = NewDnsProvider("hexonet");
var REG_HEXONET = NewRegistrar("hexonet");
var DSP_HEXONET = NewDnsProvider("hexonet");
// Set Default TTL for all RR to reflect our Backend API Default
// If you use additional DNS Providers, configure a default TTL
@@ -85,7 +85,7 @@ DEFAULTS(
DefaultTTL(3600)
);
D("abhoster.com", REG_HX, DnsProvider(DSP_HX),
D("example.com", REG_HEXONET, DnsProvider(DSP_HEXONET),
NAMESERVER("ns1.ispapi.net"),
NAMESERVER("ns2.ispapi.net"),
NAMESERVER("ns3.ispapi.net"),

2
documentation/providers/hostingde.md
View File

@@ -25,7 +25,7 @@ An example configuration:
var REG_HOSTINGDE = NewRegistrar("hosting.de");
var DSP_HOSTINGDE = NewDnsProvider("hosting.de");
D("example.tld", REG_HOSTINGDE, DnsProvider(DSP_HOSTINGDE),
D("example.com", REG_HOSTINGDE, DnsProvider(DSP_HOSTINGDE),
A("test", "1.2.3.4")
);
```

4
documentation/providers/inwx.md
View File

@@ -99,7 +99,7 @@ INWX.
## Usage
An example `dnsconfig.js` configuration file
for `example.tld` registered with INWX
for `example.com` registered with INWX
and delegated to Cloudflare:
{% code title="dnsconfig.js" %}
@@ -107,7 +107,7 @@ and delegated to Cloudflare:
var REG_INWX = NewRegistrar("inwx");
var DSP_CF = NewDnsProvider("cloudflare");
D("example.tld", REG_INWX, DnsProvider(DSP_CF),
D("example.com", REG_INWX, DnsProvider(DSP_CF),
A("test", "1.2.3.4")
);
```

2
documentation/providers/linode.md
View File

@@ -27,7 +27,7 @@ An example configuration:
var REG_NONE = NewRegistrar("none");
var DSP_LINODE = NewDnsProvider("linode");
D("example.tld", REG_NONE, DnsProvider(DSP_LINODE),
D("example.com", REG_NONE, DnsProvider(DSP_LINODE),
A("test", "1.2.3.4")
);
```

2
documentation/providers/luadns.md
View File

@@ -28,7 +28,7 @@ An example configuration:
var REG_NONE = NewRegistrar("none");
var DSP_LUADNS = NewDnsProvider("luadns");
D("example.tld", REG_NONE, DnsProvider(DSP_LUADNS),
D("example.com", REG_NONE, DnsProvider(DSP_LUADNS),
A("test", "1.2.3.4")
);
```

2
documentation/providers/msdns.md
View File

@@ -57,7 +57,7 @@ An example DNS configuration:
var REG_NONE = NewRegistrar("none");
var DSP_MSDNS = NewDnsProvider("msdns");
D("example.tld", REG_NONE, DnsProvider(DSP_MSDNS),
D("example.com", REG_NONE, DnsProvider(DSP_MSDNS),
A("test", "1.2.3.4")
)
```

4
documentation/providers/namecheap.md
View File

@@ -50,7 +50,7 @@ An example configuration:
var REG_NAMECHEAP = NewRegistrar("namecheap");
var DSP_BIND = NewDnsProvider("bind");
D("example.tld", REG_NAMECHEAP, DnsProvider(DSP_BIND),
D("example.com", REG_NAMECHEAP, DnsProvider(DSP_BIND),
A("test", "1.2.3.4")
);
```
@@ -64,7 +64,7 @@ records can be used like any other record:
var REG_NAMECHEAP = NewRegistrar("namecheap");
var DSP_NAMECHEAP = NewDnsProvider("namecheap");
D("example.tld", REG_NAMECHEAP, DnsProvider(DSP_NAMECHEAP),
D("example.com", REG_NAMECHEAP, DnsProvider(DSP_NAMECHEAP),
URL("@", "http://example.com/"),
URL("www", "http://example.com/"),
URL301("backup", "http://backup.example.com/")

4
documentation/providers/namedotcom.md
View File

@@ -43,7 +43,7 @@ as the registrar and DNS service provider:
var REG_NAMECOM = NewRegistrar("name.com");
var DSP_NAMECOM = NewDnsProvider("name.com");
D("example.tld", REG_NAMECOM, DnsProvider(DSP_NAMECOM),
D("example.com", REG_NAMECOM, DnsProvider(DSP_NAMECOM),
A("test", "1.2.3.4")
);
```
@@ -57,7 +57,7 @@ as the registrar and DNS only, DNS hosted elsewhere:
var REG_NAMECOM = NewRegistrar("name.com");
var DSP_R53 = NewDnsProvider("r53");
D("example.tld", REG_NAMECOM, DnsProvider(DSP_R53),
D("example.com", REG_NAMECOM, DnsProvider(DSP_R53),
A("test","1.2.3.4")
);
```

2
documentation/providers/netcup.md
View File

@@ -26,7 +26,7 @@ An example configuration:
var REG_NONE = NewRegistrar("none");
var DSP_NETCUP = NewDnsProvider("netcup");
D("example.tld", REG_NONE, DnsProvider(DSP_NETCUP),
D("example.com", REG_NONE, DnsProvider(DSP_NETCUP),
A("test", "1.2.3.4")
);
```

2
documentation/providers/netlify.md
View File

@@ -29,7 +29,7 @@ An example configuration:
var REG_NETLIFY = NewRegistrar("netlify");
var DSP_NETLIFY = NewDnsProvider("netlify");
D("example.tld", REG_NETLIFY, DnsProvider(DSP_NETLIFY),
D("example.com", REG_NETLIFY, DnsProvider(DSP_NETLIFY),
A("test", "1.2.3.4")
);
```

2
documentation/providers/ns1.md
View File

@@ -27,7 +27,7 @@ An example configuration:
var REG_NONE = NewRegistrar("none");
var DSP_NS1 = NewDnsProvider("ns1");
D("example.tld", REG_NONE, DnsProvider(DSP_NS1),
D("example.com", REG_NONE, DnsProvider(DSP_NS1),
A("test", "1.2.3.4")
);
```

2
documentation/providers/oracle.md
View File

@@ -35,7 +35,7 @@ An example configuration:
var REG_NONE = NewRegistrar("none");
var DSP_ORACLE = NewDnsProvider("oracle");
D("example.tld", REG_NONE, DnsProvider(DSP_ORACLE),
D("example.com", REG_NONE, DnsProvider(DSP_ORACLE),
NAMESERVER_TTL(86400),
A("test", "1.2.3.4")

4
documentation/providers/ovh.md
View File

@@ -33,7 +33,7 @@ An example configuration: (DNS hosted with OVH):
var REG_OVH = NewRegistrar("ovh");
var DSP_OVH = NewDnsProvider("ovh");
D("example.tld", REG_OVH, DnsProvider(DSP_OVH),
D("example.com", REG_OVH, DnsProvider(DSP_OVH),
A("test", "1.2.3.4")
);
```
@@ -46,7 +46,7 @@ An example configuration: (Registrar only. DNS hosted elsewhere)
var REG_OVH = NewRegistrar("ovh");
var DSP_R53 = NewDnsProvider("r53");
D("example.tld", REG_OVH, DnsProvider(DSP_R53),
D("example.com", REG_OVH, DnsProvider(DSP_R53),
A("test", "1.2.3.4")
);
```

2
documentation/providers/packetframe.md
View File

@@ -27,7 +27,7 @@ An example configuration:
var REG_NONE = NewRegistrar("none");
var DSP_PACKETFRAME = NewDnsProvider("packetframe");
D("example.tld", REG_NONE, DnsProvider(DSP_PACKETFRAME),
D("example.com", REG_NONE, DnsProvider(DSP_PACKETFRAME),
A("test", "1.2.3.4")
);
```

2
documentation/providers/porkbun.md
View File

@@ -30,7 +30,7 @@ An example configuration:
var REG_NONE = NewRegistrar("none");
var DSP_PORKBUN = NewDnsProvider("porkbun");
D("example.tld", REG_NONE, DnsProvider(DSP_PORKBUN),
D("example.com", REG_NONE, DnsProvider(DSP_PORKBUN),
A("test", "1.2.3.4")
);
```

2
documentation/providers/powerdns.md
View File

@@ -51,7 +51,7 @@ An example configuration:
var REG_NONE = NewRegistrar("none");
var DSP_POWERDNS = NewDnsProvider("powerdns");
D("example.tld", REG_NONE, DnsProvider(DSP_POWERDNS),
D("example.com", REG_NONE, DnsProvider(DSP_POWERDNS),
A("test", "1.2.3.4")
);
```

2
documentation/providers/route53.md
View File

@@ -72,7 +72,7 @@ An example configuration:
var REG_NONE = NewRegistrar("none");
var DSP_R53 = NewDnsProvider("r53_main");
D("example.tld", REG_NONE, DnsProvider(DSP_R53),
D("example.com", REG_NONE, DnsProvider(DSP_R53),
A("test", "1.2.3.4")
);
```

4
documentation/providers/softlayer.md
View File

@@ -35,7 +35,7 @@ An example configuration:
var REG_NONE = NewRegistrar("none");
var DSP_SOFTLAYER = NewDnsProvider("softlayer");
D("example.tld", registrary, DnsProvider(DSP_SOFTLAYER),
D("example.com", REG_NONE, DnsProvider(DSP_SOFTLAYER),
A("test", "1.2.3.4")
);
```
@@ -50,7 +50,7 @@ For compatibility with the pre-generated NAMESERVER fields it's recommended to s
var REG_NONE = NewRegistrar("none");
var DSP_SOFTLAYER = NewDnsProvider("softlayer");
D("example.tld", REG_NONE, DnsProvider(SOFTLAYER),
D("example.com", REG_NONE, DnsProvider(SOFTLAYER),
NAMESERVER_TTL(86400),
A("test", "1.2.3.4")

2
documentation/providers/transip.md
View File

@@ -50,7 +50,7 @@ An example configuration:
var REG_NONE = NewRegistrar("none");
var DSP_TRANSIP = NewDnsProvider("transip");
D("example.tld", REG_NONE, DnsProvider(DSP_TRANSIP),
D("example.com", REG_NONE, DnsProvider(DSP_TRANSIP),
A("test", "1.2.3.4")
);
```

2
documentation/providers/vultr.md
View File

@@ -28,7 +28,7 @@ An example configuration:
```javascript
var DSP_VULTR = NewDnsProvider("vultr");
D("example.tld", REG_DNSIMPLE, DnsProvider(DSP_VULTR),
D("example.com", REG_DNSIMPLE, DnsProvider(DSP_VULTR),
A("test", "1.2.3.4")
);
```