Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Structured DNS provider API info #4738

Merged
merged 1 commit into from
May 19, 2024
Merged

Commits on May 18, 2024

  1. 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>
    stokito committed May 18, 2024
    Configuration menu
    Copy the full SHA
    6b7b5ca View commit details
    Browse the repository at this point in the history