Back to Lego

Octenium

docs/content/dns/zz_gen_octenium.md

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

Configuration for Octenium.

<!--more-->
  • Code: octenium
  • Since: v4.27.0

Here is an example bash command using the Octenium provider:

bash
OCTENIUM_API_KEY="xxx" \
lego --dns octenium -d '*.example.com' -d example.com run

Credentials

Environment Variable NameDescription
OCTENIUM_API_KEYAPI key

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
OCTENIUM_HTTP_TIMEOUTAPI request timeout in seconds (Default: 30)
OCTENIUM_POLLING_INTERVALTime between DNS propagation check in seconds (Default: 2)
OCTENIUM_PROPAGATION_TIMEOUTMaximum waiting time for DNS propagation in seconds (Default: 60)
OCTENIUM_TTLThe TTL of the TXT record used for the DNS challenge in seconds (Default: 120)

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" %}}).

More information

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