Back to Lego

Openprovider

docs/content/dns/zz_gen_openprovider.md

5.3.12.0 KB
Original Source
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- providers/dns/openprovider/openprovider.toml --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->

Configuration for Openprovider.

<!--more-->
  • Code: openprovider
  • Since: v5.3.0

Here is an example bash command using the Openprovider provider:

bash
OPENPROVIDER_USERNAME="xxx" \
OPENPROVIDER_PASSWORD="yyy" \
lego run --dns openprovider -d '*.example.com' -d example.com

Credentials

Environment Variable NameDescription
OPENPROVIDER_PASSWORDThe user's password
OPENPROVIDER_USERNAMEThe user's name

The environment variable names can be suffixed by _FILE to reference a file instead of a value. More information [here]({{% ref "dns#configuration-and-credentials" %}}).

Additional Configuration

Environment Variable NameDescription
OPENPROVIDER_HTTP_TIMEOUTAPI request timeout in seconds (Default: 30)
OPENPROVIDER_POLLING_INTERVALTime between DNS propagation check in seconds (Default: 10)
OPENPROVIDER_PROPAGATION_TIMEOUTMaximum waiting time for DNS propagation in seconds (Default: 600)
OPENPROVIDER_TTLThe TTL of the TXT record used for the DNS challenge in seconds (Default: 600)

The environment variable names can be suffixed by _FILE to reference a file instead of a value. More information [here]({{% ref "dns#configuration-and-credentials" %}}).

{{% notice style="warning" %}}

The provider is only available for resellers because the Openprovider API is only available for resellers.

{{% /notice %}}

More information

<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- providers/dns/openprovider/openprovider.toml --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->