mirror of
https://github.com/StackExchange/dnscontrol.git
synced 2024-05-11 05:55:12 +00:00
DOCS: Fix many small typos (#1794)
Co-authored-by: Jeffrey Cafferata <jeffrey@jcid.nl>
This commit is contained in:
@ -4,7 +4,7 @@ parameters:
|
||||
- ttl
|
||||
---
|
||||
|
||||
DefaultTTL sets the TTL for all records in a domain that do not explicitly set one with [TTL](#TTL). If neither `DefaultTTl` or `TTL` exist for a record,
|
||||
DefaultTTL sets the TTL for all records in a domain that do not explicitly set one with [TTL](#TTL). If neither `DefaultTTL` or `TTL` exist for a record,
|
||||
it will use the DNSControl global default of 300 seconds.
|
||||
|
||||
{% capture example %}
|
||||
|
@ -80,4 +80,4 @@ You can override this error by adding the
|
||||
Disabling this safety check creates two risks:
|
||||
|
||||
1. Two owners (DNSControl and some other entity) toggling a record between two settings.
|
||||
2. The other owner wiping all records at this label, which won't be noticed until the next time dnscontrol is run.
|
||||
2. The other owner wiping all records at this label, which won't be noticed until the next time DNSControl is run.
|
||||
|
@ -13,7 +13,7 @@ NO_PURGE is generally used in very specific situations:
|
||||
In this example DNSControl will insert "foo.example.com" into the
|
||||
zone, but otherwise leave the zone alone. Changes to "foo"'s IP
|
||||
address will update the record. Removing the A("foo", ...) record
|
||||
from dnscontrol will leave the record in place.
|
||||
from DNSControl will leave the record in place.
|
||||
|
||||
{% capture example %}
|
||||
```js
|
||||
|
@ -31,7 +31,7 @@ The zone id can be found depending on the target type:
|
||||
* _Elastic Beanstalk environment_: specify the hosted zone ID for the region in which the environment has been created. Refer to the [List of regions and hosted Zone IDs](http://docs.aws.amazon.com/general/latest/gr/rande.html#elasticbeanstalk_region).
|
||||
* _ELB load balancer_: specify the value of the hosted zone ID for the load balancer. You can find it in [the List of regions and hosted Zone IDs](http://docs.aws.amazon.com/general/latest/gr/rande.html#elb_region)
|
||||
* _S3 bucket_ (configured as website): specify the hosted zone ID for the region that you created the bucket in. You can find it in [the List of regions and hosted Zone IDs](http://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region)
|
||||
* _Another Route 53 record_: you can either specify the correct zone id or do not specify anything and dnscontrol will figure out the right zone id. (Note: Route53 alias can't reference a record in a different zone).
|
||||
* _Another Route 53 record_: you can either specify the correct zone id or do not specify anything and DNSControl will figure out the right zone id. (Note: Route53 alias can't reference a record in a different zone).
|
||||
|
||||
{% capture example %}
|
||||
```js
|
||||
|
@ -8,12 +8,13 @@ parameters:
|
||||
- issuewild
|
||||
---
|
||||
|
||||
dnscontrol contains a CAA_BUILDER which can be used to simply create
|
||||
# CAA Builder
|
||||
|
||||
DNSControl contains a `CAA_BUILDER` which can be used to simply create
|
||||
CAA records for your domains. Instead of creating each CAA record
|
||||
individually, you can simply configure your report mail address, the
|
||||
authorized certificate authorities and the builder cares about the rest.
|
||||
|
||||
|
||||
## Example
|
||||
|
||||
For example you can use:
|
||||
|
@ -16,7 +16,9 @@ parameters:
|
||||
- ttl
|
||||
---
|
||||
|
||||
dnscontrol contains a DMARC_BUILDER which can be used to simply create
|
||||
# DMARC Builder
|
||||
|
||||
DNSControl contains a `DMARC_BUILDER` which can be used to simply create
|
||||
DMARC policies for your domains.
|
||||
|
||||
|
||||
|
@ -11,8 +11,10 @@ parameters:
|
||||
- flatten
|
||||
---
|
||||
|
||||
dnscontrol can optimize the SPF settings on a domain by flattening
|
||||
(inlining) includes and removing duplicates. dnscontrol also makes
|
||||
# SPF Optimizer
|
||||
|
||||
DNSControl can optimize the SPF settings on a domain by flattening
|
||||
(inlining) includes and removing duplicates. DNSControl also makes
|
||||
it easier to document your SPF configuration.
|
||||
|
||||
**Warning:** Flattening SPF includes is risky. Only flatten an SPF
|
||||
@ -37,7 +39,7 @@ This has a few problems:
|
||||
* Ugly diffs. If you add an element to the SPF setting, the diff will show the entire line changed, which is difficult to read.
|
||||
* Too many lookups. The SPF RFC says that SPF settings should not require more than 10 DNS lookups. If we manually flatten (i.e. "inline") an include, we have to remember to check back to see if the settings have changed. Humans are not good at that kind of thing.
|
||||
|
||||
## The dnscontrol way
|
||||
## The DNSControl way
|
||||
|
||||
```js
|
||||
D("example.tld", REG, DSP, ...
|
||||
@ -73,7 +75,7 @@ By using the `SPF_BUILDER()` we gain many benefits:
|
||||
|
||||
* Comments can appear next to the element they refer to.
|
||||
* Diffs will be shorter and more specific; therefore easier to read.
|
||||
* Automatic flattening. We can specify which includes should be flattened and dnscontrol will do the work. It will even warn us if the includes change.
|
||||
* Automatic flattening. We can specify which includes should be flattened and DNSControl will do the work. It will even warn us if the includes change.
|
||||
|
||||
## Syntax
|
||||
|
||||
@ -107,7 +109,7 @@ D("example.tld", REG, DSP, ...
|
||||
The parameters are:
|
||||
|
||||
* `label:` The label of the first TXT record. (Optional. Default: `"@"`)
|
||||
* `overflow:` If set, SPF strings longer than 255 chars will be split into multiple TXT records. The value of this setting determines the template for what the additional labels will be named. If not set, no splitting will occur and dnscontrol may generate TXT strings that are too long.
|
||||
* `overflow:` If set, SPF strings longer than 255 chars will be split into multiple TXT records. The value of this setting determines the template for what the additional labels will be named. If not set, no splitting will occur and DNSControl may generate TXT strings that are too long.
|
||||
* `overhead1:` "Overhead for the 1st TXT record". When calculating the max length of each TXT record, reduce the maximum for the first TXT record in the chain by this amount.
|
||||
* `raw:` The label of the unaltered SPF settings. Setting to an empty string `''` will disable this. (Optional. Default: `"_rawspf"`)
|
||||
* `ttl:` This allows setting a specific TTL on this SPF record. (Optional. Default: using default record TTL)
|
||||
@ -180,7 +182,7 @@ to get the entire record. (Sadly it caches heavily.)
|
||||
|
||||
## Notes about the `spfcache.json`
|
||||
|
||||
dnscontrol keeps a cache of the DNS lookups performed during
|
||||
DNSControl keeps a cache of the DNS lookups performed during
|
||||
optimization. The cache is maintained so that the optimizer does
|
||||
not produce different results depending on the ups and downs of
|
||||
other people's DNS servers. This makes it possible to do `dnscontrol
|
||||
@ -239,7 +241,7 @@ In which case, it is equivalent to `include:`.
|
||||
|
||||
## Advanced Technique: Interactive SPF Debugger
|
||||
|
||||
dnscontrol includes an experimental system for viewing
|
||||
DNSControl includes an experimental system for viewing
|
||||
SPF settings:
|
||||
|
||||
[https://stackexchange.github.io/dnscontrol/flattener/index.html](https://stackexchange.github.io/dnscontrol/flattener/index.html)
|
||||
|
Reference in New Issue
Block a user