mirror of
https://github.com/qdm12/ddns-updater.git
synced 2026-08-03 11:08:37 -04:00
07d7645d78
- retro-compatible change: keep using host/owner if set - otherwise extract owner and eTLD+1 from domain field - documentation updated to only use the `domain` field
41 lines
1.1 KiB
Markdown
41 lines
1.1 KiB
Markdown
# Example.com
|
|
|
|
## Configuration
|
|
|
|
### Example
|
|
|
|
<!-- UPDATE THIS JSON EXAMPLE -->
|
|
|
|
```json
|
|
{
|
|
"settings": [
|
|
{
|
|
"provider": "example",
|
|
"domain": "domain.com",
|
|
"username": "username",
|
|
"password": "password",
|
|
"ip_version": "ipv4",
|
|
"ipv6_suffix": ""
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
### Compulsory parameters
|
|
|
|
- `"domain"` is the domain to update. It can be `example.com` (root domain), `sub.example.com` (subdomain of `example.com`) or `*.example.com` for the wildcard.
|
|
- `"username"`
|
|
- `"password"`
|
|
|
|
<!-- UPDATE THIS IF NEEDED -->
|
|
|
|
### Optional parameters
|
|
|
|
- `"ip_version"` can be `ipv4` (A records), or `ipv6` (AAAA records) or `ipv4 or ipv6` (update one of the two, depending on the public ip found). It defaults to `ipv4 or ipv6`.
|
|
- `"ipv6_suffix"` is the IPv6 interface identifier suffix to use. It can be for example `0:0:0:0:72ad:8fbb:a54e:bedd/64`. If left empty, it defaults to no suffix and the raw public IPv6 address obtained is used in the record updating.
|
|
|
|
<!-- UPDATE THIS IF NEEDED -->
|
|
|
|
## Domain setup
|
|
|
|
<!-- FILL THIS UP WITH A FEW NUMBERED STEPS --> |