Instead of using comments declare info in a special variable.
Then the variable can be used to print the DNS API provider usage.
The usage can be parsed on UI and show all needed inputs for options.
The info is stored in plain string that it's both human-readable and easy to parse:
dns_example_info='API name
An extended description.
Multiline.
Domains: list of alternative domains to find
Site: the dns provider website e.g. example.com
Docs: Link to ACME.sh wiki for the provider
Options:
VARIABLE1 Title for the option1.
VARIABLE2 Title for the option2. Default "default value".
VARIABLE3 Title for the option3. Description to show on UI. Optional.
Issues: Link to a support ticket on https://github.com/acmesh-official/acme.sh
Author: First Lastname <authoremail@example.com>, Another Author <https://github.com/example>;
'
Here:
VARIABLE1 will be required.
VARIABLE2 will be required too but will be populated with a "default value".
VARIABLE3 is optional and can be empty.
A DNS provider may have alternative options like CloudFlare may use API KEY or API Token.
You can use a second section OptionsAlt: section.
Some providers may have alternative names or domains e.g. Aliyun and AlibabaCloud.
Add them to Domains: section.
Signed-off-by: Sergey Ponomarev <stokito@gmail.com>
When there are errors with namecheap hosts, acme.sh fails with:
dns_namecheap.sh: line 262: _error: command not found
Based on usage elsewhere in the file, I believe this should be _err
* change arvan api script
* change Author name
* change name actor
* Updated --preferred-chain to issue ISRG properly
To support different openssl crl2pkcs7 help cli format
* dnsapi/pdns: also normalize json response in detecting root zone
* Chain (#3408)
* fix https://github.com/acmesh-official/acme.sh/issues/3384
match the issuer to the root CA cert subject
* fix format
* fix https://github.com/acmesh-official/acme.sh/issues/3384
* remove the alt files. https://github.com/acmesh-official/acme.sh/issues/3384
* upgrade freebsd and solaris
* duckdns - fix "integer expression expected" errors (#3397)
* fix "integer expression expected" errors
* duckdns fix
* Update dns_duckdns.sh
* Update dns_duckdns.sh
* Implement smtp notify hook
Support notifications via direct SMTP server connection.
Uses Python (2.7.x or 3.4+) to communicate with SMTP server.
* Make shfmt happy
(I'm open to better ways of formatting the heredoc
that embeds the Python script.)
* Only save config if send is successful
* Add instructions for reporting bugs
* Prep for curl or Python; clean up SMTP_* variable usage
* Implement curl version of smtp notify-hook
* More than one blank line is an abomination, apparently
I will not try to use whitespace to group code visually
* Fix: Unifi deploy hook support Unifi Cloud Key (#3327)
* fix: unifi deploy hook also update Cloud Key nginx certs
When running on a Unifi Cloud Key device, also deploy to
/etc/ssl/private/cloudkey.{crt,key} and reload nginx. This
makes the new cert available for the Cloud Key management
app running via nginx on port 443 (as well as the port 8443
Unifi Controller app the deploy hook already supported).
Fixes#3326
* Improve settings documentation comments
* Improve Cloud Key pre-flight error messaging
* Fix typo
* Add support for UnifiOS (Cloud Key Gen2)
Since UnifiOS does not use the Java keystore (like a Unifi
Controller or Cloud Key Gen1 deploy), this also reworks
the settings validation and error messaging somewhat.
* PR review fixes
* Detect unsupported Cloud Key java keystore location
* Don't try to restart inactive services
(and remove extra spaces from reload command)
* Clean up error messages and internal variables
* Change to _getdeployconf/_savedeployconf
* Switch from cp to cat to preserve file permissions
* feat: add huaweicloud error handling
* fix: fix freebsd and solaris
* support openssl 3.0
fix https://github.com/acmesh-official/acme.sh/issues/3399
* make the fix for rsa key only
* Use PROJECT_NAME and VER for X-Mailer header
Also add X-Mailer header to Python version
* Add _clearaccountconf_mutable()
* Rework read/save config to not save default values
Add and use _readaccountconf_mutable_default and
_saveaccountconf_mutable_default helpers to capture
common default value handling.
New approach also eliminates need for separate
underscore-prefixed version of each conf var.
* Implement _rfc2822_date helper
* Clean email headers and warn on unsupported address format
Just in case, make sure CR or NL don't end up in
an email header.
* Clarify _readaccountconf_mutable_default
* Add Date email header in Python implementation
* Use email.policy.default in Python 3 implementation
Improves standards compatibility and utf-8 handling
in Python 3.3-3.8. (email.policy.default becomes the
default in Python 3.9.)
* Prefer Python to curl when both available
* Change default SMTP_SECURE to "tls"
Secure by default. Also try to minimize configuration errors.
(Many ESPs/ISPs require STARTTLS, and most support it.)
* Update dns_dp.sh
没有encode中文字符会导致提交失败
* No need to include EC parameters explicitly with the private key.
(they are embedded)
* Fixes response handling and thereby allow issuing of subdomain certs
* Adds comment
* fix https://github.com/acmesh-official/acme.sh/issues/3402
* dnsapi/ionos: Use POST instead of PATCH for adding TXT record
The API now supports a POST route for adding records. Therefore
checking for already existing records and including them in a PATCH
request is no longer necessary.
* fix https://github.com/acmesh-official/acme.sh/issues/3433
* fix https://github.com/acmesh-official/acme.sh/issues/3019
* fix format
* Update dns_servercow.sh to support wildcard certs
Updated dns_servercow.sh to support txt records with multiple entries. This supports wildcard certificates that require txt records with the same name and different contents.
* Update dns_servercow.sh to support wildcard certs
Updated dns_servercow.sh to support txt records with multiple entries. This supports wildcard certificates that require txt records with the same name and different contents.
* fix https://github.com/acmesh-official/acme.sh/issues/3312
* fix format
* feat: add dns_porkbun
* fix: prevent rate limit
Co-authored-by: Vahid Fardi <vahid.fardi@snapp.cab>
Co-authored-by: neil <github@neilpang.com>
Co-authored-by: Gnought <1684105+gnought@users.noreply.github.com>
Co-authored-by: manuel <manuel@mausz.at>
Co-authored-by: jerrm <jerrm@users.noreply.github.com>
Co-authored-by: medmunds <medmunds@gmail.com>
Co-authored-by: Mike Edmunds <github@to.mikeedmunds.com>
Co-authored-by: Easton Man <manyang.me@outlook.com>
Co-authored-by: czeming <loser_wind@163.com>
Co-authored-by: Geert Hendrickx <geert@hendrickx.be>
Co-authored-by: Kristian Johansson <kristian.johansson86@gmail.com>
Co-authored-by: Lukas Brocke <lukas@brocke.net>
Co-authored-by: anom-human <80478363+anom-human@users.noreply.github.com>
Co-authored-by: neil <win10@neilpang.com>
Co-authored-by: Quentin Dreyer <quentin.dreyer@rgsystem.com>
* support jdcloud.com
* fix format
* ttl 3000
* Escape slashes (#2375)
* Change 1.1.1.1 to 1.0.0.1 to probe compatibility (#2330)
As we can see, 1.1.1.1 is not routed or routed to an Intranet devices due to historical reason. Change 1.1.1.1 to 1.0.0.1 will have a better compatibility. I found this problem on my Tencent Cloud server.
* check empty id
* fix error
* Add dnsapi for Vultr (#2370)
* Add Vultr dns api
* PushOver notifications (#2325)
* PushOver notifications, using AppToken, UserKey, and optional sounds
* fix errors
* added dns api support for hexonet (#1776)
* update
* minor
* support new Cloudflare Token format
fix https://github.com/Neilpang/acme.sh/issues/2398
* fix wildcard domain name
* add more info
* fix https://github.com/Neilpang/acme.sh/issues/2377
* fix format
* fix format
* Support for MyDevil.net (#2076)
support mydevil
* Fix verification for namecheap domains not *owned* by the calling user (#2106)
* Peb (#2126)
* support pebble
* support async finalize order
* add Pebble
Sergey Ponomarev
Peter Dave Hello
Bob Belnap
neil
neilpang
Alexander Kulumbeg
dgasaway
neil
Honza Hommer
neil
Timothy Nelson
neilpang
jim-p
LLeny
LLeny