diff options
author | Noah Swartz <swartzcr@gmail.com> | 2017-05-24 22:32:06 +0300 |
---|---|---|
committer | Noah Swartz <swartzcr@gmail.com> | 2017-05-24 22:32:06 +0300 |
commit | 7edb877ae836a7573d5a0fa330babf8a67272c31 (patch) | |
tree | 828632335e78c4822b4aef1424d2ec154aff3de6 /docs | |
parent | 2f2f00147d17d8406e79d7fb50fe3742f7782758 (diff) | |
parent | 8ae3a9082da25e426ff7fcfb60db26d46b9d5286 (diff) |
merge with latest master
Diffstat (limited to 'docs')
-rw-r--r-- | docs/api/plugins/dns_common.rst | 5 | ||||
-rw-r--r-- | docs/api/plugins/dns_common_lexicon.rst | 5 | ||||
-rw-r--r-- | docs/challenges.rst | 4 | ||||
-rw-r--r-- | docs/cli-help.txt | 108 | ||||
-rw-r--r-- | docs/install.rst | 4 | ||||
-rw-r--r-- | docs/using.rst | 2 |
6 files changed, 74 insertions, 54 deletions
diff --git a/docs/api/plugins/dns_common.rst b/docs/api/plugins/dns_common.rst new file mode 100644 index 000000000..ee3945e74 --- /dev/null +++ b/docs/api/plugins/dns_common.rst @@ -0,0 +1,5 @@ +:mod:`certbot.plugins.dns_common` +--------------------------------- + +.. automodule:: certbot.plugins.dns_common + :members: diff --git a/docs/api/plugins/dns_common_lexicon.rst b/docs/api/plugins/dns_common_lexicon.rst new file mode 100644 index 000000000..a48166828 --- /dev/null +++ b/docs/api/plugins/dns_common_lexicon.rst @@ -0,0 +1,5 @@ +:mod:`certbot.plugins.dns_common_lexicon` +----------------------------------------- + +.. automodule:: certbot.plugins.dns_common_lexicon + :members: diff --git a/docs/challenges.rst b/docs/challenges.rst index 0c923c45b..e45b9d852 100644 --- a/docs/challenges.rst +++ b/docs/challenges.rst @@ -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 diff --git a/docs/cli-help.txt b/docs/cli-help.txt index 7a4bf58b9..ef9574a80 100644 --- a/docs/cli-help.txt +++ b/docs/cli-help.txt @@ -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,24 +382,42 @@ 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) +apache: + Apache Web Server plugin - Beta -standalone: - Spin up a temporary webserver + --apache-enmod APACHE_ENMOD + Path to the Apache 'a2enmod' binary. (default: + a2enmod) + --apache-dismod APACHE_DISMOD + Path to the Apache 'a2dismod' binary. (default: + a2dismod) + --apache-le-vhost-ext APACHE_LE_VHOST_EXT + SSL vhost configuration extension. (default: -le- + ssl.conf) + --apache-server-root APACHE_SERVER_ROOT + Apache server root directory. (default: /etc/apache2) + --apache-vhost-root APACHE_VHOST_ROOT + Apache server VirtualHost configuration root (default: + /etc/apache2/sites-available) + --apache-logs-root APACHE_LOGS_ROOT + Apache server logs directory (default: + /var/log/apache2) + --apache-challenge-location APACHE_CHALLENGE_LOCATION + Directory path for challenge configuration. (default: + /etc/apache2) + --apache-handle-modules APACHE_HANDLE_MODULES + Let installer handle enabling required modules for + you.(Only Ubuntu/Debian currently) (default: True) + --apache-handle-sites APACHE_HANDLE_SITES + Let installer handle enabling sites for you.(Only + Ubuntu/Debian currently) (default: True) manual: Authenticate through manual configuration or custom shell scripts. When @@ -411,6 +439,21 @@ manual: --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 @@ -431,36 +474,3 @@ webroot: 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 - - --apache-enmod APACHE_ENMOD - Path to the Apache 'a2enmod' binary. (default: - a2enmod) - --apache-dismod APACHE_DISMOD - Path to the Apache 'a2dismod' binary. (default: - a2dismod) - --apache-le-vhost-ext APACHE_LE_VHOST_EXT - SSL vhost configuration extension. (default: -le- - ssl.conf) - --apache-server-root APACHE_SERVER_ROOT - Apache server root directory. (default: /etc/apache2) - --apache-vhost-root APACHE_VHOST_ROOT - Apache server VirtualHost configuration root (default: - /etc/apache2/sites-available) - --apache-logs-root APACHE_LOGS_ROOT - Apache server logs directory (default: - /var/log/apache2) - --apache-challenge-location APACHE_CHALLENGE_LOCATION - Directory path for challenge configuration. (default: - /etc/apache2) - --apache-handle-modules APACHE_HANDLE_MODULES - Let installer handle enabling required modules for - you.(Only Ubuntu/Debian currently) (default: True) - --apache-handle-sites APACHE_HANDLE_SITES - Let installer handle enabling sites for you.(Only - Ubuntu/Debian currently) (default: True) - -null: - Null Installer diff --git a/docs/install.rst b/docs/install.rst index 6c56584be..a1e91c010 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -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 diff --git a/docs/using.rst b/docs/using.rst index 614f79608..4ef0f5414 100644 --- a/docs/using.rst +++ b/docs/using.rst @@ -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 |