Skip to content

dns/ddclient: Improve Cloudflare configuration UX and help text #5194

@bks22

Description

@bks22

Important notices
Before you add a new report, we ask you kindly to acknowledge the following:

Is your feature request related to a problem? Please describe.
Configuring Dynamic DNS with Cloudflare API Tokens is unintuitive and leads to confusing errors with no guidance on how to resolve them.

  1. API Token authentication requires token as username. When using a Cloudflare API Token (not Global API Key), the Username field must be set to the literal string token. Using an email address results in Invalid format for X-Auth-Key header, which doesn't indicate that the username field needs to be changed.

  2. Hostname requires FQDN despite Zone being configured. Even when a Zone is configured (e.g., example.com), the Hostname field requires the full FQDN (e.g., host.example.com), not just the host portion (host). Using just the hostname results in No 'A' record at Cloudflare, which is misleading because the record exists — ddclient just can't find it due to the naming mismatch.

Describe the solution you'd like

  1. Add placeholder or help text to the Username field: "token" for API Tokens, or email for Global API Key
  2. Add help text to the Hostname field: Full domain name required (e.g., host.example.com)

Describe alternatives you've considered

  • Auto-append the zone to the hostname when only the host portion is provided
  • Validate the configuration by making a test API call when saving, to catch misconfigurations early

Additional context

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions