mirror of
https://github.com/certbot/certbot.git
synced 2026-07-28 00:35:50 +02:00
merge with latest master
This commit is contained in:
Noah Swartz
@@ -0,0 +1,5 @@
|
||||
:mod:`certbot.plugins.dns_common`
|
||||
---------------------------------
|
||||
|
||||
.. automodule:: certbot.plugins.dns_common
|
||||
:members:
|
||||
@@ -0,0 +1,5 @@
|
||||
:mod:`certbot.plugins.dns_common_lexicon`
|
||||
-----------------------------------------
|
||||
|
||||
.. automodule:: certbot.plugins.dns_common_lexicon
|
||||
:members:
|
||||
+2
-2
@@ -58,7 +58,7 @@ HTTP-01 challenge:
|
||||
files in order to have them served by your existing web server.
|
||||
If you said your webroot for example.com was /var/www/example.com,
|
||||
then a file placed in /var/www/example.com/.well-known/acme-challenge/testfile should appear on
|
||||
your web site at http://example.com/.well-known/acme-challenge/testfile (which you can test using a web browser). (A redirection to HTTPS
|
||||
your web site at `http://example.com/.well-known/acme-challenge/testfile` (which you can test using a web browser). (A redirection to HTTPS
|
||||
is OK here and should not stop the challenge from working.)
|
||||
|
||||
Note that you should *not* specify the .well-known/acme-challenge directory itself. Instead, you should specify the top level directory that web content is served from.
|
||||
@@ -70,7 +70,7 @@ HTTP-01 challenge:
|
||||
* (With manual plugin) You updated the webroot directory incorrectly
|
||||
|
||||
If you used `--manual`, you need to know where you can put files in order to have them served by your existing web server. If you think your webroot for example.com is /var/www/example.com, then a file placed in /var/www/example.com/.well-known/acme-challenge/testfile should appear on
|
||||
your web site at http://example.com/.well-known/acme-challenge/testfile. (A redirection to HTTPS
|
||||
your web site at `http://example.com/.well-known/acme-challenge/testfile`. (A redirection to HTTPS
|
||||
is OK here and should not stop the challenge from working.) You should also make sure that you don't make a typo in the name of the file when creating it.
|
||||
|
||||
* Your existing web server's configuration refuses to serve files
|
||||
|
||||
+69
-59
@@ -85,11 +85,16 @@ optional arguments:
|
||||
--user-agent USER_AGENT
|
||||
Set a custom user agent string for the client. User
|
||||
agent strings allow the CA to collect high level
|
||||
statistics about success rates by OS and plugin. If
|
||||
you wish to hide your server OS version from the Let's
|
||||
Encrypt server, set this to "". (default:
|
||||
CertbotACMEClient/0.14.0.dev0 (Debian GNU/Linux 9
|
||||
(stretch)) Authenticator/XXX Installer/YYY)
|
||||
statistics about success rates by OS, plugin and use
|
||||
case, and to know when to deprecate support for past
|
||||
Python versions and flags. If you wish to hide this
|
||||
information from the Let's Encrypt server, set this to
|
||||
"". (default: CertbotACMEClient/0.14.1 (certbot;
|
||||
Ubuntu 16.04.2 LTS) Authenticator/XXX Installer/YYY
|
||||
(SUBCOMMAND; flags: FLAGS) Py/2.7.12). The flags
|
||||
encoded in the user agent are: --duplicate, --force-
|
||||
renew, --allow-subset-of-names, -n, and whether any
|
||||
hooks are set.
|
||||
|
||||
automation:
|
||||
Arguments for automating execution & other tweaks
|
||||
@@ -271,8 +276,13 @@ renew:
|
||||
"/etc/letsencrypt/live/example.com") containing the
|
||||
new certificates and keys; the shell variable
|
||||
$RENEWED_DOMAINS will contain a space-delimited list
|
||||
<<<<<<< HEAD
|
||||
of renewed certificate domains (for example,
|
||||
"example.com www.example.com" (default: None)
|
||||
=======
|
||||
of renewed cert domains (for example, "example.com
|
||||
www.example.com" (default: None)
|
||||
>>>>>>> master
|
||||
--disable-hook-validation
|
||||
Ordinarily the commands specified for --pre-hook
|
||||
/--post-hook/--renew-hook will be checked for
|
||||
@@ -372,66 +382,13 @@ plugins:
|
||||
False)
|
||||
--nginx Obtain and install certificates using Nginx (default:
|
||||
False)
|
||||
--standalone Obtain certs using a "standalone" webserver. (default:
|
||||
--standalone Obtain certificates using a "standalone" webserver. (default:
|
||||
False)
|
||||
--manual Provide laborious manual instructions for obtaining a
|
||||
certificate (default: False)
|
||||
--webroot Obtain certificates by placing files in a webroot
|
||||
directory. (default: False)
|
||||
|
||||
nginx:
|
||||
Nginx Web Server plugin - Alpha
|
||||
|
||||
--nginx-server-root NGINX_SERVER_ROOT
|
||||
Nginx server root directory. (default: /etc/nginx)
|
||||
--nginx-ctl NGINX_CTL
|
||||
Path to the 'nginx' binary, used for 'configtest' and
|
||||
retrieving nginx version number. (default: nginx)
|
||||
|
||||
standalone:
|
||||
Spin up a temporary webserver
|
||||
|
||||
manual:
|
||||
Authenticate through manual configuration or custom shell scripts. When
|
||||
using shell scripts, an authenticator script must be provided. The
|
||||
environment variables available to this script are $CERTBOT_DOMAIN which
|
||||
contains the domain being authenticated, $CERTBOT_VALIDATION which is the
|
||||
validation string, and $CERTBOT_TOKEN which is the filename of the
|
||||
resource requested when performing an HTTP-01 challenge. An additional
|
||||
cleanup script can also be provided and can use the additional variable
|
||||
$CERTBOT_AUTH_OUTPUT which contains the stdout output from the auth
|
||||
script.
|
||||
|
||||
--manual-auth-hook MANUAL_AUTH_HOOK
|
||||
Path or command to execute for the authentication
|
||||
script (default: None)
|
||||
--manual-cleanup-hook MANUAL_CLEANUP_HOOK
|
||||
Path or command to execute for the cleanup script
|
||||
(default: None)
|
||||
--manual-public-ip-logging-ok
|
||||
Automatically allows public IP logging (default: Ask)
|
||||
|
||||
webroot:
|
||||
Place files in webroot directory
|
||||
|
||||
--webroot-path WEBROOT_PATH, -w WEBROOT_PATH
|
||||
public_html / webroot path. This can be specified
|
||||
multiple times to handle different domains; each
|
||||
domain will have the webroot path that preceded it.
|
||||
For instance: `-w /var/www/example -d example.com -d
|
||||
www.example.com -w /var/www/thing -d thing.net -d
|
||||
m.thing.net` (default: Ask)
|
||||
--webroot-map WEBROOT_MAP
|
||||
JSON dictionary mapping domains to webroot paths; this
|
||||
implies -d for each entry. You may need to escape this
|
||||
from your shell. E.g.: --webroot-map
|
||||
'{"eg1.is,m.eg1.is":"/www/eg1/", "eg2.is":"/www/eg2"}'
|
||||
This option is merged with, but takes precedence over,
|
||||
-w / -d entries. At present, if you put webroot-map in
|
||||
a config file, it needs to be on a single line, like:
|
||||
webroot-map = {"example.com":"/var/www"}. (default:
|
||||
{})
|
||||
|
||||
apache:
|
||||
Apache Web Server plugin - Beta
|
||||
|
||||
@@ -462,5 +419,58 @@ apache:
|
||||
Let installer handle enabling sites for you.(Only
|
||||
Ubuntu/Debian currently) (default: True)
|
||||
|
||||
manual:
|
||||
Authenticate through manual configuration or custom shell scripts. When
|
||||
using shell scripts, an authenticator script must be provided. The
|
||||
environment variables available to this script are $CERTBOT_DOMAIN which
|
||||
contains the domain being authenticated, $CERTBOT_VALIDATION which is the
|
||||
validation string, and $CERTBOT_TOKEN which is the filename of the
|
||||
resource requested when performing an HTTP-01 challenge. An additional
|
||||
cleanup script can also be provided and can use the additional variable
|
||||
$CERTBOT_AUTH_OUTPUT which contains the stdout output from the auth
|
||||
script.
|
||||
|
||||
--manual-auth-hook MANUAL_AUTH_HOOK
|
||||
Path or command to execute for the authentication
|
||||
script (default: None)
|
||||
--manual-cleanup-hook MANUAL_CLEANUP_HOOK
|
||||
Path or command to execute for the cleanup script
|
||||
(default: None)
|
||||
--manual-public-ip-logging-ok
|
||||
Automatically allows public IP logging (default: Ask)
|
||||
|
||||
nginx:
|
||||
Nginx Web Server plugin - Alpha
|
||||
|
||||
--nginx-server-root NGINX_SERVER_ROOT
|
||||
Nginx server root directory. (default: /etc/nginx)
|
||||
--nginx-ctl NGINX_CTL
|
||||
Path to the 'nginx' binary, used for 'configtest' and
|
||||
retrieving nginx version number. (default: nginx)
|
||||
|
||||
null:
|
||||
Null Installer
|
||||
|
||||
standalone:
|
||||
Spin up a temporary webserver
|
||||
|
||||
webroot:
|
||||
Place files in webroot directory
|
||||
|
||||
--webroot-path WEBROOT_PATH, -w WEBROOT_PATH
|
||||
public_html / webroot path. This can be specified
|
||||
multiple times to handle different domains; each
|
||||
domain will have the webroot path that preceded it.
|
||||
For instance: `-w /var/www/example -d example.com -d
|
||||
www.example.com -w /var/www/thing -d thing.net -d
|
||||
m.thing.net` (default: Ask)
|
||||
--webroot-map WEBROOT_MAP
|
||||
JSON dictionary mapping domains to webroot paths; this
|
||||
implies -d for each entry. You may need to escape this
|
||||
from your shell. E.g.: --webroot-map
|
||||
'{"eg1.is,m.eg1.is":"/www/eg1/", "eg2.is":"/www/eg2"}'
|
||||
This option is merged with, but takes precedence over,
|
||||
-w / -d entries. At present, if you put webroot-map in
|
||||
a config file, it needs to be on a single line, like:
|
||||
webroot-map = {"example.com":"/var/www"}. (default:
|
||||
{})
|
||||
|
||||
+2
-2
@@ -22,8 +22,8 @@ your system.
|
||||
System Requirements
|
||||
===================
|
||||
|
||||
Certbot currently requires Python 2.6 or 2.7. By default, it requires root
|
||||
access in order to write to ``/etc/letsencrypt``,
|
||||
Certbot currently requires Python 2.6, 2.7, or 3.3+. By default, it requires
|
||||
root access in order to write to ``/etc/letsencrypt``,
|
||||
``/var/log/letsencrypt``, ``/var/lib/letsencrypt``; to bind to ports 80 and 443
|
||||
(if you use the ``standalone`` plugin) and to read and modify webserver
|
||||
configurations (if you use the ``apache`` or ``nginx`` plugins). If none of
|
||||
|
||||
+1
-1
@@ -430,7 +430,7 @@ apply appropriate file permissions.
|
||||
esac
|
||||
done
|
||||
|
||||
More information about renewal hooks can be found by running
|
||||
More information about renewal hooks can be found by running
|
||||
``certbot --help renew``.
|
||||
|
||||
If you're sure that this command executes successfully without human
|
||||
|
||||
Reference in New Issue
Block a user