mirror of
https://github.com/StackExchange/dnscontrol.git
synced 2025-12-09 13:46:07 +08:00
56 lines
1.5 KiB
Markdown
56 lines
1.5 KiB
Markdown
This is the provider for [AdGuardHome](https://github.com/AdguardTeam/AdGuardHome).
|
|
|
|
## Important notes
|
|
|
|
This provider only supports the following record types.
|
|
|
|
* [A](../language-reference/domain-modifiers/A.md)
|
|
* [AAAA](../language-reference/domain-modifiers/AAAA.md)
|
|
* [CNAME](../language-reference/domain-modifiers/CNAME.md)
|
|
* [ALIAS](../language-reference/domain-modifiers/ALIAS.md)
|
|
* [ADGUARDHOME_A_PASSTHROUGH](../language-reference/domain-modifiers/ADGUARDHOME_A_PASSTHROUGH.md)
|
|
* [ADGUARDHOME_AAAA_PASSTHROUGH](../language-reference/domain-modifiers/ADGUARDHOME_AAAA_PASSTHROUGH.md)
|
|
|
|
## Configuration
|
|
|
|
To use this provider, add an entry to `creds.json` with `TYPE` set to `ADGUARDHOME`.
|
|
|
|
Required fields include:
|
|
|
|
* `username` and `password`: Authentication information
|
|
* `host`: The hostname/address of AdGuard Home instance
|
|
|
|
Example:
|
|
|
|
{% code title="creds.json" %}
|
|
```json
|
|
{
|
|
"adguard_home": {
|
|
"TYPE": "ADGUARDHOME",
|
|
"username": "admin",
|
|
"password": "your-password",
|
|
"host": "https://foo.com"
|
|
}
|
|
}
|
|
```
|
|
{% endcode %}
|
|
|
|
## Usage
|
|
|
|
An example configuration:
|
|
|
|
{% code title="dnsconfig.js" %}
|
|
```javascript
|
|
var REG_NONE = NewRegistrar("none");
|
|
var DSP_ADGUARDHOME = NewDnsProvider("adguard_home");
|
|
|
|
D("example.com", REG_NONE, DnsProvider(DSP_ADGUARDHOME),
|
|
A("foo", "1.2.3.4"),
|
|
AAAA("another", "2003::1"),
|
|
ALIAS("@", "www.example.com."),
|
|
CNAME("myalias", "www.example.com."),
|
|
ADGUARDHOME_A_PASSTHROUGH("abc", ""),
|
|
ADGUARDHOME_AAAA_PASSTHROUGH("abc", ""),
|
|
);
|
|
```
|
|
{% endcode %}
|