dnscontrol/docs/_providers/dnsimple.md
Patrick G 31bdb65720 Improved consistency of provider documentation (#222)
- Fixed indentation
- Use same naming scheme for all examples
  (i.e. all caps for provider, REG prefix for registrar)
- Use REG_NONE as registrar when provider does not provide it
- Use example.tld for example domain
- Use 1.2.3.1/24 IP range for examples
- A few spelling fixes
2017-10-11 08:33:52 -04:00

39 lines
747 B
Markdown

---
name: DNSimple
title: DNSimple Provider
layout: default
jsId: DNSIMPLE
---
# DNSimple Provider
## Configuration
In your providers config json file you must provide a DNSimple account access token:
{% highlight json %}
{
"dnsimple": {
"token": "your-dnsimple-account-access-token"
}
}
{% endhighlight %}
## Metadata
This provider does not recognize any special metadata fields unique to DNSimple.
## Usage
Example javascript:
{% highlight js %}
var REG_DNSIMPLE = NewRegistrar("dnsimple", "DNSIMPLE");
var DNSIMPLE = NewDnsProvider("dnsimple", "DNSIMPLE");
D("example.tld", REG_DNSIMPLE, DnsProvider(DNSIMPLE),
A("test","1.2.3.4")
);
{% endhighlight %}
## Activation
DNSControl depends on a DNSimple account access token.