_cloudflare.tpl 1.8 KB

123456789101112131415161718192021222324252627282930313233343536373839
  1. {{/* https://github.com/qdm12/ddns-updater/blob/master/docs/cloudflare.md */}}
  2. {{- define "ddns.config.cloudflare" -}}
  3. {{- $item := .item }}
  4. zone_identifier: {{ $item.cloudflareZoneID | required "DDNS Updater - Expected non-empty [Zone Identifier] for Cloudflare provider" }}
  5. ttl: {{ $item.cloudflareTtl | required "DDNS Updater - Expected non-empty [TTL] for Cloudflare provider" }}
  6. proxied: {{ $item.cloudflareProxied | default false }}
  7. {{- if $item.cloudflareToken }}
  8. token: {{ $item.cloudflareToken }}
  9. {{- else if $item.cloudflareUserServiceKey }}
  10. user_service_key: {{ $item.cloudflareUserServiceKey }}
  11. {{- else if and $item.cloudflareEmail $item.cloudflareApiKey }}
  12. email: {{ $item.cloudflareEmail }}
  13. api_key: {{ $item.cloudflareApiKey }}
  14. {{- else -}}
  15. {{- fail "DDNS Updater - Cloudflare provider requires either [Token] or [User Service Key] or [Email and API Key]" -}}
  16. {{- end -}}
  17. {{- end -}}
  18. {{/*
  19. ddnsConfig:
  20. config:
  21. - provider: cloudflare - Required
  22. domain: "example.com" - Required
  23. host: "@" - Required - Valid value ("@")
  24. ipVersion: "" - Required - Valid values (ipv4/ipv6/"")
  25. cloudflareZoneID: id - Required
  26. cloudflareTtl: 1 - Required - Valid values (>=1)
  27. cloudflareProxied: false - Required - Valid values (true/false)
  28. # One of the following is required
  29. # Token
  30. cloudflareToken: token - Required
  31. # User service key
  32. cloudflareUserServiceKey: user_service_key - Required
  33. # Email and API key
  34. cloudflareEmail: email - Required
  35. cloudflareApiKey: api_key - Required
  36. */}}