From a17c4f8e0c970a9ecb3201e313f7aefec738508f Mon Sep 17 00:00:00 2001 From: William Jackson <565174+williamjacksn@users.noreply.github.com> Date: Sun, 29 May 2022 16:22:52 -0500 Subject: [PATCH] Add documentation for `include_meta` config key Update README.md to include documentation for the `include_meta` key in the `manager` section of the config. --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 1c88df4..666e4b9 100644 --- a/README.md +++ b/README.md @@ -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=`. 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.