joker.toml raw

   1  Name = "Joker"
   2  Description = ''''''
   3  URL = "https://joker.com"
   4  Code = "joker"
   5  Since = "v2.6.0"
   6  
   7  Example = '''
   8  # SVC
   9  JOKER_API_MODE=SVC \
  10  JOKER_USERNAME=<your email> \
  11  JOKER_PASSWORD=<your password> \
  12  lego --dns joker -d '*.example.com' -d example.com run
  13  
  14  # DMAPI
  15  JOKER_API_MODE=DMAPI \
  16  JOKER_USERNAME=<your email> \
  17  JOKER_PASSWORD=<your password> \
  18  lego --dns joker -d '*.example.com' -d example.com run
  19  ## or
  20  JOKER_API_MODE=DMAPI \
  21  JOKER_API_KEY=<your API key> \
  22  lego --dns joker -d '*.example.com' -d example.com run
  23  '''
  24  
  25  Additional = '''
  26  ## SVC mode
  27  
  28  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.
  29  
  30  As per [Joker.com documentation](https://joker.com/faq/content/6/496/en/let_s-encrypt-support.html):
  31  
  32  > 1. please log in at Joker.com, visit 'My Domains',
  33  >    find the domain you want to add  Let's Encrypt certificate for, and chose "DNS" in the menu
  34  >
  35  > 2. on the top right, you will find the setting for 'Dynamic DNS'.
  36  >    If not already active, please activate it.
  37  >    It will not affect any other already existing DNS records of this domain.
  38  >
  39  > 3. please take a note of the credentials which are now shown as 'Dynamic DNS Authentication', consisting of a 'username' and a 'password'.
  40  >
  41  > 4. this is all you have to do here - and only once per domain.
  42  '''
  43  
  44  [Configuration]
  45    [Configuration.Credentials]
  46      JOKER_API_MODE = "'DMAPI' or 'SVC'. DMAPI is for resellers accounts. (Default: DMAPI)"
  47      JOKER_USERNAME = "Joker.com username"
  48      JOKER_PASSWORD = "Joker.com password"
  49      JOKER_API_KEY = "API key (only with DMAPI mode)"
  50    [Configuration.Additional]
  51      JOKER_POLLING_INTERVAL = "Time between DNS propagation check in seconds (Default: 2)"
  52      JOKER_PROPAGATION_TIMEOUT = "Maximum waiting time for DNS propagation in seconds (Default: 120)"
  53      JOKER_TTL = "The TTL of the TXT record used for the DNS challenge in seconds (Default: 120)"
  54      JOKER_HTTP_TIMEOUT = "API request timeout in seconds (Default: 60)"
  55      JOKER_SEQUENCE_INTERVAL = "Time between sequential requests in seconds (Default: 60), only with 'SVC' mode"
  56  
  57  [Links]
  58    API = "https://joker.com/faq/category/39/22-dmapi.html"
  59    API_SVC = "https://joker.com/faq/content/6/496/en/let_s-encrypt-support.html"
  60