From 396f6b0b50d4e8082f9405a7be18cc34ee4d8eae Mon Sep 17 00:00:00 2001 From: Peter Eckersley Date: Tue, 18 Nov 2014 02:31:55 -0800 Subject: [PATCH 1/7] Attempt to document dependencies --- README.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 07ade422e..4d3e02197 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,24 @@ 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 intended for testing, demonstration, and integration engineering -with OSes and hosting platforms. +with OSes and hosting platforms. Currently the code works with Linux and +Apache, though we will be expanding it to other platforms. + +To run the demo on Debian: + +sudo apt-get install python-pip python-crypto python-dev python-jsonschema +python-augeas gcc python-m2crypto + +sudo pip install jose + +# get a working copy of the python2 "dialog" module +# on debian stable + +sudo apt-get install python-dialog + +# on testing/unstable, "pip uninstall dialog", "pip uninstall pythondialog", +# then... +sudo pip install pythondialog=2.7 Debian packaging work will continue in the separate "debian" branch of this From 614cf89d55642969fea7e609db324fb6ea7ea365 Mon Sep 17 00:00:00 2001 From: Peter Eckersley Date: Tue, 18 Nov 2014 02:42:56 -0800 Subject: [PATCH 2/7] More documentation --- MANIFEST.in | 2 +- README.md | 16 ++++++++++------ 2 files changed, 11 insertions(+), 7 deletions(-) diff --git a/MANIFEST.in b/MANIFEST.in index 47ce7c6b6..192128adf 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1 +1 @@ -recursive-include trustify * +recursive-include letsencrypt/ * diff --git a/README.md b/README.md index 4d3e02197..c9f99e28d 100644 --- a/README.md +++ b/README.md @@ -7,22 +7,26 @@ This code 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. -To run the demo on Debian: +# Running the demo on Debian +` sudo apt-get install python-pip python-crypto python-dev python-jsonschema python-augeas gcc python-m2crypto sudo pip install jose +` -# get a working copy of the python2 "dialog" module -# on debian stable +Now get a working copy of the python2 "dialog" module. On debian stable: -sudo apt-get install python-dialog +`sudo apt-get install python-dialog` -# on testing/unstable, "pip uninstall dialog", "pip uninstall pythondialog", -# then... +on testing/unstable, "pip uninstall dialog", "pip uninstall pythondialog",then... + +` sudo pip install pythondialog=2.7 +sudo ./letsencrypt.py +` Debian packaging work will continue in the separate "debian" branch of this repo. From 3c89b6838c169d07f5acf7357e6846bcea4828c3 Mon Sep 17 00:00:00 2001 From: Peter Eckersley Date: Tue, 18 Nov 2014 02:44:58 -0800 Subject: [PATCH 3/7] formatting --- README.md | 16 ++++++---------- 1 file changed, 6 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index c9f99e28d..b3b7edd1f 100644 --- a/README.md +++ b/README.md @@ -9,24 +9,20 @@ Apache, though we will be expanding it to other platforms. # Running the demo on Debian -` -sudo apt-get install python-pip python-crypto python-dev python-jsonschema -python-augeas gcc python-m2crypto +` sudo apt-get install python-pip python-crypto python-dev python-jsonschema python-augeas gcc python-m2crypto` -sudo pip install jose -` +`sudo pip install jose` Now get a working copy of the python2 "dialog" module. On debian stable: `sudo apt-get install python-dialog` -on testing/unstable, "pip uninstall dialog", "pip uninstall pythondialog",then... +on testing/unstable, clear any buggy versions of dialog out (you may need "pip +uninstall dialog", "pip uninstall pythondialog") -` -sudo pip install pythondialog=2.7 +`sudo pip install pythondialog=2.7` -sudo ./letsencrypt.py -` +`sudo ./letsencrypt.py` Debian packaging work will continue in the separate "debian" branch of this repo. From 0e068b4670f038ddaea9b23926c347e7006ce3f1 Mon Sep 17 00:00:00 2001 From: Peter Eckersley Date: Tue, 18 Nov 2014 02:46:36 -0800 Subject: [PATCH 4/7] Add usage --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b3b7edd1f..94f5d6e14 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,13 @@ This is the Let's Encrypt Agent DEVELOPER PREVIEW repository. -DO NOT RUN THIS CODE ON A PRODUCTION WEBSERVER. IT WILL INSTALL CERTIFICATES +### 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 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 on Debian +## Running the demo on Debian ` sudo apt-get install python-pip python-crypto python-dev python-jsonschema python-augeas gcc python-m2crypto` From 6b69f6371ca0e1ec15aaebf6c3b8fd1198b3eca5 Mon Sep 17 00:00:00 2001 From: Peter Eckersley Date: Tue, 18 Nov 2014 02:46:59 -0800 Subject: [PATCH 5/7] Add usage --- README.md | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 94f5d6e14..d9e1e5a7f 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ This code 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 on Debian +## Running the demo code on Debian ` sudo apt-get install python-pip python-crypto python-dev python-jsonschema python-augeas gcc python-m2crypto` @@ -26,3 +26,23 @@ uninstall dialog", "pip uninstall pythondialog") Debian packaging work will continue in the separate "debian" branch of this repo. + +## Command line usage + + +sudo ./letsencrypt.py (default authentication mode using pythondialog) + +options --text (text mode) +--privkey= (specify privatekey file to use to generate the certificate) +--csr= (Use a specific CSR. If this is specified, privkey must also be +specified with the correct private key for the CSR) +--server (list the ACME CA server address) +--revoke (revoke a certificate) +--view-checkpoints (Used to view available checkpoints and see what +configuration changes have been made) +--rollback=X (Revert the configuration X number of checkpoints) +--redirect (Automatically redirect all HTTP traffic to HTTPS for the newly +authenticated vhost) +--no-redirect (Skip the HTTPS redirect question, allowing both HTTP and +HTTPS) +--agree-eula (Skip the end user agreement screen) From c9009b1e54185d99f5e68973e2f66b7a8c53d9bc Mon Sep 17 00:00:00 2001 From: Peter Eckersley Date: Tue, 18 Nov 2014 03:00:34 -0800 Subject: [PATCH 6/7] Cleanup README --- README.md | 19 ++++++------------- 1 file changed, 6 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index d9e1e5a7f..7acbffcd1 100644 --- a/README.md +++ b/README.md @@ -7,25 +7,18 @@ This code 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 Debian +## Running the demo code on Ubuntu -` sudo apt-get install python-pip python-crypto python-dev python-jsonschema python-augeas gcc python-m2crypto` +`sudo apt-get install python-pip python-crypto python-dev python-jsonschema python-augeas gcc python-m2crypto python-dialog` `sudo pip install jose` -Now get a working copy of the python2 "dialog" module. On debian stable: - -`sudo apt-get install python-dialog` - -on testing/unstable, clear any buggy versions of dialog out (you may need "pip -uninstall dialog", "pip uninstall pythondialog") - -`sudo pip install pythondialog=2.7` - `sudo ./letsencrypt.py` -Debian packaging work will continue in the separate "debian" branch of this -repo. +Hint: on Debian testing/unstable, python-dialog is unavailable and you may +need to do `sudo pip install pythondialog=2.7` (lets-encrypt does not yet +handle debian unstable's Apache2 conf layout, either...) + ## Command line usage From c18e0838d68a48ab0a0ab6cbccd107c92a143ed8 Mon Sep 17 00:00:00 2001 From: Peter Eckersley Date: Tue, 18 Nov 2014 03:14:49 -0800 Subject: [PATCH 7/7] README formatting --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index 7acbffcd1..c19cf8cf6 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,6 @@ 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 intended for testing, demonstration, and integration engineering with OSes and hosting platforms. Currently the code works with Linux and