Remove references to certbot-auto from docs and tools

This commit is contained in:
Erica Portnoy 2021-03-24 13:42:41 -07:00
parent f5e99ce772
commit 541695aef8
5 changed files with 5 additions and 54 deletions

View file

@ -222,8 +222,6 @@ certbot-apache and certbot-nginx
client code to configure specific web servers
certbot-dns-*
client code to configure DNS providers
certbot-auto and letsencrypt-auto
shell scripts to install Certbot and its dependencies on UNIX systems
windows installer
Installs Certbot on Windows and is built using the files in windows-installer/
@ -548,53 +546,6 @@ Instructions for how to manually build and run the Certbot snap and the external
snapped DNS plugins that the Certbot project supplies are located in the README
file at https://github.com/certbot/certbot/tree/master/tools/snap.
Updating certbot-auto and letsencrypt-auto
==========================================
.. note:: We are currently only accepting changes to certbot-auto that fix
regressions on platforms where certbot-auto is the recommended installation
method at https://certbot.eff.org/instructions. If you are unsure if a change
you want to make qualifies, don't hesitate to `ask for help`_!
Updating the scripts
--------------------
Developers should *not* modify the ``certbot-auto`` and ``letsencrypt-auto`` files
in the root directory of the repository. Rather, modify the
``letsencrypt-auto.template`` and associated platform-specific shell scripts in
the ``letsencrypt-auto-source`` and
``letsencrypt-auto-source/pieces/bootstrappers`` directory, respectively.
Building letsencrypt-auto-source/letsencrypt-auto
-------------------------------------------------
Once changes to any of the aforementioned files have been made, the
``letsencrypt-auto-source/letsencrypt-auto`` script should be updated. In lieu of
manually updating this script, run the build script, which lives at
``letsencrypt-auto-source/build.py``:
.. code-block:: shell
python letsencrypt-auto-source/build.py
Running ``build.py`` will update the ``letsencrypt-auto-source/letsencrypt-auto``
script. Note that the ``certbot-auto`` and ``letsencrypt-auto`` scripts in the root
directory of the repository will remain **unchanged** after this script is run.
Your changes will be propagated to these files during the next release of
Certbot.
Opening a PR
------------
When opening a PR, ensure that the following files are committed:
1. ``letsencrypt-auto-source/letsencrypt-auto.template`` and
``letsencrypt-auto-source/pieces/bootstrappers/*``
2. ``letsencrypt-auto-source/letsencrypt-auto`` (generated by ``build.py``)
It might also be a good idea to double check that **no** changes were
inadvertently made to the ``certbot-auto`` or ``letsencrypt-auto`` scripts in the
root of the repository. These scripts will be updated by the core developers
during the next release.
Updating the documentation
==========================

View file

@ -254,7 +254,7 @@ If you want to uninstall ``certbot-auto``, you can follow our instructions
Problems with Python virtual environment
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
When using ``certbot-auto`` on a low memory system such as VPS with less than
When using ``certbot`` on a low memory system such as VPS with less than
512MB of RAM, the required dependencies of Certbot may fail to build. This can
be identified if the pip outputs contains something like ``internal compiler
error: Killed (program cc1)``. You can workaround this restriction by creating

View file

@ -14,7 +14,7 @@ obtaining, renewing, or revoking certificates. The most important
and commonly-used commands will be discussed throughout this
document; an exhaustive list also appears near the end of the document.
The ``certbot`` script on your web server might be named ``letsencrypt`` if your system uses an older package, or ``certbot-auto`` if you used an alternate installation method. Throughout the docs, whenever you see ``certbot``, swap in the correct name as needed.
The ``certbot`` script on your web server might be named ``letsencrypt`` if your system uses an older package, or ``certbot-auto`` if you used a now-deprecated installation method. Throughout the docs, whenever you see ``certbot``, swap in the correct name as needed.
.. _plugins:
@ -420,7 +420,7 @@ option to control the curve used in ECDSA certificates.
.. warning:: If you obtain certificates using ECDSA keys, you should be careful
not to downgrade your Certbot installation since ECDSA keys are not
supported by older versions of Certbot. Downgrades like this are possible if
you switch from something like the snaps or certbot-auto to packages
you switch from something like the snaps or pip to packages
provided by your operating system which often lag behind.
Changing existing certificates from RSA to ECDSA

View file

@ -3,7 +3,7 @@
# to 1, a combination of tools/oldest_constraints.txt,
# tools/dev_constraints.txt, and local-oldest-requirements.txt contained in the
# top level of the package's directory is used, otherwise, a combination of
# certbot-auto's requirements file and tools/dev_constraints.txt is used. The
# tools/certbot_constraints.txt and tools/dev_constraints.txt is used. The
# other file always takes precedence over tools/dev_constraints.txt. If
# CERTBOT_OLDEST is set, this script must be run with `-e <package-name>` and
# no other arguments.

View file

@ -1,5 +1,5 @@
#!/usr/bin/env python
# pip installs packages in editable mode using certbot-auto's requirements file
# pip installs packages in editable mode using tools/certbot_constraints.txt
# as constraints
#
# cryptography is currently using this script in their CI at