mirror of
https://github.com/StackExchange/dnscontrol.git
synced 2024-11-10 17:26:10 +08:00
Added docs for Cloudflare DNS provider (#65)
This commit is contained in:
parent
a8b9c7ab5c
commit
2a38a2b71a
1 changed files with 48 additions and 0 deletions
48
docs/_providers/cloudflare.md
Normal file
48
docs/_providers/cloudflare.md
Normal file
|
@ -0,0 +1,48 @@
|
|||
---
|
||||
name: Cloudflare
|
||||
layout: default
|
||||
jsId: 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-username"
|
||||
}
|
||||
}
|
||||
{% endhighlight %}
|
||||
|
||||
## Metadata
|
||||
|
||||
Record level metadata availible:
|
||||
* cloudflare_proxy ("true" or "false")
|
||||
|
||||
Domain level metadata availible:
|
||||
* cloudflare_proxy_default ("true" or "false")
|
||||
|
||||
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")
|
||||
);
|
||||
{%endhighlight%}
|
||||
|
||||
## Activation
|
||||
|
||||
DNSControl depends on a Cloudflare Global API Key that's available under "My Settings".
|
Loading…
Reference in a new issue