1
0
mirror of https://github.com/StackExchange/dnscontrol.git synced 2024-05-11 05:55:12 +00:00

Improved consistency of provider documentation (#222)

- Fixed indentation
- Use same naming scheme for all examples
  (i.e. all caps for provider, REG prefix for registrar)
- Use REG_NONE as registrar when provider does not provide it
- Use example.tld for example domain
- Use 1.2.3.1/24 IP range for examples
- A few spelling fixes
This commit is contained in:
Patrick G
2017-10-11 08:33:52 -04:00
committed by Tom Limoncelli
parent a202b8ae53
commit 31bdb65720
11 changed files with 53 additions and 50 deletions

View File

@@ -15,7 +15,7 @@ In your credentials file (`creds.json`), you can specify a `directory` where the
{% highlight javascript %}
{
"bind":{
"bind": {
"directory": "myzones"
}
}
@@ -24,21 +24,21 @@ In your credentials file (`creds.json`), you can specify a `directory` where the
The BIND provider does not require anything in `creds.json`. It does accept some (optional) metadata via your dns config when you create the provider:
{% highlight javascript %}
var bind = NewDnsProvider('bind', 'BIND', {
'default_soa': {
'master': 'ns1.mydomain.com.',
'mbox': 'sysadmin.mydomain.com.',
'refresh': 3600,
'retry': 600,
'expire': 604800,
'minttl': 1440,
},
'default_ns': [
'ns1.mydomain.com.',
'ns2.mydomain.com.',
'ns3.mydomain.com.',
'ns4.mydomain.com.'
]
var BIND = NewDnsProvider('bind', 'BIND', {
'default_soa': {
'master': 'ns1.example.tld.',
'mbox': 'sysadmin.example.tld.',
'refresh': 3600,
'retry': 600,
'expire': 604800,
'minttl': 1440,
},
'default_ns': [
'ns1.example.tld.',
'ns2.example.tld.',
'ns3.example.tld.',
'ns4.example.tld.'
]
})
{% endhighlight %}