From c746b79586e7af8b78059c5b4a3559cf1784760f Mon Sep 17 00:00:00 2001 From: Andy Heathershaw Date: Thu, 25 Apr 2019 12:58:27 +0100 Subject: [PATCH] Added usage instructions and an example command to the readme file --- README.md | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ff6a869..bc427a5 100644 --- a/README.md +++ b/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. \ No newline at end of file +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`. \ No newline at end of file