Update README.rst (#9693)

* Update README.rst Updating with newer info about keys and server support and removing redundant wording * Adjust from feedback
certbot · May 23, 2023 · b5661e8 · b5661e8
1 parent aa270b3
commit b5661e8
Showing 1 changed file with 24 additions and 54 deletions.
diff --git a/certbot/README.rst b/certbot/README.rst
@@ -1,22 +1,26 @@
 .. This file contains a series of comments that are used to include sections of this README in other files. Do not modify these comments unless you know what you are doing. tag:intro-begin
 
-Certbot is part of EFF’s effort to encrypt the entire Internet. Secure communication over the Web relies on HTTPS, which requires the use of a digital certificate that lets browsers verify the identity of web servers (e.g., is that really google.com?). Web servers obtain their certificates from trusted third parties called certificate authorities (CAs). Certbot is an easy-to-use client that fetches a certificate from Let’s Encrypt—an open certificate authority launched by the EFF, Mozilla, and others—and deploys it to a web server.
+|build-status|
 
-Anyone who has gone through the trouble of setting up a secure website knows what a hassle getting and maintaining a certificate is. Certbot and Let’s Encrypt can automate away the pain and let you turn on and manage HTTPS with simple commands. Using Certbot and Let's Encrypt is free, so there’s no need to arrange payment.
+.. |build-status| image:: https://img.shields.io/azure-devops/build/certbot/ba534f81-a483-4b9b-9b4e-a60bec8fee72/5/master
+   :target: https://dev.azure.com/certbot/certbot/_build?definitionId=5
+   :alt: Azure Pipelines CI status
+
+.. image:: https://raw.githubusercontent.com/EFForg/design/master/logos/eff-certbot-lockup.png
+  :width: 200
+  :alt: EFF Certbot Logo
 
-How you use Certbot depends on the configuration of your web server. The best way to get started is to use our `interactive guide <https://certbot.eff.org>`_. It generates instructions based on your configuration settings. In most cases, you’ll need `root or administrator access <https://certbot.eff.org/faq/#does-certbot-require-root-administrator-privileges>`_ to your web server to run Certbot.
+Certbot is part of EFF’s effort to encrypt the entire Internet. Secure communication over the Web relies on HTTPS, which requires the use of a digital certificate that lets browsers verify the identity of web servers (e.g., is that really google.com?). Web servers obtain their certificates from trusted third parties called certificate authorities (CAs). Certbot is an easy-to-use client that fetches a certificate from Let’s Encrypt—an open certificate authority launched by the EFF, Mozilla, and others—and deploys it to a web server.
 
-Certbot is meant to be run directly on your web server, not on your personal computer. If you’re using a hosted service and don’t have direct access to your web server, you might not be able to use Certbot. Check with your hosting provider for documentation about uploading certificates or using certificates issued by Let’s Encrypt.
+Anyone who has gone through the trouble of setting up a secure website knows what a hassle getting and maintaining a certificate is. Certbot and Let’s Encrypt can automate away the pain and let you turn on and manage HTTPS with simple commands. Using Certbot and Let's Encrypt is free.
 
-Certbot is a fully-featured, extensible client for the Let's
-Encrypt CA (or any other CA that speaks the `ACME
-<https://datatracker.ietf.org/doc/html/rfc8555>`_
-protocol) that can automate the tasks of obtaining certificates and
-configuring webservers to use them. This client runs on Unix-based operating
-systems.
+.. _installation:
 
-To see the changes made to Certbot between versions please refer to our
-`changelog <https://github.com/certbot/certbot/blob/master/certbot/CHANGELOG.md>`_.
+Getting Started
+---------------
+The best way to get started is to use our `interactive guide <https://certbot.eff.org>`_. It generates instructions based on your configuration settings. In most cases, you’ll need `root or administrator access <https://certbot.eff.org/faq/#does-certbot-require-root-administrator-privileges>`_ to your web server to run Certbot.
+
+Certbot is meant to be run directly on your web server on the command line, not on your personal computer. If you’re using a hosted service and don’t have direct access to your web server, you might not be able to use Certbot. Check with your hosting provider for documentation about uploading certificates or using certificates issued by Let’s Encrypt.
 
 Contributing
 ------------
@@ -26,26 +30,6 @@ If you'd like to contribute to this project please read `Developer Guide
 
 This project is governed by `EFF's Public Projects Code of Conduct <https://www.eff.org/pages/eppcode>`_.
 
-.. _installation:
-
-How to run the client
----------------------
-
-The easiest way to install and run Certbot is by visiting `certbot.eff.org`_,
-where you can find the correct instructions for many web server and OS
-combinations.  For more information, see `Get Certbot
-<https://certbot.eff.org/docs/install.html>`_.
-
-.. _certbot.eff.org: https://certbot.eff.org/
-
-Understanding the client in more depth
---------------------------------------
-
-To understand what the client is doing in detail, it's important to
-understand the way it uses plugins.  Please see the `explanation of
-plugins <https://certbot.eff.org/docs/using.html#plugins>`_ in
-the User Guide.
-
 Links
 =====
 
@@ -55,7 +39,11 @@ Documentation: https://certbot.eff.org/docs
 
 Software project: https://github.com/certbot/certbot
 
-Notes for developers: https://certbot.eff.org/docs/contributing.html
+Changelog: https://github.com/certbot/certbot/blob/master/certbot/CHANGELOG.md
+
+For Contributors: https://certbot.eff.org/docs/contributing.html
+
+For Users: https://certbot.eff.org/docs/using.html
 
 Main Website: https://certbot.eff.org
 
@@ -67,19 +55,8 @@ ACME spec: `RFC 8555 <https://tools.ietf.org/html/rfc8555>`_
 
 ACME working area in github (archived): https://github.com/ietf-wg-acme/acme
 
-|build-status|
-
-.. |build-status| image:: https://img.shields.io/azure-devops/build/certbot/ba534f81-a483-4b9b-9b4e-a60bec8fee72/5/master
-   :target: https://dev.azure.com/certbot/certbot/_build?definitionId=5
-   :alt: Azure Pipelines CI status
-
 .. Do not modify this comment unless you know what you're doing. tag:links-end
 
-System Requirements
-===================
-
-See https://certbot.eff.org/docs/install.html#system-requirements.
-
 .. Do not modify this comment unless you know what you're doing. tag:intro-end
 
 .. Do not modify this comment unless you know what you're doing. tag:features-begin
@@ -89,7 +66,7 @@ Current Features
 
 * Supports multiple web servers:
 
-  - apache/2.x
+  - Apache 2.4+
   - nginx/0.8.48+
   - webroot (adds files to webroot directories in order to prove control of
     domains and obtain certificates)
@@ -101,17 +78,10 @@ Current Features
   compliant services.
 * Can get domain-validated (DV) certificates.
 * Can revoke certificates.
-* Adjustable RSA key bit-length (2048 (default), 4096, ...).
-* Adjustable `EC <https://en.wikipedia.org/wiki/Elliptic-curve_cryptography>`_
-  key (`secp256r1` (default), `secp384r1`, `secp521r1`).
+* Supports ECDSA (default) and RSA certificate private keys.
 * Can optionally install a http -> https redirect, so your site effectively
-  runs https only (Apache only)
+  runs https only.
 * Fully automated.
 * Configuration changes are logged and can be reverted.
-* Supports an interactive text UI, or can be driven entirely from the
-  command line.
-* Free and Open Source Software, made with Python.
 
 .. Do not modify this comment unless you know what you're doing. tag:features-end
-
-For extensive documentation on using and contributing to Certbot, go to https://certbot.eff.org/docs. If you would like to contribute to the project or run the latest code from git, you should read our `developer guide <https://certbot.eff.org/docs/contributing.html>`_.