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

Merge pull request #1098 from letsencrypt/devdocs

Browse Source 
Devdocs
This commit is contained in:
bmw
2015-10-23 17:39:25 -07:00
parent dd1e000581 efa1d6d38e
commit 35c108e481
2 changed files with 154 additions and 81 deletions
Download Patch File Download Diff File Expand all files Collapse all files
bootstrap/install-deps.sh
Executable
+40
View File
@@ -0,0 +1,40 @@
#!/bin/sh -e
#
# Install OS dependencies. In the glorious future, letsencrypt-auto will
# source this...
if test "`id -u`" -ne "0" ; then
SUDO=sudo
else
SUDO=
fi
BOOTSTRAP=`dirname $0`/bootstrap
if [ ! -f $BOOTSTRAP/debian.sh ] ; then
echo "Cannot find the letsencrypt bootstrap scripts in $BOOTSTRAP"
exit 1
fi
if [ -f /etc/debian_version ] ; then
echo "Bootstrapping dependencies for Debian-based OSes..."
$SUDO $BOOTSTRAP/_deb_common.sh
elif [ -f /etc/arch-release ] ; then
echo "Bootstrapping dependencies for Archlinux..."
$SUDO $BOOTSTRAP/archlinux.sh
elif [ -f /etc/redhat-release ] ; then
echo "Bootstrapping dependencies for RedHat-based OSes..."
$SUDO $BOOTSTRAP/_rpm_common.sh
elif uname | grep -iq FreeBSD ; then
echo "Bootstrapping dependencies for FreeBSD..."
$SUDO $BOOTSTRAP/freebsd.sh
elif uname | grep -iq Darwin ; then
echo "Bootstrapping dependencies for Mac OS X..."
echo "WARNING: Mac support is very experimental at present..."
$BOOTSTRAP/mac.sh
else
echo "Sorry, I don't know how to bootstrap Let's Encrypt on your operating system!"
echo
echo "You will need to bootstrap, configure virtualenv, and run a pip install manually"
echo "Please see https://letsencrypt.readthedocs.org/en/latest/contributing.html#prerequisites"
echo "for more info"
exit 1
fi
docs/contributing.rst
+114 -81
View File
@@ -7,40 +7,54 @@ Contributing
Hacking Hacking
======= =======
All changes in your pull request **must** have 100% unit test coverage, pass Running a local copy of the client
our `integration`_ tests, **and** be compliant with the ----------------------------------
:ref:`coding style <coding-style>`.
Running the client in developer mode from your local tree is a little
Bootstrap different than running ``letsencrypt-auto``. To get set up, do these things
--------- once:
Start by :ref:`installing Let's Encrypt prerequisites
<prerequisites>`. Then run:
.. code-block:: shell .. code-block:: shell
git clone https://github.com/letsencrypt/letsencrypt
cd letsencrypt
./bootstrap/install-deps.sh
./bootstrap/dev/venv.sh ./bootstrap/dev/venv.sh
Activate the virtualenv: Then in each shell where you're working on the client, do:
.. code-block:: shell .. code-block:: shell
source ./$VENV_NAME/bin/activate ./venv/bin/activate
This step should prepend you prompt with ``($VENV_NAME)`` and save you After that, your shell will be using the virtual environment, and you run the
from typing ``./$VENV_NAME/bin/...``. It is also required to run some client by typing:
of the `testing`_ tools. Virtualenv can be disabled at any time by
typing ``deactivate``. More information can be found in `virtualenv
documentation`_.
Note that packages are installed in so called *editable mode*, in .. code-block:: shell
which any source code changes in the current working directory are
"live" and no further ``./bootstrap/dev/venv.sh`` or ``pip install
...`` invocations are necessary while developing.
.. _`virtualenv documentation`: https://virtualenv.pypa.io letsencrypt
Activating a shell in this way makes it easier to run unit tests
with ``tox`` and integration tests, as described below. To reverse this, you
can type ``deactivate``. More information can be found in the `virtualenv docs`_.
.. _`virtualenv docs`: https://virtualenv.pypa.io
Find issues to work on
----------------------
You can find the open issues in the `github issue tracker`_. Comparatively
easy ones are marked `Good Volunteer Task`_. If you're starting work on
something, post a comment to let others know and seek feedback on your plan
where appropriate.
Once you've got a working branch, you can open a pull request. All changes in
your pull request must have thorough unit test coverage, pass our
`integration`_ tests, and be compliant with the :ref:`coding style
<coding-style>`.
.. _github issue tracker: https://github.com/letsencrypt/letsencrypt/issues
.. _Good Volunteer Task: https://github.com/letsencrypt/letsencrypt/issues?q=is%3Aopen+is%3Aissue+label%3A%22Good+Volunteer+Task%22
Testing Testing
------- -------
@@ -64,8 +78,14 @@ The following tools are there to help you:
but you won't get TAB completion... but you won't get TAB completion...
Integration .. _integration:
~~~~~~~~~~~
Integration testing with the boulder CA
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Generally it is sufficient to open a pull request and let Github and Travis run
integration tests for you.
Mac OS X users: Run `./tests/mac-bootstrap.sh` instead of `boulder-start.sh` to Mac OS X users: Run `./tests/mac-bootstrap.sh` instead of `boulder-start.sh` to
install dependencies, configure the environment, and start boulder. install dependencies, configure the environment, and start boulder.
@@ -91,55 +111,6 @@ the integration tests suite.
.. _Go: https://golang.org .. _Go: https://golang.org
Vagrant
-------
If you are a Vagrant user, Let's Encrypt comes with a Vagrantfile that
automates setting up a development environment in an Ubuntu 14.04
LTS VM. To set it up, simply run ``vagrant up``. The repository is
synced to ``/vagrant``, so you can get started with:
.. code-block:: shell
vagrant ssh
cd /vagrant
./venv/bin/pip install -r requirements.txt .[dev,docs,testing]
sudo ./venv/bin/letsencrypt
Support for other Linux distributions coming soon.
.. note::
Unfortunately, Python distutils and, by extension, setup.py and
tox, use hard linking quite extensively. Hard linking is not
supported by the default sync filesystem in Vagrant. As a result,
all actions with these commands are *significantly slower* in
Vagrant. One potential fix is to `use NFS`_ (`related issue`_).
.. _use NFS: http://docs.vagrantup.com/v2/synced-folders/nfs.html
.. _related issue: https://github.com/ClusterHQ/flocker/issues/516
Docker
------
OSX users will probably find it easiest to set up a Docker container for
development. Let's Encrypt comes with a Dockerfile (``Dockerfile-dev``)
for doing so. To use Docker on OSX, install and setup docker-machine using the
instructions at https://docs.docker.com/installation/mac/.
To build the development Docker image::
docker build -t letsencrypt -f Dockerfile-dev .
Now run tests inside the Docker image:
.. code-block:: shell
docker run -it letsencrypt bash
cd src
tox -e py27
Code components and layout Code components and layout
========================== ==========================
@@ -171,7 +142,8 @@ which implement bindings to alternative UI libraries.
Authenticators Authenticators
-------------- --------------
Authenticators are plugins designed to solve challenges received from Authenticators are plugins designed to prove that this client deserves a
certificate for some domain name by solving challenges received from
the ACME server. From the protocol, there are essentially two the ACME server. From the protocol, there are essentially two
different types of challenges. Challenges that must be solved by different types of challenges. Challenges that must be solved by
individual plugins in order to satisfy domain validation (subclasses individual plugins in order to satisfy domain validation (subclasses
@@ -195,17 +167,25 @@ in a separate branch).
Installer Installer
--------- ---------
Installers classes exist to actually setup the certificate and be able Installers plugins exist to actually setup the certificate in a server,
to enhance the configuration. (Turn on HSTS, redirect to HTTPS, possibly tweak the security configuration to make it more correct and secure
etc). You can indicate your abilities through the (Fix some mixed content problems, turn on HSTS, redirect to HTTPS, etc).
:meth:`~.IInstaller.supported_enhancements` call. We currently only Installer plugins tell the main client about their abilities to do the latter
have one Installer written (still developing), `~.ApacheConfigurator`. via the :meth:`~.IInstaller.supported_enhancements` call. We currently
have two Installers in the tree, the `~.ApacheConfigurator`. and the
`~.NginxConfigurator`. External projects have made some progress toward
support for IIS, Icecast and Plesk.
Installers and Authenticators will oftentimes be the same Installers and Authenticators will oftentimes be the same class/object
class/object. Installers and Authenticators are kept separate because (because for instance both tasks can be performed by a webserver like nginx)
though this is not always the case (the standalone plugin is an authenticator
that listens on port 443, but it cannot install certs; a postfix plugin would
be an installer but not an authenticator).
Installers and Authenticators are kept separate because
it should be possible to use the `~.StandaloneAuthenticator` (it sets it should be possible to use the `~.StandaloneAuthenticator` (it sets
up its own Python server to perform challenges) with a program that up its own Python server to perform challenges) with a program that
cannot solve challenges itself. (Imagine MTA installers). cannot solve challenges itself (Such as MTA installers).
Installer Development Installer Development
@@ -293,6 +273,59 @@ directory.
.. _prerequisites: .. _prerequisites:
Other methods for running the client
====================================
Vagrant
-------
If you are a Vagrant user, Let's Encrypt comes with a Vagrantfile that
automates setting up a development environment in an Ubuntu 14.04
LTS VM. To set it up, simply run ``vagrant up``. The repository is
synced to ``/vagrant``, so you can get started with:
.. code-block:: shell
vagrant ssh
cd /vagrant
./venv/bin/pip install -r requirements.txt .[dev,docs,testing]
sudo ./venv/bin/letsencrypt
Support for other Linux distributions coming soon.
.. note::
Unfortunately, Python distutils and, by extension, setup.py and
tox, use hard linking quite extensively. Hard linking is not
supported by the default sync filesystem in Vagrant. As a result,
all actions with these commands are *significantly slower* in
Vagrant. One potential fix is to `use NFS`_ (`related issue`_).
.. _use NFS: http://docs.vagrantup.com/v2/synced-folders/nfs.html
.. _related issue: https://github.com/ClusterHQ/flocker/issues/516
Docker
------
OSX users will probably find it easiest to set up a Docker container for
development. Let's Encrypt comes with a Dockerfile (``Dockerfile-dev``)
for doing so. To use Docker on OSX, install and setup docker-machine using the
instructions at https://docs.docker.com/installation/mac/.
To build the development Docker image::
docker build -t letsencrypt -f Dockerfile-dev .
Now run tests inside the Docker image:
.. code-block:: shell
docker run -it letsencrypt bash
cd src
tox -e py27
Notes on OS dependencies Notes on OS dependencies
======================== ========================