Commit Graph

21 Commits (28afe6f29f1bd6700fbfa7c87a705fd212c635da)

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
AlvinSchiller 7a1f94bc20 set newLastUsedRidForDomainEntry after request was successfull 2022-08-28 20:44:17 +02:00
AlvinSchiller f9320fff8f Changed lastUsedRidForDomainEntry seperator to space 2022-08-27 01:24:16 +02:00
AlvinSchiller c94f9f21af fixed shfmt 2022-08-23 00:28:52 +02:00
AlvinSchiller fc336e3733 fixed RID usage for wildcard domains 2022-08-23 00:04:41 +02:00
AlvinSchiller 281951a86b ShellCheck fixed 2022-08-22 06:51:17 +02:00
AlvinSchiller 35ec3adadc only use SELFHOSTDNS_MAP for configuration of RIDs. detect wildcard domain for use of additional RID 2022-08-22 00:55:05 +02:00
AlvinSchiller b9256a1ba7 changed from *deployconf to *domainconf 2022-08-22 00:55:05 +02:00
AlvinSchiller 734c9a1aa5 Dns Challenge prefix removed. SELFHOSTDNS_MAP entries must be fullpath incl. prefix 2022-08-22 00:55:05 +02:00
AlvinSchiller d4cf03c9fd changes due to inkompabilities of some distros 2022-05-18 11:48:48 +02:00
AlvinSchiller 2cf72bad30 domain lookup for DNS_MAP changed. 2022-05-10 07:09:31 +02:00
AlvinSchiller 227eac10f1 Fix shfmt 2022-04-29 23:05:46 +02:00
AlvinSchiller 1cbd5485e7 Pseudo commit tp trigger Github Actions 2022-04-29 22:53:36 +02:00
AlvinSchiller 610c3cf681 Save domain dependent values in domain.conf after successfull use 2022-04-29 22:26:36 +02:00
AlvinSchiller 96d45cc341 Added variable checks 2022-04-29 22:23:39 +02:00
Marvo2011 d6c68f1a84
Rename delete function, add info 2022-03-28 13:03:02 +02:00
Marvo2011 ac0dd90c37 Fix shfmt 2022-02-17 19:30:56 +01:00
Marvo2011 9470850258 Fix shellcheck, use double quote 2022-02-17 19:08:58 +01:00
Marvo2011 2982e9943e Add custom option to map multidomain RIDs 2022-02-17 19:02:35 +01:00
Marvo2011 62dad721fc Start ShellCheck and CI Test 2022-01-09 11:04:15 +01:00
Marvo2011 cc5cfc7525
Added Selfhost DNS API
+ShellCheck 
+ACME v2 compatible

Example:
- Fist create 2 new TXT records on _acme-challenge.example.com
- Now note the ID in (...) from the edit page behind "_acme-challenge.example.com"

export SELFHOSTDNS_USERNAME=myname
export SELFHOSTDNS_PASSWORD=mypass
export SELFHOSTDNS_RID=id_of_txt_record
export SELFHOSTDNS_RID2=id_of_second_txt_record
acme.sh --issue -d example.com  --dns  dns_selfhost
2022-01-05 15:03:32 +01:00