starred/certbot-certbot
1
0
Fork 0
mirror of https://github.com/certbot/certbot.git synced 2026-07-28 08:45:22 +02:00
Code Issues Packages Projects Releases Wiki Activity

Don't recommend using certbot-auto. (#8222)

Browse Source 
Fixes https://github.com/certbot/certbot/issues/8165.

I moved `prerequisites` up to the "Running a local copy of the client" `contributing.html#prerequisites` still links to information about installing Cerbot's dependencies.

I left all certbot-auto documentation that wasn't explicitly encouraging its use. I think we can rip that out once the script is deprecated.
This commit is contained in:
Brad Warren
2020-08-20 11:13:35 -07:00
committed by GitHub
parent 085967ad29
commit bc137103a3
2 changed files with 8 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files
certbot/docs/contributing.rst
+1 -30
View File
@@ -18,6 +18,7 @@ Windows, you'll need to set up a (virtual) machine running an OS such as Linux
and continue with these instructions on that UNIX-like OS.
.. _local copy:
.. _prerequisites:
Running a local copy of the client
----------------------------------
@@ -578,33 +579,3 @@ effect. To do this, run::
Now running the check for linting errors described above is as easy as::
tox -e lint
.. _prerequisites:
Notes on OS dependencies
========================
OS-level dependencies can be installed like so:
.. code-block:: shell
./certbot-auto --debug --os-packages-only
In general...
* ``sudo`` is required as a suggested way of running privileged process
* `Python`_ 2.7 or 3.6+ is required
* `Augeas`_ is required for the Python bindings
* ``virtualenv`` is used for managing other Python library dependencies
.. _Python: https://wiki.python.org/moin/BeginnersGuide/Download
.. _Augeas: http://augeas.net/
.. _Virtualenv: https://virtualenv.pypa.io
FreeBSD
-------
FreeBSD by default uses ``tcsh``. In order to activate virtualenv (see
above), you will need a compatible shell, e.g. ``pkg install bash &&
bash``.