diff options
| author | Brad Warren <bmw@users.noreply.github.com> | 2021-12-11 04:28:18 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-12-11 04:28:18 +0300 |
| commit | dab78648096cbd9992002a50b8a38e77732c10de (patch) | |
| tree | b082713866394b3fae8502b608c4a364c06653db | |
| parent | 693c674a7e72a7bba89d00f58430045789440677 (diff) | |
Add macOS instructions (#9136)
* add macOS instructions
* add integration test warning
| -rw-r--r-- | certbot/docs/contributing.rst | 18 |
1 files changed, 14 insertions, 4 deletions
diff --git a/certbot/docs/contributing.rst b/certbot/docs/contributing.rst index 6e678ac2a..b81b14e40 100644 --- a/certbot/docs/contributing.rst +++ b/certbot/docs/contributing.rst @@ -31,13 +31,11 @@ running: git clone https://github.com/certbot/certbot -If you're on macOS, we recommend you skip the rest of this section and instead -run Certbot in Docker. You can find instructions for how to do this :ref:`here -<docker-dev>`. If you're running on Linux, you can run the following commands to +If you're running on a UNIX-like OS, you can run the following commands to install dependencies and set up a virtual environment where you can run Certbot. -Install the OS system dependencies required to run Certbot. +Install and configure the OS system dependencies required to run Certbot. .. code-block:: shell @@ -50,6 +48,14 @@ Install the OS system dependencies required to run Certbot. # 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 + # For macOS installations with Homebrew already installed and configured + # NB: If you also run `brew install python` you don't need the ~/lib + # directory created below, however, Certbot's Apache plugin won't work + # if you use Python installed from other sources such as pyenv or the + # version provided by Apple. + brew install augeas + mkdir ~/lib + ln -s $(brew --prefix)/lib/libaugeas* ~/lib Set up the Python virtual environment that will host your Certbot local instance. @@ -105,6 +111,10 @@ You can test your code in several ways: - running the `automated integration`_ tests - running an *ad hoc* `manual integration`_ test +.. note:: Running integration tests does not currently work on macOS. See + https://github.com/certbot/certbot/issues/6959. In the meantime, we + recommend developers on macOS open a PR to run integration tests. + .. _automated unit: Running automated unit tests |