dnscontrol/docs/_providers/cloudflare.md

name	layout	jsId
Cloudflare	default	CLOUDFLAREAPI

Cloudflare Provider

Configuration

In your providers config json file you must provide your cloudflare.com api username and access token:

{% highlight json %} { "cloudflare.com":{ "apikey": "your-cloudflare-api-key", "apiuser": "your-cloudflare-email-address" } } {% endhighlight %}

Metadata

Record level metadata availible:

• cloudflare_proxy ('on', 'off', or 'full')

Domain level metadata availible:

• cloudflare_proxy_default ('on', 'off', or 'full')

Provider level metadata availible:

• ip_conversions

What does on/off/full mean?

• "off" disables the Cloudflare proxy
• "on" enables the Cloudflare proxy (turns on the "orange cloud")
• "full" is the same as "on" but also enables Railgun. DNSControl will prevent you from accidentally enabling "full" on a CNAME that points to an A record that is set to "off", as this is generally not desired.

Aliases:

To make configuration files more readable and less prone to typos, the following aliases are pre-defined:

{% highlight json %} // Meta settings for individual records. var CF_PROXY_OFF = {'cloudflare_proxy': 'off'}; // Proxy disabled. var CF_PROXY_ON = {'cloudflare_proxy': 'on'}; // Proxy enabled. var CF_PROXY_FULL = {'cloudflare_proxy': 'full'}; // Proxy+Railgun enabled. // Per-domain meta settings: // Proxy default off for entire domain (the default): var CF_PROXY_DEFAULT_OFF = {'cloudflare_proxy_default': 'off'}; // Proxy default on for entire domain: var CF_PROXY_DEFAULT_ON = {'cloudflare_proxy_default': 'on'}; {% endhighlight %}

The following example shows how to set meta variables with and without aliases:

{% highlight json %} D('example.tld', REG_NAMECOM, DnsProvider(CFLARE), A('www1','1.2.3.11', CF_PROXY_ON), // turn proxy ON. A('www2','1.2.3.12', CF_PROXY_OFF), // default is OFF, this is a no-op. A('www3','1.2.3.13', {'cloudflare_proxy': 'on'}) // why would anyone do this? ); {% endhighlight %}

Usage

Example javascript:

{% highlight js %} var REG_NAMECOM = NewRegistrar('name.com','NAMEDOTCOM'); var CFLARE = NewDnsProvider('cloudflare.com','CLOUDFLAREAPI');

// Example domain where the CF proxy abides by the default (off). D('example.tld', REG_NAMECOM, DnsProvider(CFLARE), A('proxied','1.2.3.4', CF_PROXY_ON), A('notproxied','1.2.3.5'), A('another','1.2.3.6', CF_PROXY_ON), ALIAS('@','www.example.tld.', CF_PROXY_ON), CNAME('myalias','www.example.tld.', CF_PROXY_ON) );

// Example domain where the CF proxy default is set to "on": D('example2.tld', REG_NAMECOM, DnsProvider(CFLARE), CF_PROXY_DEFAULT_ON, // Enable CF proxy for all items unless otherwise noted. A('proxied','1.2.3.4'), A('notproxied','1.2.3.5', CF_PROXY_OFF), A('another','1.2.3.6'), ALIAS('@','www.example2.tld.'), CNAME('myalias','www.example2.tld.') ); {%endhighlight%}

Activation

DNSControl depends on a Cloudflare Global API Key that's available under "My Settings".

New domains

If a domain does not exist in your CloudFlare account, DNSControl will not automatically add it. You'll need to do that via the control panel manually or via the dnscontrol create-domains command.