upstream/certbot
1
0
Fork 0
mirror of https://github.com/certbot/certbot.git synced 2026-06-05 23:04:39 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Remove python2 and certbot-auto references in how to set up a Certbot build environment. (#7549)

Browse source 
Fixes #7548.

This PR udpdates installation instructions to get rid of python2 and certbot-auto in the how-to explaining the Certbot development environment setup.

Instead, Python 3 is used, and appropriate instructions for APT and RPM based distributions are provided.
This commit is contained in:
Adrien Ferrand 2019-11-12 22:52:44 +01:00 committed by Brad Warren
parent 4792e1ee21
commit c26d459d0f
1 changed files with 17 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
docs/contributing.rst
View file

@ -36,29 +36,36 @@ run Certbot in Docker. You can find instructions for how to do this :ref:`here
install dependencies and set up a virtual environment where you can run
Certbot.
Install the OS system dependencies required to run Certbot.
.. code-block:: shell
# For APT-based distributions (e.g. Debian, Ubuntu ...)
sudo apt update
sudo apt install python3-dev python3-venv gcc libaugeas0 libssl-dev \
libffi-dev ca-certificates openssl
# For RPM-based distributions (e.g. Fedora, CentOS ...)
# NB1: old distributions will use yum instead of dnf
# NB2: RHEL-based distributions use python3X-devel instead of python3-devel (e.g. python36-devel)
sudo dnf install python3-devel gcc augeas-libs openssl-devel libffi-devel \
redhat-rpm-config ca-certificates openssl
Set up the Python virtual environment that will host your Certbot local instance.
.. code-block:: shell
cd certbot
./certbot-auto --debug --os-packages-only
python tools/venv.py
If you have Python3 available and want to use it, run the ``venv3.py`` script.
.. code-block:: shell
python tools/venv3.py
.. note:: You may need to repeat this when
Certbot's dependencies change or when a new plugin is introduced.
You can now run the copy of Certbot from git either by executing
``venv/bin/certbot``, or by activating the virtual environment. You can do the
``venv3/bin/certbot``, or by activating the virtual environment. You can do the
latter by running:
.. code-block:: shell
source venv/bin/activate
# or
source venv3/bin/activate
After running this command, ``certbot`` and development tools like ``ipdb``,