From c2d0acbb31f7a4fed6d3b0c13fab946600de6179 Mon Sep 17 00:00:00 2001 From: Brad Warren Date: Tue, 17 Nov 2015 15:02:07 -0800 Subject: [PATCH] Expanded plugin documentation --- docs/using.rst | 61 +++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 55 insertions(+), 6 deletions(-) diff --git a/docs/using.rst b/docs/using.rst index 334e2e197..a326e4deb 100644 --- a/docs/using.rst +++ b/docs/using.rst @@ -140,8 +140,6 @@ SSL certificates! Plugins ======= -Officially supported plugins: - ========== = = ================================================================ Plugin A I Notes and status ========== = = ================================================================ @@ -161,11 +159,62 @@ manual Y N Hidden from standard UI, use with ``-a manual``. Requires to nginx Y Y Very experimental. Not included in letsencrypt-auto_. ========== = = ================================================================ -Third party plugins are listed at -https://github.com/letsencrypt/letsencrypt/wiki/Plugins. If -that's not enough, you can always :ref:`write your own plugin -`. +Apache +------ +If you're running Apache 2.4 on a Debian-based OS with version 1.0+ of +the ``libaugeas0`` package available, you can use the Apache plugin. +This automates both obtaining and installing certs on an Apache +webserver. To specify this plugin on the command line, simply include +``--apache``. + +Standalone +---------- + +To obtain a cert using a "standalone" webserver, you can use the +standalone plugin. This plugin needs to bind to port 80 or 443 in +order to perform domain validation, so you may need to stop your +existing webserver. To control which port the plugin uses, include +one of the options shown below on the command line. + + * ``--standalone-supported-challenges http-01`` to use port 80 + * ``--standalone-supported-challenges tls-sni-01`` to use port 443 + +Webroot +------- + +If you're running a webserver that you don't want to stop to use +standalone, you can use the webroot plugin to obtain a cert. To use +this plugin, you need to specify ``--webroot-path`` on the command +line with the root directory of the files served by your webserver. +For example, ``--webroot-path /var/www/html`` or +``--webroot-path /usr/share/nginx/html`` are two common webroot paths. +If multiple domains are specified, they must all use the same path. + +Manual +------ + +If you'd like to obtain a cert running ``letsencrypt`` on a machine +other than your target webserver or perform the steps for domain +validation yourself, you can use the manual plugin. While hidden from +the UI, you can use the plugin to obtain a cert by specifying +``-a manual`` or ``--authenticator manual`` on the command line. This +requires you to copy and paste commands into another terminal session. + +Nginx +----- + +In the future, if you're running Nginx you can use this plugin to +automatically obtain and install your certificate. The Nginx plugin +is still experimental, however, and is not installed with +letsencrypt-auto_. + +Third party plugins +------------------- + +These plugins are listed at +https://github.com/letsencrypt/letsencrypt/wiki/Plugins. If you're +interested, you can also :ref:`write your own plugin `. Renewal =======