Browse Source

Merge pull request #907 from williamjacksn/patch-1

Add documentation for `include_meta` config key
pull/910/head
Ross McFarland 4 years ago
committed by GitHub
parent
commit
e17e30b383
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 0 deletions
  1. +3
    -0
      README.md

+ 3
- 0
README.md View File

@ -68,6 +68,7 @@ We start by creating a config file to tell OctoDNS about our providers and the z
```yaml
---
manager:
include_meta: False
max_workers: 2
providers:
@ -102,6 +103,8 @@ zones:
Further information can be found in the `docstring` of each source and provider class.
The `include_meta` key in the `manager` section of the config controls the creation of a TXT record at the root of a zone that is managed by OctoDNS. If set to `True`, OctoDNS will create a TXT record for the root of the zone with the value `provider=<target-provider>`. If not specified, the default value for `include_meta` is `False`.
The `max_workers` key in the `manager` section of the config enables threading to parallelize the planning portion of the sync.
In this example, `example.net` is an alias of zone `example.com`, which means they share the same sources and targets. They will therefore have identical records.


Loading…
Cancel
Save