Commit Graph

7 Commits

Author SHA1 Message Date
Sergey Ponomarev
6b7b5caf54 DNS provider API: structured description
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>
2024-05-18 12:06:41 +03:00
Sebastiaan Hoogeveen
4047adcc35 Force a commit. 2022-05-18 16:12:37 +02:00
Sebastiaan Hoogeveen
5ba2068fc2 Fix dns_nederhost to work correctly with wget instead of curl.
The dns_nederhost DNS API relies on the exact HTTP status code to be
returned (e.g.  204); however, the _get function always returns 200 for a
succesful call when using wget instead of curl.  This patch fixes this by
using the _post function for all requests done by dns_nederhost.
2022-05-16 14:27:24 +02:00
Sebastiaan Hoogeveen
db6db6a4e9 Removed overwriting of the HTTP header file before sending a request. 2019-03-12 14:36:42 +01:00
Sebastiaan Hoogeveen
44dcb0d0a9 Make Travis happy; fixed formatting of return statements. 2019-02-06 11:46:47 +01:00
Sebastiaan Hoogeveen
b3e3e080a9 Cleaned up some of the comments from shellcheck. 2019-02-05 16:37:08 +01:00
Sebastiaan Hoogeveen
1167cdcaec Added DNS API support for NederHost (https://www.nederhost.nl/) 2019-02-05 16:32:41 +01:00