Added usage instructions and an example command to the readme file
This commit is contained in:
parent
596da5f694
commit
c746b79586
18
README.md
18
README.md
@ -1,3 +1,19 @@
|
||||
# letsencrypt-linode
|
||||
# Let's Encrypt plugin scripts for Linode DNS
|
||||
|
||||
Hook scripts for automating the issue and renewal of Let's Encrypt certificates when using Linode's DNS platform.
|
||||
|
||||
## Installation
|
||||
|
||||
These scripts use Linode's official CLI client to interact with the Linode API.
|
||||
|
||||
Install the official Linode CLI client using [Linode's official guide](https://www.linode.com/docs/platform/api/using-the-linode-cli/).
|
||||
|
||||
Download the `linode-auth-hook.sh` and `linode-cleanup-hook.sh` shell scripts and make a note of where you have downloaded them to.
|
||||
|
||||
## Usage
|
||||
|
||||
To use the scripts for a new domain renewal, use the "manual" plugin with the extra "hook" options.
|
||||
|
||||
This example requests a wildcard certificate for the domain `yourdomain.com` - change accordingly.
|
||||
|
||||
`certbot certonly --manual -d *.yourdomain.com -d yourdomain.com --preferred-challenges dns-01 --manual-auth-hook /path/to/linode-auth-hook.sh --manual-cleanup-hook /path/to/linode-cleanup-hook.sh`.
|
Loading…
x
Reference in New Issue
Block a user