From 0d02c9adf47ec8af4fc2eecfb242fc4d2ea41bf2 Mon Sep 17 00:00:00 2001 From: Tiernan OToole Date: Tue, 2 May 2017 21:22:51 +0100 Subject: [PATCH] updating getting started doc for multiple providers (#104) * updating getting started doc for multiple providers --- docs/getting-started.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/getting-started.md b/docs/getting-started.md index 180e101fe..7d2742aba 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -58,6 +58,22 @@ D('example.com', REG_NONE, DnsProvider(DNS_BIND), ); {%endhighlight%} +You may modify this file to match your particular providers and domains. See [the javascript docs]({{site.github.url}}/js) and [the provider docs]({{site.github.url}}/provider-list) for more details. +If you are using other providers, you will likely need to make a `creds.json` file with api tokens and other account information. For example, to use both name.com and Cloudflare, you would have: + +{% highlight js %} +{ + "cloudflare":{ //provider name to be used in dnsconfig.js + "apikey": "key", //API key + "apiuser": "username" //username for cloudflare + }, + "namecom":{ //provider name to be used in dnsconfig.js + "apikey": "key", //API Key + "apiuser": "username" //username for name.com + } +} +{%endhighlight%} + There are 2 types of providers: A "Registrar" is who you register the domain with. Start with