dnscontrol/docs/_providers/cloudflare.md
Tiernan OToole 5cad1c3513 Cloudflare createdomain (#113)
* fixing #112

* fixing build issue

* typo

* adding missing commits from master

* fixing gofmt validation errors

* fixing github pull request sugestions

* fixing build issue

* adding debug info

* adding more debug

* tweaking code based on pull request comments

* fixing error
2017-05-05 15:20:43 -06:00

1.3 KiB

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

Usage

Example javascript:

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

D("example.tld", REG_NAMECOM, DnsProvider(CFLARE), A("test","1.2.3.4"), A("www","1.2.3.4", {cloudlfare_proxy:"on"}), ALIAS("@","test.example.tld",{cloudflare_proxy:"on"}) ); {%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 command dnscontrol create-domains -command.