Skip to content

Commit 07d7645

Browse files
committed
feat(config): read both owner and domain from domain
- 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
1 parent 55d8c0d commit 07d7645

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

51 files changed

+175
-169
lines changed

README.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -120,8 +120,7 @@ This readme and the [docs/](docs/) directory are **versioned** to match the prog
120120
"settings": [
121121
{
122122
"provider": "namecheap",
123-
"domain": "example.com",
124-
"owner": "@",
123+
"domain": "sub.example.com",
125124
"password": "e5322165c1d74692bfa6d807100c0310"
126125
}
127126
]
@@ -165,8 +164,7 @@ This readme and the [docs/](docs/) directory are **versioned** to match the prog
165164
"settings": [
166165
{
167166
"provider": "namecheap",
168-
"domain": "example.com",
169-
"owner": "@",
167+
"domain": "sub.example.com",
170168
"password": "e5322165c1d74692bfa6d807100c0310"
171169
}
172170
]
@@ -256,7 +254,7 @@ Check the documentation for your DNS provider:
256254

257255
Note that:
258256

259-
- you can specify multiple hosts for the same domain using a comma separated list. For example with `"owner": "@,subdomain1,subdomain2",`.
257+
- you can specify multiple owners/hosts for the same domain using a comma separated list. For example with `"domain": "example.com,sub.example.com,sub2.example.com",`.
260258

261259
### Environment variables
262260

config.json

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@
33
{
44
"provider": "namecheap",
55
"domain": "example.com",
6-
"owner": "@",
76
"password": "e5322165c1d74692bfa6d807100c0310"
87
},
98
{
@@ -13,8 +12,7 @@
1312
},
1413
{
1514
"provider": "godaddy",
16-
"domain": "example.org",
17-
"owner": "subdomain",
15+
"domain": "subdomain.example.org",
1816
"key": "aaaaaaaaaaaaaaaa",
1917
"secret": "aaaaaaaaaaaaaaaa"
2018
},

docs/aliyun.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@
1010
{
1111
"provider": "aliyun",
1212
"domain": "domain.com",
13-
"owner": "@",
1413
"access_key_id": "your access_key_id",
1514
"access_secret": "your access_secret",
1615
"ip_version": "ipv4",
@@ -22,8 +21,7 @@
2221

2322
### Compulsory parameters
2423

25-
- `"domain"`
26-
- `"owner"` is the resource record owner and can be `"@"` for the root domain or for example `"sub"` for the subdomain `sub.domain.com`
24+
- `"domain"` is the domain to update. It can be `example.com` (root domain) or `sub.example.com` (subdomain of `example.com`).
2725
- `"access_key_id"`
2826
- `"access_secret"`
2927

docs/allinkl.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,7 @@
99
"settings": [
1010
{
1111
"provider": "allinkl",
12-
"domain": "domain.com",
13-
"owner": "sub",
12+
"domain": "sub.domain.com",
1413
"username": "dynXXXXXXX",
1514
"password": "password",
1615
"ip_version": "ipv4",
@@ -22,8 +21,7 @@
2221

2322
### Compulsory parameters
2423

25-
- `"domain"`
26-
- `"owner"` is the resource record owner and can be `"@"` for the root domain or for example `"sub"` for the subdomain `sub.domain.com`
24+
- `"domain"` is the domain to update. It can be `example.com` (root domain) or `sub.example.com` (subdomain of `example.com`).
2725
- `"username"` username (usually starts with dyn followed by numbers)
2826
- `"password"` password in plain text
2927

docs/changeip.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,7 @@
99
"settings": [
1010
{
1111
"provider": "changeip",
12-
"domain": "domain.com",
13-
"owner": "sub",
12+
"domain": "sub.domain.com",
1413
"username": "dynXXXXXXX",
1514
"password": "password",
1615
"ip_version": "ipv4",
@@ -22,8 +21,7 @@
2221

2322
### Compulsory parameters
2423

25-
- `"domain"`
26-
- `"owner"` is the resource record owner and can be `"@"` for the root domain or for example `"sub"` for the subdomain `sub.domain.com`
24+
- `"domain"` is the domain to update. It can be `example.com` (root domain) or `sub.example.com` (subdomain of `example.com`).
2725
- `"username"`
2826
- `"password"`
2927

docs/cloudflare.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@
1111
"provider": "cloudflare",
1212
"zone_identifier": "some id",
1313
"domain": "domain.com",
14-
"owner": "@",
1514
"ttl": 600,
1615
"token": "yourtoken",
1716
"ip_version": "ipv4",
@@ -24,8 +23,7 @@
2423
### Compulsory parameters
2524

2625
- `"zone_identifier"` is the Zone ID of your site, from the domain overview page written as *Zone ID*
27-
- `"domain"`
28-
- `"owner"` is the resource record owner and can be `"@"` for the root domain, `"*"` for the wildcard, or for example `"sub"` for the subdomain `sub.domain.com`
26+
- `"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.
2927
See [this issue comment for context](https://github.com/qdm12/ddns-updater/issues/243#issuecomment-928313949). This is left as is for compatibility.
3028
- `"ttl"` integer value for record TTL in seconds (specify 1 for automatic)
3129
- One of the following ([how to find API keys](https://developers.cloudflare.com/fundamentals/api/get-started/)):

docs/custom.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@ Feel free to open issues to extend its configuration options.
1515
{
1616
"provider": "custom",
1717
"domain": "example.com",
18-
"owner": "@",
1918
"url": "https://example.com/update?domain=example.com&host=@&username=username&client_key=client_key",
2019
"ipv4key": "ipv4",
2120
"ipv6key": "ipv6",
@@ -29,8 +28,7 @@ Feel free to open issues to extend its configuration options.
2928

3029
### Compulsory parameters
3130

32-
- `"domain"` is the domain name to update
33-
- `"owner"` is the resource record owner and can be `"@"` for the root domain, `"*"` for the wildcard, or for example `"sub"` for the subdomain `sub.domain.com`
31+
- `"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.
3432
- `"url"` is the URL to update your records and should contain all the information EXCEPT the IP address to update
3533
- `"ipv4key"` is the URL query parameter name for the IPv4 address, for example `ipv4` will be added to the URL with `&ipv4=1.2.3.4`.
3634
- `"ipv6key"` is the URL query parameter name for the IPv6 address, for example `ipv6` will be added to the URL with `&ipv6=::aaff`. Even if you don't use IPv6, this must be set to something.

docs/dd24.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@
1010
{
1111
"provider": "dd24",
1212
"domain": "domain.com",
13-
"owner": "@",
1413
"password": "password",
1514
"ip_version": "ipv4",
1615
"ipv6_suffix": ""
@@ -21,8 +20,7 @@
2120

2221
### Compulsory parameters
2322

24-
- `"domain"`
25-
- `"owner"` is the resource record owner and can be `"@"` for the root domain or for example `"sub"` for the subdomain `sub.domain.com`
23+
- `"domain"` is the domain to update. It can be `example.com` (root domain) or `sub.example.com` (subdomain of `example.com`).
2624
- `"password"` is your password
2725

2826
### Optional parameters

docs/ddnss.de.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@
1111
"provider": "ddnss",
1212
"provider_ip": true,
1313
"domain": "domain.com",
14-
"owner": "@",
1514
"username": "user",
1615
"password": "password",
1716
"dual_stack": false,
@@ -24,8 +23,7 @@
2423

2524
### Compulsory parameters
2625

27-
- `"domain"`
28-
- `"owner"` is the resource record owner and can be `"@"` for the root domain or for example `"sub"` for the subdomain `sub.domain.com`
26+
- `"domain"` is the domain to update. It can be `example.com` (root domain) or `sub.example.com` (subdomain of `example.com`).
2927
- `"username"`
3028
- `"password"`
3129

docs/desec.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,7 @@
99
"settings": [
1010
{
1111
"provider": "desec",
12-
"domain": "dedyn.io",
13-
"owner": "sub",
12+
"domain": "sub.dedyn.io",
1413
"token": "token",
1514
"ip_version": "ipv4",
1615
"ipv6_suffix": "",
@@ -22,8 +21,7 @@
2221

2322
### Compulsory parameters
2423

25-
- `"domain"`
26-
- `"owner"` is the resource record owner and can be `"@"` for the root domain, `"*"` for the wildcard, or for example `"sub"` for the subdomain `sub.domain.com`
24+
- `"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.
2725
- `"token"` is your token that you can create [here](https://desec.io/tokens)
2826

2927
### Optional parameters

0 commit comments

Comments
 (0)