Back to Lego

Joker

docs/content/dns/zz_gen_joker.md

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

Configuration for Joker.

<!--more-->
  • Code: joker
  • Since: v2.6.0

Here is an example bash command using the Joker provider:

bash
# SVC
JOKER_API_MODE=SVC \
JOKER_USERNAME=<your email> \
JOKER_PASSWORD=<your password> \
lego --dns joker -d '*.example.com' -d example.com run

# DMAPI
JOKER_API_MODE=DMAPI \
JOKER_USERNAME=<your email> \
JOKER_PASSWORD=<your password> \
lego --dns joker -d '*.example.com' -d example.com run
## or
JOKER_API_MODE=DMAPI \
JOKER_API_KEY=<your API key> \
lego --dns joker -d '*.example.com' -d example.com run

Credentials

Environment Variable NameDescription
JOKER_API_KEYAPI key (only with DMAPI mode)
JOKER_API_MODE'DMAPI' or 'SVC'. DMAPI is for resellers accounts. (Default: DMAPI)
JOKER_PASSWORDJoker.com password
JOKER_USERNAMEJoker.com username

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
JOKER_HTTP_TIMEOUTAPI request timeout in seconds (Default: 60)
JOKER_POLLING_INTERVALTime between DNS propagation check in seconds (Default: 2)
JOKER_PROPAGATION_TIMEOUTMaximum waiting time for DNS propagation in seconds (Default: 120)
JOKER_SEQUENCE_INTERVALTime between sequential requests in seconds (Default: 60), only with 'SVC' mode
JOKER_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" %}}).

SVC mode

In the SVC mode, username and passsword are not your email and account passwords, but those displayed in Joker.com domain dashboard when enabling Dynamic DNS.

As per Joker.com documentation:

  1. please log in at Joker.com, visit 'My Domains', find the domain you want to add Let's Encrypt certificate for, and chose "DNS" in the menu

  2. on the top right, you will find the setting for 'Dynamic DNS'. If not already active, please activate it. It will not affect any other already existing DNS records of this domain.

  3. please take a note of the credentials which are now shown as 'Dynamic DNS Authentication', consisting of a 'username' and a 'password'.

  4. this is all you have to do here - and only once per domain.

More information

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