mirror/stackexchange-dnscontrol
1
0
Fork 0
mirror of https://github.com/StackExchange/dnscontrol.git synced 2024-05-11 05:55:12 +00:00
Code Issues Releases Activity

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

Browse Source 
* 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
Download Patch File Download Diff File Expand all files Collapse all files

28
docs/_providers/hedns.md
View File

@@ -12,14 +12,18 @@ with the web interface. Because there is no officially supported API, this provi
Electric changes their interface, and you should be willing to accept this possibility before relying on this provider.
## Configuration
In your `creds.json` file you must provide your `dns.he.net` account username and password. These are the same username
To use this provider, add an entry to `creds.json` with `TYPE` set to `HEDNS`
along with
your `dns.he.net` account username and password. These are the same username
and password used to login to the [web interface]([https://dns.he.net]).
```json
{
"hedns":{
"username": "yourUsername",
"password": "yourPassword"
"hedns": {
"TYPE": "HEDNS",
"password": "yourPassword",
"username": "yourUsername"
}
}
```
@@ -31,10 +35,11 @@ This can also be done via an environment variable:
```json
{
"hedns":{
"username": "yourUsername",
"hedns": {
"TYPE": "HEDNS",
"password": "yourPassword",
"totp": "$HEDNS_TOTP"
"totp": "$HEDNS_TOTP",
"username": "yourUsername"
}
}
```
@@ -97,12 +102,13 @@ This option is disabled by default when this key is not present,
This provider does not recognize any special metadata fields unique to Hurricane Electric DNS.
## Usage
Example Javascript:
An example `dnsconfig.js` configuration:
```js
var DNSIMPLE = NewDnsProvider("hedns", "HEDNS");
var REG_NONE = NewRegistrar("none");
var DSP_HEDNS = NewDnsProvider("hedns");
D("example.tld", REG_DNSIMPLE, DnsProvider(HEDNS),
A("test","1.2.3.4")
D("example.tld", REG_NONE, DnsProvider(DSP_HEDNS),
A("test", "1.2.3.4")
);
```