Skip to content

Commit

Permalink
Update README with information about minimum TTL
Browse files Browse the repository at this point in the history
Signed-off-by: Daan van Gorkum <[email protected]>
  • Loading branch information
TheDJVG committed Jan 26, 2024
1 parent 8a0a204 commit fc2eae4
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,10 @@ providers:
#zones_per_page: 50
# Optional. Default: 100. Number of dns records per page.
#records_per_page: 100
# Optional. Default: 120. Lowest TTL allowed to be set.
# A different limit for (non-)enterprise zone applies.
# See: https://developers.cloudflare.com/dns/manage-dns-records/reference/ttl
#min_ttl: 120
```

Note: The "proxied" flag of "A", "AAAA" and "CNAME" records can be managed via the YAML provider like so:
Expand Down Expand Up @@ -110,6 +114,11 @@ CloudflareProvider does not support dynamic records.
Required Permissions for API Token are Zone:Read, DNS:Read, and DNS:Edit.
#### TTL
Cloudflare has a different minimum TTL for enterprise and non-enterprise zones. See the [documentation](https://developers.cloudflare.com/dns/manage-dns-records/reference/ttl) for more information.
In the past the CloudflareProvider had a fixed minimum TTL set to 120 seconds and for backwards compatbility this is the current default.
### Developement
See the [/script/](/script/) directory for some tools to help with the development process. They generally follow the [Script to rule them all](https://github.com/github/scripts-to-rule-them-all) pattern. Most useful is `./script/bootstrap` which will create a venv and install both the runtime and development related requirements. It will also hook up a pre-commit hook that covers most of what's run by CI.

0 comments on commit fc2eae4

Please sign in to comment.