Back to Lego

Katapult

docs/content/dns/zz_gen_katapult.md

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

Configuration for Katapult.

<!--more-->
  • Code: katapult
  • Since: v5.0.0

Here is an example bash command using the Katapult provider:

bash
KATAPULT_API_KEY="xxxxxxxxxxxxxxxxxxxxx" \
lego run --dns katapult -d '*.example.com' -d example.com

Credentials

Environment Variable NameDescription
KATAPULT_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
KATAPULT_HTTP_TIMEOUTAPI request timeout in seconds (Default: 30)
KATAPULT_POLLING_INTERVALTime between DNS propagation check in seconds (Default: 2)
KATAPULT_PROPAGATION_TIMEOUTMaximum waiting time for DNS propagation in seconds (Default: 60)
KATAPULT_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/katapult/katapult.toml --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->