mirror of
https://github.com/StackExchange/dnscontrol.git
synced 2024-05-11 05:55:12 +00:00
DOCS: Simplified the provider URLs (providers) (#2914)
This commit is contained in:
committed by
GitHub
parent
0cd3c2fb92
commit
5078927e01
44
documentation/provider/netlify.md
Normal file
44
documentation/provider/netlify.md
Normal file
@ -0,0 +1,44 @@
|
||||
## Configuration
|
||||
|
||||
To use this provider, add an entry to `creds.json` with `TYPE` set to `NETLIFY`
|
||||
along with a Netlify account personal access token. You can also optionally add an
|
||||
account slug. This is _typically_ your username on Netlify.
|
||||
|
||||
Examples:
|
||||
|
||||
{% code title="creds.json" %}
|
||||
```json
|
||||
{
|
||||
"netlify": {
|
||||
"TYPE": "NETLIFY",
|
||||
"token": "your-netlify-account-access-token",
|
||||
"slug": "account-slug" // this is optional
|
||||
}
|
||||
}
|
||||
```
|
||||
{% endcode %}
|
||||
|
||||
## Metadata
|
||||
This provider does not recognize any special metadata fields unique to Netlify.
|
||||
|
||||
## Usage
|
||||
An example configuration:
|
||||
|
||||
{% code title="dnsconfig.js" %}
|
||||
```javascript
|
||||
var REG_NETLIFY = NewRegistrar("netlify");
|
||||
var DSP_NETLIFY = NewDnsProvider("netlify");
|
||||
|
||||
D("example.com", REG_NETLIFY, DnsProvider(DSP_NETLIFY),
|
||||
A("test", "1.2.3.4")
|
||||
);
|
||||
```
|
||||
{% endcode %}
|
||||
|
||||
## Activation
|
||||
DNSControl depends on a Netlify account personal access token.
|
||||
|
||||
## Caveats
|
||||
Empty MX records are not supported.
|
||||
|
||||
|
Reference in New Issue
Block a user