porkbun: Updated documentation and config example

This commit is contained in:
Lenard Hess 2024-02-03 16:12:28 +01:00
parent 5e7609ea2a
commit ae7f92772b
2 changed files with 20 additions and 3 deletions

View file

@ -301,8 +301,9 @@ ssl=yes # use ssl-support. Works with
# protocol=porkbun # protocol=porkbun
# apikey=APIKey # apikey=APIKey
# secretapikey=SecretAPIKey # secretapikey=SecretAPIKey
# root-domain=example.com
# host.example.com,host2.sub.example.com # host.example.com,host2.sub.example.com
# on-root-domain=yes example.com,sub.example.com # example.com,sub.example.com
## ##
## ClouDNS (https://www.cloudns.net) ## ClouDNS (https://www.cloudns.net)

View file

@ -7119,6 +7119,7 @@ Available configuration variables:
* on-root-domain=yes or no (default: no): Indicates whether the specified domain name (FQDN) is * on-root-domain=yes or no (default: no): Indicates whether the specified domain name (FQDN) is
an unnamed record (Zone APEX) in a zone. an unnamed record (Zone APEX) in a zone.
It is useful to specify it as a local variable as shown in the example. It is useful to specify it as a local variable as shown in the example.
This configuration value is deprecated, use root-domain instead!
* usev4, usev6 : These configuration variables can be specified as local variables to override * usev4, usev6 : These configuration variables can be specified as local variables to override
the global settings. It is useful to finely control IPv4 or IPv6 as shown in the example. the global settings. It is useful to finely control IPv4 or IPv6 as shown in the example.
* use (deprecated) : This parameter is deprecated but can be overridden like the above parameters. * use (deprecated) : This parameter is deprecated but can be overridden like the above parameters.
@ -7126,13 +7127,19 @@ Available configuration variables:
Limitations: Limitations:
* Multiple same name records (for round robin) are not supported. * Multiple same name records (for round robin) are not supported.
The same IP address is set for all, creating meaningless extra records. The same IP address is set for all, creating meaningless extra records.
* If neither root-domain nor on-root-domain are specified, ${program} will split the given
hostname into subdomain and domain on the first dot.
For example:
* sub.example.com -> Subdomain "sub", root domain "example.com"
* sub.foo.example.com -> Subdomain "sub", root domain "foo.example.com"
If both root-domain and on-root-domain are specified, root-domain takes precedence.
Example ${program}.conf file entry: Example ${program}.conf file entry:
protocol=porkbun protocol=porkbun
apikey=APIKey apikey=APIKey
secretapikey=SecretAPIKey secretapikey=SecretAPIKey
host.example.com,host2.sub.example.com root-domain=example.com
on-root-domain=yes example.com,sub.example.com example.com,host.example.com,host2.sub.example.com
Additional example to finely control IPv4 or IPv6 : Additional example to finely control IPv4 or IPv6 :
# Example 01 : Global enable both IPv4 and IPv6, and update both records. # Example 01 : Global enable both IPv4 and IPv6, and update both records.
@ -7142,6 +7149,7 @@ Additional example to finely control IPv4 or IPv6 :
protocol=porkbun protocol=porkbun
apikey=APIKey apikey=APIKey
secretapikey=SecretAPIKey secretapikey=SecretAPIKey
root-domain=example.com
host.example.com,host2.sub.example.com host.example.com,host2.sub.example.com
# Example 02 : Global enable only IPv4, and update only IPv6 record. # Example 02 : Global enable only IPv4, and update only IPv6 record.
@ -7150,8 +7158,16 @@ Additional example to finely control IPv4 or IPv6 :
protocol=porkbun protocol=porkbun
apikey=APIKey apikey=APIKey
secretapikey=SecretAPIKey secretapikey=SecretAPIKey
root-domain=example.com
usev6=ifv6, ifv6=enp1s0, usev4=disabled ipv6.example.com usev6=ifv6, ifv6=enp1s0, usev4=disabled ipv6.example.com
# Example 03: Update just a root domain
protocol=porkbun
apikey=APIKey
secretapikey=SecretAPIKey
root-domain=host.example.com
host.example.com
EoEXAMPLE EoEXAMPLE
} }