cpanel.toml raw

   1  Name = "CPanel/WHM"
   2  Description = ''''''
   3  URL = "https://cpanel.net/"
   4  Code = "cpanel"
   5  Since = "v4.16.0"
   6  
   7  Example = '''
   8  ### CPANEL (default)
   9  
  10  CPANEL_USERNAME="yyyy" \
  11  CPANEL_TOKEN="xxxx" \
  12  CPANEL_BASE_URL="https://example.com:2083" \
  13  lego --dns cpanel -d '*.example.com' -d example.com run
  14  
  15  ## WHM
  16  
  17  CPANEL_MODE=whm \
  18  CPANEL_USERNAME="yyyy" \
  19  CPANEL_TOKEN="xxxx" \
  20  CPANEL_BASE_URL="https://example.com:2087" \
  21  lego --dns cpanel -d '*.example.com' -d example.com run
  22  '''
  23  
  24  [Configuration]
  25    [Configuration.Credentials]
  26      CPANEL_USERNAME = "username"
  27      CPANEL_TOKEN = "API token"
  28      CPANEL_BASE_URL = "API server URL"
  29    [Configuration.Additional]
  30      CPANEL_MODE = "use cpanel API or WHM API (Default: cpanel)"
  31      CPANEL_POLLING_INTERVAL = "Time between DNS propagation check in seconds (Default: 2)"
  32      CPANEL_PROPAGATION_TIMEOUT = "Maximum waiting time for DNS propagation in seconds (Default: 120)"
  33      CPANEL_TTL = "The TTL of the TXT record used for the DNS challenge in seconds (Default: 300)"
  34      CPANEL_HTTP_TIMEOUT = "API request timeout in seconds (Default: 30)"
  35  
  36  [Links]
  37    API_CPANEL = "https://api.docs.cpanel.net/cpanel/introduction/"
  38    API_WHM = "https://api.docs.cpanel.net/whm/introduction/"
  39