1
0
mirror of https://github.com/StackExchange/dnscontrol.git synced 2024-05-11 05:55:12 +00:00

Update docs for the "plan a" change (#1499)

* Update docs
This commit is contained in:
Tom Limoncelli
2022-05-08 14:41:33 -04:00
committed by GitHub
parent 9e6d642e35
commit 533eabedf5
38 changed files with 647 additions and 413 deletions

View File

@@ -7,11 +7,15 @@ jsId: OVH
## Configuration
In your providers config json file you must provide a OVH app-key, app-secret-key and consumer-key:
To use this provider, add an entry to `creds.json` with `TYPE` set to `OVH`
along with a OVH app-key, app-secret-key and consumer-key.
Example:
```json
{
"ovh":{
"ovh": {
"TYPE": "OVH",
"app-key": "your app key",
"app-secret-key": "your app secret key",
"consumer-key": "your consumer key"
@@ -27,27 +31,25 @@ This provider does not recognize any special metadata fields unique to OVH.
## Usage
Example javascript:
Example javascript (DNS hosted with OVH):
An example `dnsconfig.js` configuration: (DNS hosted with OVH):
```js
var REG_OVH = NewRegistrar("ovh", "OVH");
var OVH = NewDnsProvider("ovh", "OVH");
var REG_OVH = NewRegistrar("ovh");
var DSP_OVH = NewDnsProvider("ovh");
D("example.tld", REG_OVH, DnsProvider(OVH),
A("test","1.2.3.4")
D("example.tld", REG_OVH, DnsProvider(DSP_OVH),
A("test", "1.2.3.4")
);
```
Example javascript (Registrar only. DNS hosted elsewhere):
An example `dnsconfig.js` configuration: (Registrar only. DNS hosted elsewhere)
```js
var REG_OVH = NewRegistrar("ovh", "OVH");
var R53 = NewDnsProvider("r53", "ROUTE53");
var REG_OVH = NewRegistrar("ovh");
var DSP_R53 = NewDnsProvider("r53");
D("example.tld", REG_OVH, DnsProvider(R53),
A("test","1.2.3.4")
D("example.tld", REG_OVH, DnsProvider(DSP_R53),
A("test", "1.2.3.4")
);
```