CPanel/WHM :: Let’s Encrypt client and ACME library written in Go.
Author: Lego Team
Description: Configuration for CPanel/WHM.
Date: 2019-03-03T16:39:46+01:00

# CPanel/WHM

Configuration for CPanel/WHM.

- Code: `cpanel`
- Since: v4.16.0

Here is an example bash command using the CPanel/WHM provider:

    ### CPANEL (default)

    CPANEL_USERNAME = "yyyy"
    CPANEL_TOKEN = "xxxx"
    CPANEL_BASE_URL = "https://example.com:2083" \
    lego --email you@example.com --dns cpanel -d '*.example.com' -d example.com run

    ## WHM

    CPANEL_MODE = whm
    CPANEL_USERNAME = "yyyy"
    CPANEL_TOKEN = "xxxx"
    CPANEL_BASE_URL = "https://example.com:2087" \
    lego --email you@example.com --dns cpanel -d '*.example.com' -d example.com run

## Credentials

Environment Variable Name | Description
--- | ---
`CPANEL_BASE_URL` | API server URL
`CPANEL_TOKEN` | API token
`CPANEL_USERNAME` | username

The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. More information here.

## Additional Configuration

Environment Variable Name | Description
--- | ---
`CPANEL_HTTP_TIMEOUT` | API request timeout in seconds (Default: 30)
`CPANEL_MODE` | use cpanel API or WHM API (Default: cpanel)
`CPANEL_POLLING_INTERVAL` | Time between DNS propagation check in seconds (Default: 2)
`CPANEL_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation in seconds (Default: 120)
`CPANEL_TTL` | The TTL of the TXT record used for the DNS challenge in seconds (Default: 300)

The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. More information here.

## More information