From 33306de90b9c4825e20d86e5d2ba77bbcf21a3bc Mon Sep 17 00:00:00 2001 From: "T.C. Hollingsworth" Date: Mon, 26 Jun 2017 18:44:06 -0700 Subject: [PATCH] docs: explain how to combine plugins --- docs/using.rst | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/docs/using.rst b/docs/using.rst index 0b2206db2..e559e7a98 100644 --- a/docs/using.rst +++ b/docs/using.rst @@ -39,7 +39,7 @@ serve your website over HTTPS using certificates obtained by certbot. Plugins that do both can be used with the ``certbot run`` command, which is the default when no command is specified. The ``run`` subcommand can also be used to specify -a combination of distinct authenticator and installer plugins. +a combination_ of distinct authenticator and installer plugins. =========== ==== ==== =============================================================== ============================= Plugin Auth Inst Notes Challenge types (and port) @@ -205,6 +205,26 @@ perform the authentication procedure and/or clean up after it by using the ``--manual-auth-hook`` and ``--manual-cleanup-hook`` flags. This is described in more depth in the hooks_ section. +.. _combination: + +Combining plugins +----------------- + +Sometimes you may want to specify a combination of distinct authenticator and +installer plugins. To do so, specify the authenticator plugin with +``--authenticator`` or ``-a`` and the installer plugin with ``--installer`` or +``-i``. + +For instance, you may want to create a certificate using the webroot_ plugin +for authentication and the apache_ plugin for installation, perhaps because you +use a proxy or CDN for SSL and only want to secure the connection between them +and your origin server, which cannot use the tls-sni-01_ challenge due to the +intermediate proxy.) + +:: + + certbot run -a webroot -i apache -w /var/www/html -d example.com + .. _third-party-plugins: Third-party plugins