/cloudflare

Caddy module: dns.providers.cloudflare

Primary LanguageGo

Cloudflare module for Caddy

This package contains a DNS provider module for Caddy. It can be used to manage DNS records with Cloudflare accounts.

Caddy module name

dns.providers.cloudflare

Config examples

To use this module for the ACME DNS challenge, configure the ACME issuer in your Caddy JSON like so:

{
	"module": "acme",
	"challenges": {
		"dns": {
			"provider": {
				"name": "cloudflare",
				"api_token": "YOUR_CLOUDFLARE_API_TOKEN"
			}
		}
	}
}

or with the Caddyfile:

tls {
	dns cloudflare {env.CLOUDFLARE_API_TOKEN}
}

You can replace {env.CLOUDFLARE_API_TOKEN} with the actual auth token if you prefer to put it directly in your config instead of an environment variable.

Authenticating

See the associated README in the libdns package for important information about credentials.

NOTE: If migrating from Caddy v1, you will need to change from using a Cloudflare API Key to a scoped API Token. Please see link above for more information.