Skip to content
HMS-Docker

Cloudflare DDNS

Below is how to configure DDNS (Dynamic DNS) for Cloudflare.

Requirements

Section titled “Requirements”
  • A Cloudflare account and Cloudflare configured as your domains DNS servers
  • API keys for your account with the correct permissions
    • Requires Zone.DNS:Edit permissions for the correct zone

Enabling

Section titled “Enabling”

The following variables are required:

inventory/group_vars/all/cloudflare_ddns.yml
cloudflare_api_token:                           # the API token of the Cloudflare account
cloudflare_ddns_enabled: true                   # `true` or `false` to enable/disable Cloudflare DDNS (default: `false`)
cloudflare_ddns_domain:                         # the domain name of the Cloudflare zone (e.g. `example.com`), this will default to the `hms_docker_domain` defined in the `main.yml` file
cloudflare_ddns_subdomain:                      # the subdomain record (e.g. `hmsdpublic` would be created as `hmsdpublic.example.com`) (default: `hmsdpublic`)
cloudflare_ddns_proxied: 'true'                 # `'true'` or `'false'` to enable/disable proxying the traffic through Cloudflare (default: `'true'`) NOTE: quotes are required
cloudflare_ddns_delete_record_on_stop: 'false'  # If the record should be deleted when the container stops (default: `"false"`) NOTE: quotes are required
cloudflare_ddns_create_ipv6_aaaa_record: false  # Creates a `AAAA` record for IPv6 (default: `false`)