Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

#11: legacy format is not supported in Certbot 2.x. Update README #21

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

#11: legacy format is not supported in Certbot 2.x. Update README #21

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 14 additions & 14 deletions README.md
View file
Open in desktop
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