[![Build Status] (https://travis-ci.org/letsencrypt/lets-encrypt-preview.svg?branch=master)] (https://travis-ci.org/letsencrypt/lets-encrypt-preview)
This is the Let's Encrypt Agent DEVELOPER PREVIEW repository.
DO NOT RUN THIS CODE ON A PRODUCTION WEBSERVER. IT WILL INSTALL CERTIFICATES SIGNED BY A TEST CA, AND WILL CAUSE CERT WARNINGS FOR USERS.
This code is intended for testing, demonstration, and integration engineering with OSes and hosting platforms. For the time being project focuses on Linux and Apache, though we will be expanding it to other platforms.
The demo code is supported and known to work on Ubuntu only (even closely related [Debian is known to fail] (certbot#68)). Therefore, prerequisites for other platforms listed below are provided mainly for the developers reference.
In general:
sudo apt-get install python python-setuptools python-virtualenv \
python-dev gcc swig dialog libaugeas0 libssl-dev
sudo brew install augeas swig
virtualenv --no-site-packages -p python2 venv
./venv/bin/python setup.py install
sudo ./venv/bin/letsencrypt
In order to start hacking, you will first have to create a development environment:
./venv/bin/python setup.py dev
The code base, including your pull requests, must have 100% test statement coverage and be compliant with the coding style. The following tools are there to help you:
-
./venv/bin/tox
starts a full set of tests. Please make sure you run it before submitting a new pull request. -
./venv/bin/tox -e cover
checks the test coverage only. -
./venv/bin/tox -e lint
checks the style of the whole project, while./venv/bin/pylint --rcfile=.pylintrc file
will check a singlefile
only.
In order to generate the sphinx documentation, run the following commands.
./venv/bin/python setup.py docs
cd docs
make html SPHINXBUILD='../venv/bin/python ../venv/bin/sphinx-build'
This should generate documentation in the /lets-encrypt-preview/docs/_build/html directory.
Most importantly, be consistent with the rest of the code, please.
-
Read [PEP 8 - Style Guide for Python Code] (https://www.python.org/dev/peps/pep-0008).
-
Follow [Google Python Style Guide] (https://google-styleguide.googlecode.com/svn/trunk/pyguide.html), with the exception that we use Sphinx-style documentation:
def foo(arg): """Short description. :param int arg: Some number. :returns: Argument :rtype: int """ return arg
-
Remember to use
./venv/bin/pylint
.
usage: sudo letsencrypt.py [-h] [-d DOMAIN [DOMAIN ...]] [-s SERVER] [-p PRIVKEY]
[-c CSR] [-b ROLLBACK] [-k] [-v] [-r] [-n] [-e] [-t]
[--test]
An ACME client that can update Apache configurations.
optional arguments:
-h, --help show this help message and exit
-d DOMAIN [DOMAIN ...], --domains DOMAIN [DOMAIN ...]
-s SERVER, --server SERVER
The ACME CA server address.
-p PRIVKEY, --privkey PRIVKEY
Path to the private key file for certificate
generation.
-c CSR, --csr CSR Path to the certificate signing request file
corresponding to the private key file. The private key
file argument is required if this argument is
specified.
-b N, --rollback N Revert configuration N number of checkpoints.
-k, --revoke Revoke a certificate.
-v, --view-checkpoints
View checkpoints and associated configuration changes.
-r, --redirect Automatically redirect all HTTP traffic to HTTPS for
the newly authenticated vhost.
-n, --no-redirect Skip the HTTPS redirect question, allowing both HTTP
and HTTPS.
-e, --agree-eula Skip the end user license agreement screen.
-t, --text Use the text output instead of the curses UI.
--test Run in test mode.
-
Further setup, documentation and open projects are available in the Wiki.
-
Join us at our IRC channel: #letsencrypt at Freenode.
-
Client software development can be discussed on this mailing list. To subscribe without a Google account, send an email to client-dev+subscribe@letsencrypt.org.