Back to Lego

Spaceship

docs/content/dns/zz_gen_spaceship.md

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

Configuration for Spaceship.

<!--more-->
  • Code: spaceship
  • Since: v4.22.0

Here is an example bash command using the Spaceship provider:

bash
SPACESHIP_API_KEY="xxxxxxxxxxxxxxxxxxxxx" \
SPACESHIP_API_SECRET="xxxxxxxxxxxxxxxxxxxxx" \
lego --dns spaceship -d '*.example.com' -d example.com run

Credentials

Environment Variable NameDescription
SPACESHIP_API_KEYAPI key
SPACESHIP_API_SECRETAPI secret

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
SPACESHIP_HTTP_TIMEOUTAPI request timeout in seconds (Default: 30)
SPACESHIP_POLLING_INTERVALTime between DNS propagation check in seconds (Default: 2)
SPACESHIP_PROPAGATION_TIMEOUTMaximum waiting time for DNS propagation in seconds (Default: 60)
SPACESHIP_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/spaceship/spaceship.toml --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->