Skip to content

Commit

Permalink
badjware#11: legacy format is not supported in Certbot 2.x. Update RE…
Browse files Browse the repository at this point in the history
…ADME
  • Loading branch information
jefft committed Jul 22, 2023
1 parent a774ed9 commit ef99a7e
Showing 1 changed file with 14 additions and 14 deletions.
28 changes: 14 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ Plugin to allow acme dns-01 authentication of a name managed in cPanel. Useful f
## Named Arguments
| Argument | Description |
| --- | --- |
| --certbot-dns-cpanel:cpanel-credentials <file> | cPanel credentials INI file **(required)** |
| --certbot-dns-cpanel:cpanel-propagation-seconds <seconds> | The number of seconds to wait for DNS to propagate before asking the ACME server to verify the DNS record (Default: 30) |
| --cpanel-credentials <file> | cPanel credentials INI file **(required)** |
| --cpanel-propagation-seconds <seconds> | The number of seconds to wait for DNS to propagate before asking the ACME server to verify the DNS record (Default: 30) |

## Install
``` bash
Expand All @@ -18,22 +18,22 @@ Download the file `credentials.ini.example` and rename it to `credentials.ini`.
```
# The url cPanel url
# include the scheme and the port number (usually 2083 for https)
certbot_dns_cpanel:cpanel_url = https://cpanel.example.com:2083
cpanel_url = https://cpanel.example.com:2083
# The cPanel username
certbot_dns_cpanel:cpanel_username = user
cpanel_username = user
# The cPanel password
certbot_dns_cpanel:cpanel_password = hunter2
cpanel_password = hunter2
```

## Example
You can now run certbot using the plugin and feeding the credentials file.
For example, to get a wildcard certificate for *.example.com and example.com:
``` bash
certbot certonly \
--authenticator certbot-dns-cpanel:cpanel \
--certbot-dns-cpanel:cpanel-credentials /path/to/credentials.ini \
--authenticator cpanel \
--cpanel-credentials /path/to/credentials.ini \
-d 'example.com' \
-d '*.example.com'
```
Expand All @@ -42,9 +42,9 @@ You can also specify a installer plugin with the `--installer` option:

``` bash
certbot run \
--authenticator certbot-dns-cpanel:cpanel \
--authenticator cpanel \
--installer apache \
--certbot-dns-cpanel:cpanel-credentials /path/to/credentials.ini \
--cpanel-credentials /path/to/credentials.ini \
-d 'example.com' \
-d '*.example.com'
```
Expand All @@ -53,14 +53,14 @@ You may also install the certificate onto a domain on your cPanel account:

```bash
certbot run \
--authenticator certbot-dns-cpanel:cpanel \
--authenticator cpanel \
--installer certbot-dns-cpanel:cpanel \
--certbot-dns-cpanel:cpanel-credentials /path/to/credentials.ini \
--cpanel-credentials /path/to/credentials.ini \
-d 'example.com' \
-d '*.example.com'
```

Depending on your provider you may need to use the `--certbot-dns-cpanel:cpanel-propagation-seconds` option to extend
Depending on your provider you may need to use the `--cpanel-propagation-seconds` option to extend
the DNS propagation time.

## Docker
Expand All @@ -70,8 +70,8 @@ docker run -it \
-v /path/to/credentials.ini:/tmp/credentials.ini \
badjware/certbot-dns-cpanel \
certonly \
--authenticator certbot-dns-cpanel:cpanel \
--certbot-dns-cpanel:cpanel-credentials /tmp/credentials.ini \
--authenticator cpanel \
--cpanel-credentials /tmp/credentials.ini \
-d 'example.com' \
-d '*.example.com'
```
Expand Down

0 comments on commit ef99a7e

Please sign in to comment.