From dbd024f77cc6dfba1213fb893ae2f78943ad5f6b Mon Sep 17 00:00:00 2001 From: Jakub Warmuz Date: Fri, 19 Jun 2015 10:07:18 +0000 Subject: [PATCH 01/14] Inline docs fixes --- letsencrypt/network2.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/letsencrypt/network2.py b/letsencrypt/network2.py index 9b846da6c..f2620b4b1 100644 --- a/letsencrypt/network2.py +++ b/letsencrypt/network2.py @@ -25,7 +25,7 @@ class Network(object): .. todo:: Clean up raised error types hierarchy, document, and handle (wrap) - instances of `.DeserializationError` raised in `from_json()``. + instances of `.DeserializationError` raised in `from_json()`. :ivar str new_reg_uri: Location of new-reg :ivar key: `.JWK` (private) From f46e2aeedd69ebe62481f750eb190471b1975676 Mon Sep 17 00:00:00 2001 From: Jakub Warmuz Date: Fri, 19 Jun 2015 10:06:39 +0000 Subject: [PATCH 02/14] README: documentation link at the top. Hopefully helps to mitigate problems mentioned in https://groups.google.com/a/letsencrypt.org/forum/#!topic/client-dev/4xpVpy4EVz0 --- README.rst | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index db32889db..5b149abe5 100644 --- a/README.rst +++ b/README.rst @@ -1,3 +1,9 @@ +.. notice for github users + +Official **documentation**, including `installation instructions`_, is +available at https://letsencrypt.readthedocs.org. + + About the Let's Encrypt Client ============================== @@ -47,6 +53,9 @@ server automatically!:: :target: https://quay.io/repository/letsencrypt/lets-encrypt-preview :alt: Docker Repository on Quay.io +.. _`installation instructions`: + https://letsencrypt.readthedocs.org/en/latest/using.html + .. _watch demo video: https://www.youtube.com/watch?v=Gas_sSB-5SU @@ -85,7 +94,7 @@ Current Features Links ----- -Documentation: https://letsencrypt.readthedocs.org/ +Documentation: https://letsencrypt.readthedocs.org Software project: https://github.com/letsencrypt/lets-encrypt-preview From 3382dac793fee6b06618c8aa6d27b8580ab4525e Mon Sep 17 00:00:00 2001 From: Jakub Warmuz Date: Fri, 19 Jun 2015 10:17:15 +0000 Subject: [PATCH 03/14] README: FAQ link at the top. --- README.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.rst b/README.rst index 5b149abe5..40c054fe3 100644 --- a/README.rst +++ b/README.rst @@ -3,6 +3,10 @@ Official **documentation**, including `installation instructions`_, is available at https://letsencrypt.readthedocs.org. +Generic information about Let's Encrypt project can be found at +https://letsencrypt.org. Please read `Frequently Asked Questions (FAQ) +`_. + About the Let's Encrypt Client ============================== From a1f5ea8e8ce81e1415c6da98325a39dce1f7f9c9 Mon Sep 17 00:00:00 2001 From: Jakub Warmuz Date: Fri, 19 Jun 2015 09:55:33 +0000 Subject: [PATCH 04/14] Docs: note about pip editable mode. --- docs/contributing.rst | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/contributing.rst b/docs/contributing.rst index f527ba421..eb9854581 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -17,6 +17,15 @@ Now you can install the development packages: ./venv/bin/pip install -r requirements.txt -e .[dev,docs,testing] +.. note:: `-e` (short for `--editable`) turns on *editable mode* in + which any source code changes in the current working + directory are "live" and no further `pip install ...` + invocations are necessary while developing. Any `pip install + .` call will re-install Let's Encrypt in non-editable mode. + + This is roughly equivalent to `python setup.py develop`. For + more info see `man pip`. + The code base, including your pull requests, **must** have 100% test statement coverage **and** be compliant with the :ref:`coding style `. From 673a6d4f3710718b7f82e48f7de55d6636dfbc04 Mon Sep 17 00:00:00 2001 From: Jakub Warmuz Date: Fri, 19 Jun 2015 10:41:04 +0000 Subject: [PATCH 05/14] Docs: move SWIG notes below installation cmd, Mac OS X note. --- docs/using.rst | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/docs/using.rst b/docs/using.rst index a180a3826..6709ad51a 100644 --- a/docs/using.rst +++ b/docs/using.rst @@ -31,13 +31,6 @@ In general: * ``sudo`` is required as a suggested way of running privileged process * `SWIG`_ is required for compiling `M2Crypto`_ - - .. _new-swig: - .. note:: If your operating system uses SWIG 3.0.5+, you will need - to run ``pip install -r requirements-swig-3.0.5.txt -r - requirements.txt`` instead of the standard ``pip - install -r requirements.txt``. - * `Augeas`_ is required for the Python bindings @@ -79,8 +72,6 @@ Fedora sudo ./bootstrap/fedora.sh -.. note:: Fedora 22 uses SWIG 3.0.5+, use the :ref:`modified pip - command for installation `. Centos 7 -------- @@ -106,6 +97,13 @@ Installation virtualenv --no-site-packages -p python2 venv ./venv/bin/pip install -r requirements.txt . +.. note:: If your operating system uses SWIG 3.0.5+, you will need to + run ``pip install -r requirements-swig-3.0.5.txt -r + requirements.txt`` instead. Known affected systems: + + * Fedora 22 + * some versions of Mac OS X + Usage ===== From 1a013eae6e021d763f3a692e10de44add751d96a Mon Sep 17 00:00:00 2001 From: Jakub Warmuz Date: Fri, 19 Jun 2015 10:49:18 +0000 Subject: [PATCH 06/14] Docs: no support for setup.py, root, or non-Virtualenv installation. --- docs/using.rst | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/using.rst b/docs/using.rst index 6709ad51a..0014a1192 100644 --- a/docs/using.rst +++ b/docs/using.rst @@ -97,6 +97,14 @@ Installation virtualenv --no-site-packages -p python2 venv ./venv/bin/pip install -r requirements.txt . +.. warning:: Please do **not** use ``python setup.py install``. Please + do **not** attempt the installation commands as + superuser/root and/or without Virtualenv_, e.g. ``sudo + python setup.py install``, ``sudo pip install``, ``sudo + ./venv/bin/...``. These modes of operation might corrupt + your operating system and are **not supported** by the + Let's Encrypt team! + .. note:: If your operating system uses SWIG 3.0.5+, you will need to run ``pip install -r requirements-swig-3.0.5.txt -r requirements.txt`` instead. Known affected systems: @@ -118,3 +126,4 @@ The letsencrypt commandline tool has a builtin help: .. _Augeas: http://augeas.net/ .. _M2Crypto: https://github.com/M2Crypto/M2Crypto .. _SWIG: http://www.swig.org/ +.. _Virtualenv: https://virtualenv.pypa.io From ca6b326371a60e5104e5bd53b34ff502ac0839c3 Mon Sep 17 00:00:00 2001 From: Jakub Warmuz Date: Fri, 19 Jun 2015 11:00:00 +0000 Subject: [PATCH 07/14] Docs: add "Getting the code" section. --- docs/using.rst | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/docs/using.rst b/docs/using.rst index 0014a1192..c829e9c80 100644 --- a/docs/using.rst +++ b/docs/using.rst @@ -20,6 +20,25 @@ And follow the instructions. Your new cert will be available in ``/etc/letsencrypt/certs``. +Getting the code +================ + +Please `install Git`_ and run the following commands: + +.. code-block:: shell + + git clone https://github.com/letsencrypt/lets-encrypt-preview + cd lets-encrypt-preview + +Alternatively you could `download the ZIP archive`_ and extract the +snapshot of our repository, but it's strongly recommended to use the +above method instead. + +.. _`install Git`: https://git-scm.com/book/en/v2/Getting-Started-Installing-Git +.. _`download the ZIP archive`: + https://github.com/letsencrypt/lets-encrypt-preview/archive/master.zip + + Prerequisites ============= From 8292eab3f7c6803746c2ff857b82a754b275920b Mon Sep 17 00:00:00 2001 From: Jakub Warmuz Date: Fri, 19 Jun 2015 11:01:56 +0000 Subject: [PATCH 08/14] Docs: add link to Docker docs. --- docs/using.rst | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/using.rst b/docs/using.rst index c829e9c80..51c5527f6 100644 --- a/docs/using.rst +++ b/docs/using.rst @@ -5,9 +5,9 @@ Using the Let's Encrypt client Quick start =========== -Using docker you can quickly get yourself a testing cert. From the +Using Docker_ you can quickly get yourself a testing cert. From the server that the domain your requesting a cert for resolves to, -download docker, and issue the following command +`install Docker`_, issue the following command: .. code-block:: shell @@ -16,9 +16,12 @@ download docker, and issue the following command -v "/var/lib/letsencrypt:/var/lib/letsencrypt" \ quay.io/letsencrypt/lets-encrypt-preview:latest -And follow the instructions. Your new cert will be available in +and follow the instructions. Your new cert will be available in ``/etc/letsencrypt/certs``. +.. _Docker: https://docker.com +.. _`install Docker`: https://docs.docker.com/docker/userguide/ + Getting the code ================ From b8ebb0ab161c4a27eaaffa14fe6860b44ed96e29 Mon Sep 17 00:00:00 2001 From: Jakub Warmuz Date: Fri, 19 Jun 2015 11:03:05 +0000 Subject: [PATCH 09/14] Docs: backticks nit. --- docs/using.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/using.rst b/docs/using.rst index 51c5527f6..29e8902a9 100644 --- a/docs/using.rst +++ b/docs/using.rst @@ -138,7 +138,7 @@ Installation Usage ===== -The letsencrypt commandline tool has a builtin help: +The ``letsencrypt`` commandline tool has a builtin help: .. code-block:: shell From 4040fd02045d871601c1866f25d8e2da11d78a48 Mon Sep 17 00:00:00 2001 From: Jakub Warmuz Date: Fri, 19 Jun 2015 11:21:51 +0000 Subject: [PATCH 10/14] Docs: extend usage section with "letsencrypt auth" call. --- docs/using.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/using.rst b/docs/using.rst index 29e8902a9..20f07d5d1 100644 --- a/docs/using.rst +++ b/docs/using.rst @@ -138,6 +138,12 @@ Installation Usage ===== +To get a new certificate run: + +.. code-block:: shell + + ./venv/bin/letsencrypt auth + The ``letsencrypt`` commandline tool has a builtin help: .. code-block:: shell From e176ad8f43e3342a346194875c147b66078c8306 Mon Sep 17 00:00:00 2001 From: Jakub Warmuz Date: Mon, 15 Jun 2015 18:31:50 +0000 Subject: [PATCH 11/14] Remove old Boulder incompatibility issue --- letsencrypt/network2.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/letsencrypt/network2.py b/letsencrypt/network2.py index f2620b4b1..a20194a79 100644 --- a/letsencrypt/network2.py +++ b/letsencrypt/network2.py @@ -257,13 +257,12 @@ class Network(object): # TODO: Boulder does not set Location or Link on update # (c.f. acme-spec #94) - updated_regr = self._regr_from_response( response, uri=regr.uri, new_authzr_uri=regr.new_authzr_uri, terms_of_service=regr.terms_of_service) if updated_regr != regr: - # TODO: Boulder reregisters with new recoveryToken and new URI raise errors.UnexpectedUpdate(regr) + return updated_regr def agree_to_tos(self, regr): From 4d39699befb583820246580a4ad058828b2e81cb Mon Sep 17 00:00:00 2001 From: Jakub Warmuz Date: Thu, 18 Jun 2015 10:56:08 +0000 Subject: [PATCH 12/14] Remove doubled :members: from acme errors docs --- docs/pkgs/acme/index.rst | 3 --- 1 file changed, 3 deletions(-) diff --git a/docs/pkgs/acme/index.rst b/docs/pkgs/acme/index.rst index 9cca3b795..1c73a4a42 100644 --- a/docs/pkgs/acme/index.rst +++ b/docs/pkgs/acme/index.rst @@ -51,9 +51,6 @@ Errors :members: - :members: - - Utilities --------- From 23c5a1fd90e1140af4455e32f6e2bf2e270923b9 Mon Sep 17 00:00:00 2001 From: Jakub Warmuz Date: Fri, 19 Jun 2015 16:13:53 +0000 Subject: [PATCH 13/14] Docs: "." and functools32 adjustements --- docs/using.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/using.rst b/docs/using.rst index 20f07d5d1..96eb62b05 100644 --- a/docs/using.rst +++ b/docs/using.rst @@ -108,7 +108,7 @@ backslash): .. code-block:: shell SWIG_FEATURES="-includeall -D__`uname -m`__-I/usr/include/openssl" \ - ./venv/bin/pip install -r requirements.txt functools32 + ./venv/bin/pip install -r requirements.txt . Installation @@ -129,7 +129,7 @@ Installation .. note:: If your operating system uses SWIG 3.0.5+, you will need to run ``pip install -r requirements-swig-3.0.5.txt -r - requirements.txt`` instead. Known affected systems: + requirements.txt .`` instead. Known affected systems: * Fedora 22 * some versions of Mac OS X From 50e509604cfc70a776c682a5735572feac7dda6a Mon Sep 17 00:00:00 2001 From: Jakub Warmuz Date: Sat, 20 Jun 2015 10:20:54 +0000 Subject: [PATCH 14/14] Docs: remove wrong re-install comment --- docs/contributing.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/contributing.rst b/docs/contributing.rst index eb9854581..804cec95c 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -20,8 +20,7 @@ Now you can install the development packages: .. note:: `-e` (short for `--editable`) turns on *editable mode* in which any source code changes in the current working directory are "live" and no further `pip install ...` - invocations are necessary while developing. Any `pip install - .` call will re-install Let's Encrypt in non-editable mode. + invocations are necessary while developing. This is roughly equivalent to `python setup.py develop`. For more info see `man pip`.