From 884ab38334580f91fcda79cf38cc960b3843513b Mon Sep 17 00:00:00 2001 From: Damien Nozay Date: Wed, 26 Nov 2014 17:38:15 -0800 Subject: [PATCH 1/5] trivial: update readme --- README.md | 40 ++++++++++++++++++++++++++++------------ 1 file changed, 28 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 878652b41..7459173df 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,15 @@ -This is the Let's Encrypt Agent DEVELOPER PREVIEW repository. +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. +**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. Currently the code works with Linux and Apache, though we will be expanding it to other platforms. -## Running the demo code on Ubuntu +## Running the demo code + +### on Ubuntu ``` sudo apt-get install python python-setuptools python-virtualenv \ @@ -20,6 +22,16 @@ sudo ./venv/bin/letsencrypt Note, that letsencrypt does not yet handle Debian unstable's Apache2 conf layout. +### on OSX + +* [swig] is required for compiling [m2crypto]. +* [augeas] is required for editing configuration. + +``` +sudo brew install swig +sudo brew install augeas +``` + ## Hacking 1. Bootstrap: `./venv/bin/python setup.py dev` @@ -63,14 +75,18 @@ optional arguments: ## More Information -Further Setup, documentation and open projects are available in the [Wiki] -(https://github.com/letsencrypt/lets-encrypt-preview/wiki) +Further Setup, documentation and open projects are available in the [Wiki]. -Join us at our IRC channel @ freenode.net #letsencrypt +Join us at our IRC channel @ freenode.net `#letsencrypt`. -Client software development can be discussed on this [mailing list] -(https://groups.google.com/a/letsencrypt.org/forum/#!forum/client-dev) +Client software development can be discussed on this [mailing list]. -To subscribe without a Google account, send mail to -[client-dev+subscribe@letsencrypt.org] -(mailto:client-dev+subscribe@letsencrypt.org). +To subscribe without a Google account, send mail to . + + + +[swig]: http://www.swig.org/ +[m2crypto]: https://github.com/M2Crypto/M2Crypto +[augeas]: http://augeas.net/ +[mailing list]: https://groups.google.com/a/letsencrypt.org/forum/#!forum/client-dev +[wiki]: https://github.com/letsencrypt/lets-encrypt-preview/wiki From 89ea2888596bd5d6ee6e0d0f4094d41f702e4427 Mon Sep 17 00:00:00 2001 From: Jakub Warmuz Date: Thu, 27 Nov 2014 23:34:15 +0100 Subject: [PATCH 2/5] Fix dnozay README as per #81 --- README.md | 76 +++++++++++++++++++++++++++++++++++-------------------- 1 file changed, 48 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index 7459173df..cf190aaa2 100644 --- a/README.md +++ b/README.md @@ -1,37 +1,55 @@ -This is the Let's Encrypt Agent **DEVELOPER PREVIEW** repository. +# Let's Encrypt -**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.** +[![Build Status](https://travis-ci.org/letsencrypt/lets-encrypt-preview.svg?branch=master)] +(https://travis-ci.org/letsencrypt/lets-encrypt-preview) -This code is intended for testing, demonstration, and integration engineering -with OSes and hosting platforms. Currently the code works with Linux and -Apache, though we will be expanding it to other platforms. +## Disclaimer + +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. ## Running the demo code -### on Ubuntu +The demo code is supported and known to work on *Ubuntu only* (even +closely related [Debian is known to fail] +(https://github.com/letsencrypt/lets-encrypt-preview/issues/68)). +Therefore, prerequisites for other platforms listed below are provided +mainly for the [developers](#hacking) reference. + +### Prerequisites + +In general: + +* [swig] is required for compiling [m2crypto] +* [libaugeas] is required for the `python-augeas` bindings + +#### Ubuntu ``` sudo apt-get install python python-setuptools python-virtualenv \ python-dev gcc swig dialog libaugeas0 libssl-dev +``` + +#### Mac OSX + +`sudo brew install augeas swig` + +### Installation + +``` virtualenv --no-site-packages venv ./venv/bin/python setup.py install sudo ./venv/bin/letsencrypt ``` -Note, that letsencrypt does not yet handle Debian unstable's Apache2 -conf layout. - -### on OSX - -* [swig] is required for compiling [m2crypto]. -* [augeas] is required for editing configuration. - -``` -sudo brew install swig -sudo brew install augeas -``` - ## Hacking 1. Bootstrap: `./venv/bin/python setup.py dev` @@ -75,18 +93,20 @@ optional arguments: ## More Information -Further Setup, documentation and open projects are available in the [Wiki]. +- Further setup, documentation and open projects are available in the + [Wiki]. -Join us at our IRC channel @ freenode.net `#letsencrypt`. +- Join us at our IRC channel @ [freenode.net + `#letsencrypt`](irc://irc.freenode.net/letsencrypt). -Client software development can be discussed on this [mailing list]. - -To subscribe without a Google account, send mail to . +- Client software development can be discussed on this [mailing + list]. To subscribe without a Google account, send mail to + . - -[swig]: http://www.swig.org/ +[Let's Encrypt](https://letsencrypt.org) +[swig]: http://www.swig.org [m2crypto]: https://github.com/M2Crypto/M2Crypto -[augeas]: http://augeas.net/ +[augeas]: http://augeas.net [mailing list]: https://groups.google.com/a/letsencrypt.org/forum/#!forum/client-dev [wiki]: https://github.com/letsencrypt/lets-encrypt-preview/wiki From f4a8ee56abcc176cc511e2b36587b182a9d0f6c5 Mon Sep 17 00:00:00 2001 From: Jakub Warmuz Date: Thu, 27 Nov 2014 23:40:58 +0100 Subject: [PATCH 3/5] Further fixes to README --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index cf190aaa2..3aad1c061 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ it to other platforms. ## Running the demo code -The demo code is supported and known to work on *Ubuntu only* (even +The demo code is supported and known to work on **Ubuntu only** (even closely related [Debian is known to fail] (https://github.com/letsencrypt/lets-encrypt-preview/issues/68)). Therefore, prerequisites for other platforms listed below are provided @@ -29,7 +29,7 @@ mainly for the [developers](#hacking) reference. In general: * [swig] is required for compiling [m2crypto] -* [libaugeas] is required for the `python-augeas` bindings +* [augeas] is required for the `python-augeas` bindings #### Ubuntu @@ -96,17 +96,17 @@ optional arguments: - Further setup, documentation and open projects are available in the [Wiki]. -- Join us at our IRC channel @ [freenode.net - `#letsencrypt`](irc://irc.freenode.net/letsencrypt). +- 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 mail to + list]. To subscribe without a Google account, send an email to . -[Let's Encrypt](https://letsencrypt.org) -[swig]: http://www.swig.org -[m2crypto]: https://github.com/M2Crypto/M2Crypto [augeas]: http://augeas.net +[Freenode]: https://freenode.net +[Let's Encrypt]: https://letsencrypt.org +[m2crypto]: https://github.com/M2Crypto/M2Crypto [mailing list]: https://groups.google.com/a/letsencrypt.org/forum/#!forum/client-dev +[swig]: http://www.swig.org [wiki]: https://github.com/letsencrypt/lets-encrypt-preview/wiki From 58196f046e07c4f68aeab05dff72ab7e78dc11f8 Mon Sep 17 00:00:00 2001 From: Jakub Warmuz Date: Thu, 27 Nov 2014 23:43:13 +0100 Subject: [PATCH 4/5] Fix email link in README --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 3aad1c061..9dc7b8d16 100644 --- a/README.md +++ b/README.md @@ -100,7 +100,7 @@ optional arguments: - 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. [augeas]: http://augeas.net From 5665ea96d433a32112ee34c5758227d7d1256662 Mon Sep 17 00:00:00 2001 From: Jakub Warmuz Date: Thu, 27 Nov 2014 23:48:25 +0100 Subject: [PATCH 5/5] Remove build badge --- README.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/README.md b/README.md index 9dc7b8d16..e20f51b14 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,5 @@ # Let's Encrypt -[![Build Status](https://travis-ci.org/letsencrypt/lets-encrypt-preview.svg?branch=master)] -(https://travis-ci.org/letsencrypt/lets-encrypt-preview) - ## Disclaimer This is the [Let's Encrypt] Agent **DEVELOPER PREVIEW** repository.