chore(all): rename host to owner

- Retro-compatible change, `host` field still works - Documentation updated to use `owner` field - Code updated to use owner variable name
qdm12 · Jun 27, 2024 · 32fafec · 32fafec
1 parent 711b1ac
commit 32fafec
Show file tree

Hide file tree

Showing 123 changed files with 713 additions and 690 deletions.
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -77,7 +77,7 @@ In more detailed steps:
 
     ```go
     case constants.Example:
-      return example.New(data, domain, host, ipVersion, ipv6Suffix)
+      return example.New(data, domain, owner, ipVersion, ipv6Suffix)
     ```
 
 1. Copy the file [`docs/example.md`](../docs/example.md) to `docs/yourprovider.md` and modify it to fit the configuration and domain setup of your DNS provider. There are a few `<!-- ... -->` comments indicating what to change, please **remove them** when done.

diff --git a/README.md b/README.md
@@ -110,7 +110,7 @@ Program to keep DNS A and/or AAAA records updated for multiple DNS providers
             {
                 "provider": "namecheap",
                 "domain": "example.com",
-                "host": "@",
+                "owner": "@",
                 "password": "e5322165c1d74692bfa6d807100c0310"
             }
         ]
@@ -155,7 +155,7 @@ Program to keep DNS A and/or AAAA records updated for multiple DNS providers
             {
                 "provider": "namecheap",
                 "domain": "example.com",
-                "host": "@",
+                "owner": "@",
                 "password": "e5322165c1d74692bfa6d807100c0310"
             }
         ]
@@ -245,7 +245,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 `"host": "@,subdomain1,subdomain2",`.
+- you can specify multiple hosts for the same domain using a comma separated list. For example with `"owner": "@,subdomain1,subdomain2",`.
 
 ### Environment variables
 

diff --git a/cmd/updater/main.go b/cmd/updater/main.go
@@ -319,10 +319,10 @@ func readRecords(providers []provider.Provider, persistentDB *persistence.Databa
 	records = make([]recordslib.Record, len(providers))
 	for i, provider := range providers {
 		logger.Info("Reading history from database: domain " +
-			provider.Domain() + " host " + provider.Host() +
+			provider.Domain() + " owner " + provider.Owner() +
 			" " + provider.IPVersion().String())
 		events, err := persistentDB.GetEvents(provider.Domain(),
-			provider.Host(), provider.IPVersion())
+			provider.Owner(), provider.IPVersion())
 		if err != nil {
 			shoutrrrClient.Notify(err.Error())
 			return nil, err

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

diff --git a/docs/aliyun.md b/docs/aliyun.md
@@ -10,7 +10,7 @@
     {
       "provider": "aliyun",
       "domain": "domain.com",
-      "host": "@",
+      "owner": "@",
       "access_key_id": "your access_key_id",
       "access_secret": "your access_secret",
       "ip_version": "ipv4",
@@ -23,7 +23,7 @@
 ### Compulsory parameters
 
 - `"domain"`
-- `"host"` is your host and can be a subdomain or `"@"`
+- `"owner"` is the resource record owner and can be `"@"` for the root domain or for example `"sub"` for the subdomain `sub.domain.com`
 - `"access_key_id"`
 - `"access_secret"`
 

diff --git a/docs/allinkl.md b/docs/allinkl.md
@@ -10,7 +10,7 @@
     {
       "provider": "allinkl",
       "domain": "domain.com",
-      "host": "host",
+      "owner": "sub",
       "username": "dynXXXXXXX",
       "password": "password",
       "ip_version": "ipv4",
@@ -23,7 +23,7 @@
 ### Compulsory parameters
 
 - `"domain"`
-- `"host"` is your host (subdomain)
+- `"owner"` is the resource record owner and can be `"@"` for the root domain or for example `"sub"` for the subdomain `sub.domain.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
@@ -10,7 +10,7 @@
     {
       "provider": "changeip",
       "domain": "domain.com",
-      "host": "host",
+      "owner": "sub",
       "username": "dynXXXXXXX",
       "password": "password",
       "ip_version": "ipv4",
@@ -23,7 +23,7 @@
 ### Compulsory parameters
 
 - `"domain"`
-- `"host"` is your host (subdomain)
+- `"owner"` is the resource record owner and can be `"@"` for the root domain or for example `"sub"` for the subdomain `sub.domain.com`
 - `"username"`
 - `"password"`
 

diff --git a/docs/cloudflare.md b/docs/cloudflare.md
@@ -11,7 +11,7 @@
       "provider": "cloudflare",
       "zone_identifier": "some id",
       "domain": "domain.com",
-      "host": "@",
+      "owner": "@",
       "ttl": 600,
       "token": "yourtoken",
       "ip_version": "ipv4",
@@ -25,7 +25,7 @@
 
 - `"zone_identifier"` is the Zone ID of your site, from the domain overview page written as *Zone ID*
 - `"domain"`
-- `"host"` is your host and can be `"@"`, a subdomain or the wildcard `"*"`.
+- `"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`
 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,7 @@ Feel free to open issues to extend its configuration options.
     {
       "provider": "custom",
       "domain": "example.com",
-      "host": "@",
+      "owner": "@",
       "url": "https://example.com/update?domain=example.com&host=@&username=username&client_key=client_key",
       "ipv4key": "ipv4",
       "ipv6key": "ipv6",
@@ -30,7 +30,7 @@ Feel free to open issues to extend its configuration options.
 ### Compulsory parameters
 
 - `"domain"` is the domain name to update
-- `"host"` is the host to update, which can be `"@"` (root), `"*"` or a subdomain
+- `"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`
 - `"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,7 @@
     {
       "provider": "dd24",
       "domain": "domain.com",
-      "host": "@",
+      "owner": "@",
       "password": "password",
       "ip_version": "ipv4",
       "ipv6_suffix": ""
@@ -22,7 +22,7 @@
 ### Compulsory parameters
 
 - `"domain"`
-- `"host"` is your host and can be a subdomain or `"@"`
+- `"owner"` is the resource record owner and can be `"@"` for the root domain or for example `"sub"` for the subdomain `sub.domain.com`
 - `"password"` is your password
 
 ### Optional parameters

diff --git a/docs/ddnss.de.md b/docs/ddnss.de.md
@@ -11,7 +11,7 @@
       "provider": "ddnss",
       "provider_ip": true,
       "domain": "domain.com",
-      "host": "@",
+      "owner": "@",
       "username": "user",
       "password": "password",
       "dual_stack": false,
@@ -25,7 +25,7 @@
 ### Compulsory parameters
 
 - `"domain"`
-- `"host"` is your host and can be a subdomain or `"@"`
+- `"owner"` is the resource record owner and can be `"@"` for the root domain or for example `"sub"` for the subdomain `sub.domain.com`
 - `"username"`
 - `"password"`
 

diff --git a/docs/desec.md b/docs/desec.md
@@ -10,7 +10,7 @@
     {
       "provider": "desec",
       "domain": "dedyn.io",
-      "host": "host",
+      "owner": "sub",
       "token": "token",
       "ip_version": "ipv4",
       "ipv6_suffix": "",
@@ -23,7 +23,7 @@
 ### Compulsory parameters
 
 - `"domain"`
-- `"host"` can be `@` for the root domain or a subdomain or a wildcard subdomain (`*`), defaults to `@`
+- `"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`
 - `"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,7 @@
     {
       "provider": "digitalocean",
       "domain": "domain.com",
-      "host": "@",
+      "owner": "@",
       "token": "yourtoken",
       "ip_version": "ipv4",
       "ipv6_suffix": ""
@@ -22,7 +22,7 @@
 ### Compulsory parameters
 
 - `"domain"`
-- `"host"` is your host and can be a subdomain or `"@"` or `"*"`
+- `"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`
 - `"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,7 @@
     {
       "provider": "dnsomatic",
       "domain": "domain.com",
-      "host": "@",
+      "owner": "@",
       "username": "username",
       "password": "password",
       "provider_ip": true,
@@ -24,7 +24,7 @@
 ### Compulsory parameters
 
 - `"domain"`
-- `"host"` is your host and can be a subdomain or `"@"` or `"*"`
+- `"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`
 - `"username"`
 - `"password"`
 - `"provider_ip"`

diff --git a/docs/dnspod.md b/docs/dnspod.md
@@ -10,7 +10,7 @@
     {
       "provider": "dnspod",
       "domain": "domain.com",
-      "host": "@",
+      "owner": "@",
       "token": "yourtoken",
       "ip_version": "ipv4",
       "ipv6_suffix": ""
@@ -22,7 +22,7 @@
 ### Compulsory parameters
 
 - `"domain"`
-- `"host"` is your host and can be a subdomain or `"@"`
+- `"owner"` is the resource record owner and can be `"@"` for the root domain or for example `"sub"` for the subdomain `sub.domain.com`
 - `"token"`
 
 ### Optional parameters

diff --git a/docs/dondominio.md b/docs/dondominio.md
@@ -10,7 +10,7 @@
     {
       "provider": "dondominio",
       "domain": "domain.com",
-      "host": "@",
+      "owner": "@",
       "name": "something",
       "username": "username",
       "key": "key",
@@ -24,7 +24,7 @@
 ### Compulsory parameters
 
 - `"domain"`
-- `"host"` is the subdomain to update which can be `@`, `*` or a subdomain
+- `"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`
 - `"name"` is the name of the service/hosting
 - `"username"`
 - `"password"`

diff --git a/docs/dreamhost.md b/docs/dreamhost.md
@@ -10,7 +10,7 @@
     {
       "provider": "dreamhost",
       "domain": "domain.com",
-      "host": "@",
+      "owner": "@",
       "key": "key",
       "ip_version": "ipv4",
       "ipv6_suffix": ""
@@ -26,7 +26,7 @@
 
 ### Optional parameters
 
-- `"host"` is your host and can be a subdomain or `"@"`. It defaults to `"@"`.
+- `"owner"` is the resource record owner and can be `"@"` for the root domain or for example `"sub"` for the subdomain `sub.domain.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",
-      "host": "host",
+      "owner": "sub",
       "token": "token",
       "ip_version": "ipv4",
       "ipv6_suffix": "",
@@ -21,7 +21,7 @@
 
 ### Compulsory parameters
 
-- `"host"` is your host, for example `subdomain` for `subdomain.duckdns.org`
+- `"owner"` is the resource record owner and can be for example `"sub"` for the domain `sub.duckdns.org`
 - `"token"`
 
 ### Optional parameters

diff --git a/docs/dyndns.md b/docs/dyndns.md
@@ -10,7 +10,7 @@
     {
       "provider": "dyn",
       "domain": "domain.com",
-      "host": "@",
+      "owner": "@",
       "username": "username",
       "client_key": "client_key",
       "ip_version": "ipv4",
@@ -23,7 +23,7 @@
 ### Compulsory parameters
 
 - `"domain"`
-- `"host"` is your host and can be a subdomain or `"@"` or `"*"`
+- `"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`
 - `"username"`
 - `"client_key"`
 

diff --git a/docs/dynu.md b/docs/dynu.md
@@ -10,7 +10,7 @@
     {
       "provider": "dynu",
       "domain": "domain.com",
-      "host": "@",
+      "owner": "@",
       "group": "group",
       "username": "username",
       "password": "password",
@@ -25,7 +25,7 @@
 ### Compulsory parameters
 
 - `"domain"`
-- `"host"` is your host and can be a subdomain or `"@"`
+- `"owner"` is the resource record owner and can be `"@"` for the root domain or for example `"sub"` for the subdomain `sub.domain.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,7 @@
     {
       "provider": "dynv6",
       "domain": "domain.com",
-      "host": "@",
+      "owner": "@",
       "token": "token",
       "ip_version": "ipv4",
       "ipv6_suffix": "",
@@ -23,7 +23,7 @@
 ### Compulsory parameters
 
 - `"domain"`
-- `"host"` is your host and can be a subdomain or `"@"`
+- `"owner"` is the resource record owner and can be `"@"` for the root domain or for example `"sub"` for the subdomain `sub.domain.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,7 @@
     {
       "provider": "easydns",
       "domain": "domain.com",
-      "host": "@",
+      "owner": "@",
       "username": "username",
       "token": "token",
       "ip_version": "ipv4",
@@ -24,7 +24,7 @@
 ### Compulsory parameters
 
 - `"domain"`
-- `"host"` is your host and can be a subdomain or `"@"` or `"*"`
+- `"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`
 - `"username"`
 - `"token"`