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 07ade422e..c19cf8cf6 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,40 @@ 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. +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 + +`sudo apt-get install python-pip python-crypto python-dev python-jsonschema python-augeas gcc python-m2crypto python-dialog` + +`sudo pip install jose` + +`sudo ./letsencrypt.py` + +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...) -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)