mirror of
https://github.com/StackExchange/dnscontrol.git
synced 2024-05-11 05:55:12 +00:00
DOCS: Fix many spelling errors (#471)
This commit is contained in:
committed by
Craig Peterson
parent
ebe00625a3
commit
5044695ffe
@ -10,7 +10,7 @@ A adds an A record To a domain. The name should be the relative label for the re
|
||||
|
||||
The address should be an ip address, either a string, or a numeric value obtained via [IP](#IP).
|
||||
|
||||
Modifers can be any number of [record modifiers](#record-modifiers) or json objects, which will be merged into the record's metadata.
|
||||
Modifiers can be any number of [record modifiers](#record-modifiers) or json objects, which will be merged into the record's metadata.
|
||||
|
||||
{% include startExample.html %}
|
||||
{% highlight js %}
|
||||
|
@ -8,9 +8,9 @@ parameters:
|
||||
|
||||
AAAA adds an AAAA record To a domain. The name should be the relative label for the record. Use `@` for the domain apex.
|
||||
|
||||
The address should be an ipv6 address as a string.
|
||||
The address should be an IPv6 address as a string.
|
||||
|
||||
Modifers can be any number of [record modifiers](#record-modifiers) or json objects, which will be merged into the record's metadata.
|
||||
Modifiers can be any number of [record modifiers](#record-modifiers) or json objects, which will be merged into the record's metadata.
|
||||
|
||||
{% include startExample.html %}
|
||||
{% highlight js %}
|
||||
|
@ -6,7 +6,7 @@ parameters:
|
||||
- modifiers...
|
||||
---
|
||||
|
||||
ALIAS is a virtual record type that points a record at another record. It is analagous to a CNAME, but is usually resolved at request-time and served as an A record. Unlike CNAMEs, ALIAS records can be used at the zone apex (`@`)
|
||||
ALIAS is a virtual record type that points a record at another record. It is analogous to a CNAME, but is usually resolved at request-time and served as an A record. Unlike CNAMEs, ALIAS records can be used at the zone apex (`@`)
|
||||
|
||||
Different providers handle ALIAS records differently, and many do not support it at all. Attempting to use ALIAS records with a DNS provider type that does not support them will result in an error.
|
||||
|
||||
|
@ -11,7 +11,7 @@ CAA adds a CAA record to a domain. The name should be the relative label for the
|
||||
|
||||
Tag can be one of "issue", "issuewild" or "iodef".
|
||||
|
||||
Value is a string. The format of the contents is different depending on the tag. DNSControl will handle any escaping or quoting required, similer to TXT records. For example use `CAA("@", "issue", "letsencrypt.org")` rather than `CAA("@", "issue", "\"letsencrypt.org\"")`.
|
||||
Value is a string. The format of the contents is different depending on the tag. DNSControl will handle any escaping or quoting required, similar to TXT records. For example use `CAA("@", "issue", "letsencrypt.org")` rather than `CAA("@", "issue", "\"letsencrypt.org\"")`.
|
||||
|
||||
Flags are controlled by modifier.:
|
||||
|
||||
|
@ -5,7 +5,7 @@ parameters:
|
||||
- nsCount
|
||||
---
|
||||
|
||||
DnsProvider indicates that the specifid provider should be used to manage
|
||||
DnsProvider indicates that the specified provider should be used to manage
|
||||
records for this domain. The name must match the name used with [NewDnsProvider](#NewDnsProvider).
|
||||
|
||||
The nsCount parameter determines how the nameservers will be managed from this provider.
|
||||
|
@ -5,7 +5,7 @@ name: IGNORE
|
||||
IGNORE can be used to ignore some records presents in zone.
|
||||
All records (independently of their type) of that name will be completely ignored.
|
||||
|
||||
IGNORE is like NO_PURGE except it acts only on some specific records intead of the whole zone.
|
||||
IGNORE is like NO_PURGE except it acts only on some specific records instead of the whole zone.
|
||||
|
||||
IGNORE is generally used in very specific situations:
|
||||
|
||||
|
@ -81,5 +81,5 @@ D(REV('2001:db8:302::/48'), REGISTRAR, DnsProvider(BIND),
|
||||
{% include endExample.html %}
|
||||
|
||||
In the future we plan on adding a flag to `A()` which will insert
|
||||
the correct PTR() record if the approprate `.arpa` domain has been
|
||||
the correct PTR() record if the appropriate `.arpa` domain has been
|
||||
defined.
|
||||
|
@ -6,7 +6,7 @@ parameters:
|
||||
- ZONE_ID modifier
|
||||
---
|
||||
|
||||
R53_ALIAS is a Route53 specific virtual record type that points a record at either another record or an AWS entity (like a Cloudfront distribution, an ELB, etc...). It is analagous to a CNAME, but is usually resolved at request-time and served as an A record. Unlike CNAMEs, ALIAS records can be used at the zone apex (`@`)
|
||||
R53_ALIAS is a Route53 specific virtual record type that points a record at either another record or an AWS entity (like a Cloudfront distribution, an ELB, etc...). It is analogous to a CNAME, but is usually resolved at request-time and served as an A record. Unlike CNAMEs, ALIAS records can be used at the zone apex (`@`)
|
||||
|
||||
Unlike the regular ALIAS directive, R53_ALIAS is only supported on Route53. Attempting to use R53_ALIAS on another provider than Route53 will result in an error.
|
||||
|
||||
@ -16,7 +16,7 @@ Target should be a string representing the target. If it is a single label we wi
|
||||
|
||||
The Target can be any of:
|
||||
|
||||
* _CloudFront distribution_: in this case specify the domain name that CloudFront assigned whenyou created your distribution (note that your CloudFront distribution must include an alternante domain name that matches the record you're adding)
|
||||
* _CloudFront distribution_: in this case specify the domain name that CloudFront assigned when you created your distribution (note that your CloudFront distribution must include an alternate domain name that matches the record you're adding)
|
||||
* _Elastic Beanstalk environment_: specify the CNAME attribute for the environment. The environment must have a regionalized domain name. To get the CNAME, you can use either the [AWS Console](http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/customdomains.html), [AWS Elastic Beanstalk API](http://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_DescribeEnvironments.html), or the [AWS CLI](http://docs.aws.amazon.com/cli/latest/reference/elasticbeanstalk/describe-environments.html).
|
||||
* _ELB load balancer_: specify the DNS name that is associated with the load balancer. To get the DNS name you can use either the AWS Console (on the EC2 page, choose Load Balancers, select the right one, choose the description tab), [ELB API](http://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html), the [AWS ELB CLI](http://docs.aws.amazon.com/cli/latest/reference/elb/describe-load-balancers.html), or the [AWS ELBv2 CLI](http://docs.aws.amazon.com/cli/latest/reference/elbv2/describe-load-balancers.html).
|
||||
* _S3 bucket_ (configured as website): specify the domain name of the Amazon S3 website endpoint in which you configured the bucket (for instance s3-website-us-east-2.amazonaws.com). For the available values refer to the [Amazon S3 Website Endpoints](http://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region).
|
||||
|
@ -20,7 +20,7 @@ Each string is a JavaScript string (quoted using single or double
|
||||
quotes). The (somewhat complex) quoting rules of the DNS protocol
|
||||
will be done for you.
|
||||
|
||||
Modifers can be any number of [record modifiers](#record-modifiers) or json objects, which will be merged into the record's metadata.
|
||||
Modifiers can be any number of [record modifiers](#record-modifiers) or json objects, which will be merged into the record's metadata.
|
||||
|
||||
{% include startExample.html %}
|
||||
{% highlight js %}
|
||||
|
@ -14,7 +14,7 @@ Modifier arguments are processed according to type as follows:
|
||||
|
||||
- A function argument will be called with the domain object as it's only argument. Most of the [built-in modifier functions](#domain-modifiers) return such functions.
|
||||
- An object argument will be merged into the domain's metadata collection.
|
||||
- An array arument will have all of it's members evaluated recursively. This allows you to combine multiple common records or modifiers into a variable that can
|
||||
- An array argument will have all of it's members evaluated recursively. This allows you to combine multiple common records or modifiers into a variable that can
|
||||
be used like a macro in multiple domains.
|
||||
|
||||
{% include startExample.html %}
|
||||
|
@ -8,7 +8,7 @@ return: string
|
||||
---
|
||||
|
||||
NewDnsProvider registers a new DNS Service Provider. The name can be any string value you would like to use.
|
||||
The type must match a valid dns provider type identifer (see [provider page.]({{site.github.url}}/provider-list))
|
||||
The type must match a valid dns provider type identifier (see [provider page.]({{site.github.url}}/provider-list))
|
||||
|
||||
Metadata is an optional object, that will only be used by certain providers. See [individual provider docs]({{site.github.url}}/provider-list) for specific details.
|
||||
|
||||
|
@ -8,7 +8,7 @@ return: string
|
||||
---
|
||||
|
||||
NewRegistrar registers a registrar provider. The name can be any string value you would like to use.
|
||||
The type must match a valid registar provider type identifer (see [provider page.]({{site.github.url}}/provider-list))
|
||||
The type must match a valid registrar provider type identifier (see [provider page.]({{site.github.url}}/provider-list))
|
||||
|
||||
Metadata is an optional object, that will only be used by certain providers. See [individual provider docs]({{site.github.url}}/provider-list) for specific details.
|
||||
|
||||
|
@ -51,5 +51,5 @@ D(REV('2001:db8:302::/48'), REGISTRAR, DnsProvider(BIND),
|
||||
{% include endExample.html %}
|
||||
|
||||
In the future we plan on adding a flag to `A()` which will insert
|
||||
the correct PTR() record if the approprate `D(REV()` domain (i.e. `.arpa` domain) has been
|
||||
the correct PTR() record if the appropriate `D(REV()` domain (i.e. `.arpa` domain) has been
|
||||
defined.
|
||||
|
@ -17,7 +17,7 @@ To activate this mode, set `"fakeps":"true"` inside your credentials file for th
|
||||
|
||||
## Configuration
|
||||
|
||||
The `ActiveDirectory_PS` provider reads an `ADServer` setting from`creds.json` to know the name of the ActiceDirectory DNS Server to update.
|
||||
The `ActiveDirectory_PS` provider reads an `ADServer` setting from `creds.json` to know the name of the ActiveDirectory DNS Server to update.
|
||||
|
||||
{% highlight javascript %}
|
||||
{
|
||||
|
@ -32,13 +32,13 @@ If your Cloudflare account has access to multiple Cloudflare accounts, you can s
|
||||
{% endhighlight %}
|
||||
|
||||
## Metadata
|
||||
Record level metadata availible:
|
||||
Record level metadata available:
|
||||
* `cloudflare_proxy` ("on", "off", or "full")
|
||||
|
||||
Domain level metadata availible:
|
||||
Domain level metadata available:
|
||||
* `cloudflare_proxy_default` ("on", "off", or "full")
|
||||
|
||||
Provider level metadata availible:
|
||||
Provider level metadata available:
|
||||
* `ip_conversions`
|
||||
* `manage_redirects`: set to `true` to manage page-rule based redirects
|
||||
|
||||
|
@ -44,7 +44,7 @@ Here a working example for our OT&E System:
|
||||
|
||||
## Usage
|
||||
|
||||
Here an example DNS Configuration `dnsconfig.js` using our provider module.
|
||||
Here's an example DNS Configuration `dnsconfig.js` using our provider module.
|
||||
Even though it shows how you use us as Domain Registrar AND DNS Provider, we don't force you to do that.
|
||||
You are free to decide if you want to use both of our provider technology or just one of them.
|
||||
|
||||
@ -55,7 +55,7 @@ var DNS_HX = NewDnsProvider('hexonet', 'HEXONET');
|
||||
|
||||
// Set Default TTL for all RR to reflect our Backend API Default
|
||||
// If you use additional DNS Providers, configure a default TTL
|
||||
// per domain using the domain modifyer DefaultTTL instead.
|
||||
// per domain using the domain modifier DefaultTTL instead.
|
||||
// also check this issue for [NAMESERVER TTL](https://github.com/StackExchange/dnscontrol/issues/176).
|
||||
DEFAULTS(
|
||||
{"ns_ttl":"3600"},
|
||||
|
@ -106,7 +106,7 @@ It should return something akin to:
|
||||
}
|
||||
{% endhighlight %}
|
||||
|
||||
Open the "validationUrl" in a brower and log in with your OVH account. This will link the app with your account,
|
||||
Open the "validationUrl" in a browser and log in with your OVH account. This will link the app with your account,
|
||||
authorizing it to access your zones and domains.
|
||||
|
||||
Do not forget to fill the `consumer-key` of your `creds.json`.
|
||||
|
@ -86,7 +86,7 @@ use advanced features.
|
||||
The `DnsProvider` is the service that actually provides DNS service
|
||||
(port 53) and may be the same or different company. Even if both
|
||||
your Registrar and DnsProvider are the same company, two different
|
||||
defintions must be included in `dnsconfig.js`.
|
||||
definitions must be included in `dnsconfig.js`.
|
||||
|
||||
|
||||
## 4. Create the initial `creds.json`
|
||||
|
@ -8,13 +8,13 @@ title: Nameservers
|
||||
DNSControl can handle a variety of provider scenarios for you:
|
||||
|
||||
- A single provider manages everything for your domains (Ex: name.com registers and serves dns)
|
||||
- A single provider serves dns seperately from the registrar (Ex: name.com registers and cloudflare hosts dns records)
|
||||
- A single provider serves dns separately from the registrar (Ex: NAME.COM registers and Cloudflare hosts dns records)
|
||||
- Multiple providers "co-host" dns (Ex: Route53 and Google Cloud DNS both serve as authoritative nameservers)
|
||||
- One or more "active" dns hosts and another "backup" dns host. (Ex: route53 hosts dns, but I update a local bind server as a backup)
|
||||
|
||||
All of these scenarios differ in how they manage:
|
||||
|
||||
- The root list of authoritative nameservers stored in the tld zone by your registrar.
|
||||
- The root list of authoritative nameservers stored in the TLD zone by your registrar.
|
||||
- The list of NS records for the base domain that is served by each dns host.
|
||||
|
||||
DNSControl attempts to manage these records for you as much as possible, according the the following processes:
|
||||
@ -53,7 +53,7 @@ DnsControl will also register the authoritative nameserver list with the registr
|
||||
|
||||
It is also possible to specify a DNS Provider that is not "authoritative" by using `DnsProvider("name", 0)`. This means the provider will be updated
|
||||
with all records to match the authoritative ones, but it will not be registered in the tld name servers, and will not take traffic.
|
||||
It's nameservers will not be added to the authoritative set. While this may seem an attractive option, there are a few things to note:
|
||||
Its nameservers will not be added to the authoritative set. While this may seem an attractive option, there are a few things to note:
|
||||
|
||||
1. Backup nameservers will still be updated with the NS records from the authoritative nameserver list. This means the records will still need to be updated to correctly "activate" the provider.
|
||||
2. Costs generally scale with utilization, so there is often no real savings associated with an active-passive setup vs an active-active one anyway.
|
||||
|
@ -15,7 +15,7 @@ Here are my notes from producing the v0.2.8 release. Change the version number
|
||||
* Run the integration tests (documented in [Writing new DNS providers](writing-providers)
|
||||
|
||||
|
||||
## Step 2. Bump the verison number
|
||||
## Step 2. Bump the version number
|
||||
|
||||
Edit the "Version" variable in `main.go` and commit.
|
||||
|
||||
@ -77,7 +77,7 @@ dnscontrol 0.2.8 ("ee5208bd5f19b9e5dd0bdba8d0e13403c43a469a[dirty]") built 19 De
|
||||
|
||||
a. Drag and drop binaries into the web form.
|
||||
|
||||
There is a box labeled "Atttach binaries by dropping them here or
|
||||
There is a box labeled "Attach binaries by dropping them here or
|
||||
selecting them". Drag dnscontrol-Darwin, dnscontrol-Linux, and
|
||||
dnscontrol.exe onto that box (one at a time or all at once). This
|
||||
will upload the binaries.
|
||||
|
@ -36,5 +36,5 @@ Here is a sample test written in `bash` using the [jq](https://stedolan.github.i
|
||||
|
||||
## Future directions
|
||||
|
||||
Manipulting JSON data is difficult. If you implement ways to make it easier, we'd
|
||||
Manipulating JSON data is difficult. If you implement ways to make it easier, we'd
|
||||
gladly accept contributions.
|
||||
|
@ -42,8 +42,8 @@ Here are four examples:
|
||||
```
|
||||
CNAME("foo", "bar) // Permitted. (expands to bar.$DOMAIN)
|
||||
CNAME("foo", "bar.com.") // Permitted. (we are certain what the user wants)
|
||||
CNAME("foo", "bar.com") // ERROR (amgiuous)
|
||||
CNAME("foo", "meta.xyz") // ERROR (amgiuous)
|
||||
CNAME("foo", "bar.com") // ERROR (ambiguous)
|
||||
CNAME("foo", "meta.xyz") // ERROR (ambiguous)
|
||||
|
||||
```
|
||||
|
||||
|
@ -79,7 +79,7 @@ A provider can be a DnsProvider, a Registrar, or both. We recommend
|
||||
you write the DnsProvider first, release it, and then write the
|
||||
Registrar if needed.
|
||||
|
||||
If you have any questions, please dicuss them in the Github issue
|
||||
If you have any questions, please discuss them in the Github issue
|
||||
related to the request for this provider. Please let us know what
|
||||
was confusing so we can update this document with advice for future
|
||||
authors (or even better, update [this document](https://github.com/StackExchange/dnscontrol/blob/master/docs/writing-providers.md)
|
||||
@ -219,7 +219,7 @@ the documentation.
|
||||
|
||||
## Vendoring Dependencies
|
||||
|
||||
If your provider depends on other go packages, then you must vendor them. To do this, use [govendor](https://github.com/kardianos/govendor). A command like this is usually suffient:
|
||||
If your provider depends on other go packages, then you must vendor them. To do this, use [govendor](https://github.com/kardianos/govendor). A command like this is usually sufficient:
|
||||
|
||||
```
|
||||
go get github.com/kardianos/govendor
|
||||
|
Reference in New Issue
Block a user