From 6cf468bcd09b2e24b0c89d5b0687773d11b288fe Mon Sep 17 00:00:00 2001 From: Peter Conrad Date: Fri, 8 Jun 2018 09:31:36 -0700 Subject: [PATCH] Went through log and fixed as much as I could --- README.rst | 4 ++++ docs/challenges.rst | 8 ++++---- docs/how.rst | 14 +++++++------- docs/install.rst | 5 +++-- docs/reference.rst | 2 +- 5 files changed, 19 insertions(+), 14 deletions(-) diff --git a/README.rst b/README.rst index 30bad06d2..38e934dfc 100644 --- a/README.rst +++ b/README.rst @@ -120,18 +120,22 @@ ACME working area in github: https://github.com/ietf-wg-acme/acme    :target: https://travis-ci.org/certbot/certbot    :alt: Travis CI status + .. |coverage| image:: https://coveralls.io/repos/certbot/certbot/badge.svg?branch=master    :target: https://coveralls.io/r/certbot/certbot    :alt: Coverage status + .. |docs| image:: https://readthedocs.org/projects/letsencrypt/badge/    :target: https://readthedocs.org/projects/letsencrypt/    :alt: Documentation status + .. |container| image:: https://quay.io/repository/letsencrypt/letsencrypt/status    :target: https://quay.io/repository/letsencrypt/letsencrypt    :alt: Docker Repository on Quay.io + .. Do not modify this comment unless you know what you're doing. tag:links-end System Requirements diff --git a/docs/challenges.rst b/docs/challenges.rst index 03d815381..27bff2fa1 100644 --- a/docs/challenges.rst +++ b/docs/challenges.rst @@ -40,7 +40,7 @@ General tips: .. _http_01_challenge: HTTP-01 Challenge -~~~~~~~~~~~~~~~~~ +^^^^^^^^^^^^^^^^^ * Make sure the domain name exists and is already pointed to the public IP address of the server where you’re requesting the certificate. @@ -61,10 +61,10 @@ HTTP-01 Challenge * When using the Webroot plugin, make sure there is a web server listening on port 80. -.. _tls_sni_01_challege: +.. _tls_sni_01_challenge: TLS-SNI-01 Challenge -~~~~~~~~~~~~~~~~~~~~ +^^^^^^^^^^^^^^^^^^^^ * The TLS-SNI-01 challenge doesn’t work with content delivery networks (CDNs) like CloudFlare and Akamai because the domain name is pointed at the CDN, not directly at your server. @@ -81,7 +81,7 @@ TLS-SNI-01 Challenge .. _dns_01_challenge: DNS-01 Challenge -~~~~~~~~~~~~~~~~ +^^^^^^^^^^^^^^^^ * When using the manual plugin, make sure your DNS records are correctly updated; you must be able to make appropriate changes to your DNS zone in order to pass the challenge. diff --git a/docs/how.rst b/docs/how.rst index 5329758e0..6e9c1a77f 100644 --- a/docs/how.rst +++ b/docs/how.rst @@ -42,19 +42,19 @@ a combination_ of distinct authenticator and installer plugins. =========== ==== ==== =============================================================== ============================= Plugin Auth Inst Notes Challenge types (and port) =========== ==== ==== =============================================================== ============================= -apache_ Y Y | Automates obtaining and installing a certificate with Apache :ref:`TLS-SNI-01 ` (443) +apache Y Y | Automates obtaining and installing a certificate with Apache :ref:`TLS-SNI-01 ` (443) | 2.4 on Debian-based distributions with ``libaugeas0`` 1.0+. -webroot_ Y N | Obtains a certificate by writing to the webroot directory of :ref:`HTTP-01 ` (80) +webroot Y N | Obtains a certificate by writing to the webroot directory of :ref:`HTTP-01 ` (80) | an already running webserver. -nginx_ Y Y | Automates obtaining and installing a certificate with Nginx. :ref:`TLS-SNI-01 ` (443) +nginx Y Y | Automates obtaining and installing a certificate with Nginx. :ref:`TLS-SNI-01 ` (443) | Shipped with Certbot 0.9.0. -standalone_ Y N | Uses a "standalone" webserver to obtain a certificate. :ref:`HTTP-01 ` (80) or - | Requires port 80 or 443 to be available. This is useful on :ref:`TLS-SNI-01 ` (443) +standalone Y N | Uses a "standalone" webserver to obtain a certificate. :ref:`HTTP-01 ` (80) or + | Requires port 80 or 443 to be available. This is useful on :ref:`TLS-SNI-01 ` (443) | systems with no webserver, or when direct integration with | the local webserver is not supported or not desired. -manual_ Y N | Helps you obtain a certificate by giving you instructions to :ref:`HTTP-01 ` (80), +manual Y N | Helps you obtain a certificate by giving you instructions to :ref:`HTTP-01 ` (80), | perform domain validation yourself. Additionally allows you :ref:`DNS-01 ` (53) or - | to specify scripts to automate the validation task in a :ref:`TLS-SNI-01 ` (443) + | to specify scripts to automate the validation task in a :ref:`TLS-SNI-01 ` (443) | customized way. =========== ==== ==== =============================================================== ============================= diff --git a/docs/install.rst b/docs/install.rst index 9553c6a61..8626aabae 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -9,6 +9,7 @@ Manual Installation where you can find the correct installation instructions for many web server and OS combinations. + .. _certbot.eff.org: https://certbot.eff.org/ @@ -301,7 +302,7 @@ server using SNI. Additionally you can specify scripts to prepare for validation and 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. +described in more depth in the hooks section. * Manual plugin: (DNS-01 or HTTP-01) Either tells you what changes to make to your configuration or updates your DNS records using an external script (for DNS-01) or your webroot (for HTTP-01). Use the Manual @@ -413,7 +414,7 @@ installer plugins. To do so, specify the authenticator plugin with 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 +and your origin server, which cannot use the tls_sni_01_challege_ due to the intermediate proxy. :: diff --git a/docs/reference.rst b/docs/reference.rst index 1376432a5..6e2db2b8a 100644 --- a/docs/reference.rst +++ b/docs/reference.rst @@ -6,7 +6,7 @@ Reference Certbot Logs -========== +============ .. _log-rotation: