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
qdm12 · Jun 27, 2024 · 07d7645 · 07d7645
1 parent 55d8c0d
commit 07d7645
Show file tree

Hide file tree

Showing 51 changed files with 175 additions and 169 deletions.
diff --git a/README.md b/README.md
@@ -120,8 +120,7 @@ This readme and the [docs/](docs/) directory are **versioned** to match the prog
         "settings": [
             {
                 "provider": "namecheap",
-                "domain": "example.com",
-                "owner": "@",
+                "domain": "sub.example.com",
                 "password": "e5322165c1d74692bfa6d807100c0310"
             }
         ]
@@ -165,8 +164,7 @@ This readme and the [docs/](docs/) directory are **versioned** to match the prog
         "settings": [
             {
                 "provider": "namecheap",
-                "domain": "example.com",
-                "owner": "@",
+                "domain": "sub.example.com",
                 "password": "e5322165c1d74692bfa6d807100c0310"
             }
         ]
@@ -256,7 +254,7 @@ Check the documentation for your DNS provider:
 
 Note that:
 
-- you can specify multiple hosts for the same domain using a comma separated list. For example with `"owner": "@,subdomain1,subdomain2",`.
+- 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",`.
 
 ### Environment variables
 

diff --git a/config.json b/config.json
@@ -3,7 +3,6 @@
         {
             "provider": "namecheap",
             "domain": "example.com",
-            "owner": "@",
             "password": "e5322165c1d74692bfa6d807100c0310"
         },
         {
@@ -13,8 +12,7 @@
         },
         {
             "provider": "godaddy",
-            "domain": "example.org",
-            "owner": "subdomain",
+            "domain": "subdomain.example.org",
             "key": "aaaaaaaaaaaaaaaa",
             "secret": "aaaaaaaaaaaaaaaa"
         },

diff --git a/docs/aliyun.md b/docs/aliyun.md
@@ -10,7 +10,6 @@
     {
       "provider": "aliyun",
       "domain": "domain.com",
-      "owner": "@",
       "access_key_id": "your access_key_id",
       "access_secret": "your access_secret",
       "ip_version": "ipv4",
@@ -22,8 +21,7 @@
 
 ### Compulsory parameters
 
-- `"domain"`
-- `"owner"` is the resource record owner and can be `"@"` for the root domain or for example `"sub"` for the subdomain `sub.domain.com`
+- `"domain"` is the domain to update. It can be `example.com` (root domain) or `sub.example.com` (subdomain of `example.com`).
 - `"access_key_id"`
 - `"access_secret"`
 

diff --git a/docs/allinkl.md b/docs/allinkl.md
@@ -9,8 +9,7 @@
   "settings": [
     {
       "provider": "allinkl",
-      "domain": "domain.com",
-      "owner": "sub",
+      "domain": "sub.domain.com",
       "username": "dynXXXXXXX",
       "password": "password",
       "ip_version": "ipv4",
@@ -22,8 +21,7 @@
 
 ### Compulsory parameters
 
-- `"domain"`
-- `"owner"` is the resource record owner and can be `"@"` for the root domain or for example `"sub"` for the subdomain `sub.domain.com`
+- `"domain"` is the domain to update. It can be `example.com` (root domain) or `sub.example.com` (subdomain of `example.com`).
 - `"username"` username (usually starts with dyn followed by numbers)
 - `"password"` password in plain text
 

diff --git a/docs/changeip.md b/docs/changeip.md
@@ -9,8 +9,7 @@
   "settings": [
     {
       "provider": "changeip",
-      "domain": "domain.com",
-      "owner": "sub",
+      "domain": "sub.domain.com",
       "username": "dynXXXXXXX",
       "password": "password",
       "ip_version": "ipv4",
@@ -22,8 +21,7 @@
 
 ### Compulsory parameters
 
-- `"domain"`
-- `"owner"` is the resource record owner and can be `"@"` for the root domain or for example `"sub"` for the subdomain `sub.domain.com`
+- `"domain"` is the domain to update. It can be `example.com` (root domain) or `sub.example.com` (subdomain of `example.com`).
 - `"username"`
 - `"password"`
 

diff --git a/docs/cloudflare.md b/docs/cloudflare.md
@@ -11,7 +11,6 @@
       "provider": "cloudflare",
       "zone_identifier": "some id",
       "domain": "domain.com",
-      "owner": "@",
       "ttl": 600,
       "token": "yourtoken",
       "ip_version": "ipv4",
@@ -24,8 +23,7 @@
 ### Compulsory parameters
 
 - `"zone_identifier"` is the Zone ID of your site, from the domain overview page written as *Zone ID*
-- `"domain"`
-- `"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`
+- `"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.
 See [this issue comment for context](https://github.com/qdm12/ddns-updater/issues/243#issuecomment-928313949). This is left as is for compatibility.
 - `"ttl"` integer value for record TTL in seconds (specify 1 for automatic)
 - One of the following ([how to find API keys](https://developers.cloudflare.com/fundamentals/api/get-started/)):

diff --git a/docs/custom.md b/docs/custom.md
@@ -15,7 +15,6 @@ Feel free to open issues to extend its configuration options.
     {
       "provider": "custom",
       "domain": "example.com",
-      "owner": "@",
       "url": "https://example.com/update?domain=example.com&host=@&username=username&client_key=client_key",
       "ipv4key": "ipv4",
       "ipv6key": "ipv6",
@@ -29,8 +28,7 @@ Feel free to open issues to extend its configuration options.
 
 ### Compulsory parameters
 
-- `"domain"` is the domain name to update
-- `"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`
+- `"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.
 - `"url"` is the URL to update your records and should contain all the information EXCEPT the IP address to update
 - `"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`.
 - `"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.

diff --git a/docs/dd24.md b/docs/dd24.md
@@ -10,7 +10,6 @@
     {
       "provider": "dd24",
       "domain": "domain.com",
-      "owner": "@",
       "password": "password",
       "ip_version": "ipv4",
       "ipv6_suffix": ""
@@ -21,8 +20,7 @@
 
 ### Compulsory parameters
 
-- `"domain"`
-- `"owner"` is the resource record owner and can be `"@"` for the root domain or for example `"sub"` for the subdomain `sub.domain.com`
+- `"domain"` is the domain to update. It can be `example.com` (root domain) or `sub.example.com` (subdomain of `example.com`).
 - `"password"` is your password
 
 ### Optional parameters

diff --git a/docs/ddnss.de.md b/docs/ddnss.de.md
@@ -11,7 +11,6 @@
       "provider": "ddnss",
       "provider_ip": true,
       "domain": "domain.com",
-      "owner": "@",
       "username": "user",
       "password": "password",
       "dual_stack": false,
@@ -24,8 +23,7 @@
 
 ### Compulsory parameters
 
-- `"domain"`
-- `"owner"` is the resource record owner and can be `"@"` for the root domain or for example `"sub"` for the subdomain `sub.domain.com`
+- `"domain"` is the domain to update. It can be `example.com` (root domain) or `sub.example.com` (subdomain of `example.com`).
 - `"username"`
 - `"password"`
 

diff --git a/docs/desec.md b/docs/desec.md
@@ -9,8 +9,7 @@
   "settings": [
     {
       "provider": "desec",
-      "domain": "dedyn.io",
-      "owner": "sub",
+      "domain": "sub.dedyn.io",
       "token": "token",
       "ip_version": "ipv4",
       "ipv6_suffix": "",
@@ -22,8 +21,7 @@
 
 ### Compulsory parameters
 
-- `"domain"`
-- `"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`
+- `"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.
 - `"token"` is your token that you can create [here](https://desec.io/tokens)
 
 ### Optional parameters

diff --git a/docs/digitalocean.md b/docs/digitalocean.md
@@ -10,7 +10,6 @@
     {
       "provider": "digitalocean",
       "domain": "domain.com",
-      "owner": "@",
       "token": "yourtoken",
       "ip_version": "ipv4",
       "ipv6_suffix": ""
@@ -21,8 +20,7 @@
 
 ### Compulsory parameters
 
-- `"domain"`
-- `"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`
+- `"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.
 - `"token"` is your token that you can create [here](https://cloud.digitalocean.com/settings/applications)
 
 ### Optional parameters

diff --git a/docs/dnsomatic.md b/docs/dnsomatic.md
@@ -10,7 +10,6 @@
     {
       "provider": "dnsomatic",
       "domain": "domain.com",
-      "owner": "@",
       "username": "username",
       "password": "password",
       "provider_ip": true,
@@ -23,8 +22,7 @@
 
 ### Compulsory parameters
 
-- `"domain"`
-- `"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`
+- `"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"`
 - `"provider_ip"`

diff --git a/docs/dnspod.md b/docs/dnspod.md
@@ -10,7 +10,6 @@
     {
       "provider": "dnspod",
       "domain": "domain.com",
-      "owner": "@",
       "token": "yourtoken",
       "ip_version": "ipv4",
       "ipv6_suffix": ""
@@ -21,8 +20,7 @@
 
 ### Compulsory parameters
 
-- `"domain"`
-- `"owner"` is the resource record owner and can be `"@"` for the root domain or for example `"sub"` for the subdomain `sub.domain.com`
+- `"domain"` is the domain to update. It can be `example.com` (root domain) or `sub.example.com` (subdomain of `example.com`).
 - `"token"`
 
 ### Optional parameters

diff --git a/docs/dondominio.md b/docs/dondominio.md
@@ -10,7 +10,6 @@
     {
       "provider": "dondominio",
       "domain": "domain.com",
-      "owner": "@",
       "name": "something",
       "username": "username",
       "key": "key",
@@ -23,8 +22,7 @@
 
 ### Compulsory parameters
 
-- `"domain"`
-- `"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`
+- `"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.
 - `"name"` is the name of the service/hosting
 - `"username"`
 - `"password"`

diff --git a/docs/dreamhost.md b/docs/dreamhost.md
@@ -10,7 +10,6 @@
     {
       "provider": "dreamhost",
       "domain": "domain.com",
-      "owner": "@",
       "key": "key",
       "ip_version": "ipv4",
       "ipv6_suffix": ""
@@ -26,7 +25,7 @@
 
 ### Optional parameters
 
-- `"owner"` is the resource record owner and can be `"@"` for the root domain or for example `"sub"` for the subdomain `sub.domain.com`
+- `"domain"` is the domain to update. It can be `example.com` (root domain) or `sub.example.com` (subdomain of `example.com`).
 - `"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.
 

diff --git a/docs/duckdns.md b/docs/duckdns.md
@@ -9,7 +9,7 @@
   "settings": [
     {
       "provider": "duckdns",
-      "owner": "sub",
+      "domain": "sub.duckdns.org",
       "token": "token",
       "ip_version": "ipv4",
       "ipv6_suffix": "",
@@ -21,7 +21,7 @@
 
 ### Compulsory parameters
 
-- `"owner"` is the resource record owner and can be for example `"sub"` for the domain `sub.duckdns.org`
+- `"domain"` is the domain to update. For example, for the owner/host `sub`, it would be `sub.duckdns.org`. The [eTLD+1](https://developer.mozilla.org/en-US/docs/Glossary/eTLD) must be `duckdns.org`.
 - `"token"`
 
 ### Optional parameters

diff --git a/docs/dyndns.md b/docs/dyndns.md
@@ -10,7 +10,6 @@
     {
       "provider": "dyn",
       "domain": "domain.com",
-      "owner": "@",
       "username": "username",
       "client_key": "client_key",
       "ip_version": "ipv4",
@@ -22,8 +21,7 @@
 
 ### Compulsory parameters
 
-- `"domain"`
-- `"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`
+- `"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"`
 - `"client_key"`
 

diff --git a/docs/dynu.md b/docs/dynu.md
@@ -10,7 +10,6 @@
     {
       "provider": "dynu",
       "domain": "domain.com",
-      "owner": "@",
       "group": "group",
       "username": "username",
       "password": "password",
@@ -24,8 +23,7 @@
 
 ### Compulsory parameters
 
-- `"domain"`
-- `"owner"` is the resource record owner and can be `"@"` for the root domain or for example `"sub"` for the subdomain `sub.domain.com`
+- `"domain"` is the domain to update. It can be `example.com` (root domain) or `sub.example.com` (subdomain of `example.com`).
 - `"username"`
 - `"password"` could be plain text or password in MD5 or SHA256 format (There's also an option for setting a password for IP Update only)
 

diff --git a/docs/dynv6.md b/docs/dynv6.md
@@ -10,7 +10,6 @@
     {
       "provider": "dynv6",
       "domain": "domain.com",
-      "owner": "@",
       "token": "token",
       "ip_version": "ipv4",
       "ipv6_suffix": "",
@@ -22,8 +21,7 @@
 
 ### Compulsory parameters
 
-- `"domain"`
-- `"owner"` is the resource record owner and can be `"@"` for the root domain or for example `"sub"` for the subdomain `sub.domain.com`
+- `"domain"` is the domain to update. It can be `example.com` (root domain) or `sub.example.com` (subdomain of `example.com`).
 - `"token"` that you can obtain [here](https://dynv6.com/keys#token)
 
 ### Optional parameters

diff --git a/docs/easydns.md b/docs/easydns.md
@@ -10,7 +10,6 @@
     {
       "provider": "easydns",
       "domain": "domain.com",
-      "owner": "@",
       "username": "username",
       "token": "token",
       "ip_version": "ipv4",
@@ -23,8 +22,7 @@
 
 ### Compulsory parameters
 
-- `"domain"`
-- `"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`
+- `"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"`
 - `"token"`
 

diff --git a/docs/example.md b/docs/example.md
@@ -12,7 +12,6 @@
     {
       "provider": "example",
       "domain": "domain.com",
-      "owner": "@",
       "username": "username",
       "password": "password",
       "ip_version": "ipv4",
@@ -24,8 +23,7 @@
 
 ### Compulsory parameters
 
-- `"domain"`
-- `"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`
+- `"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"`