From 6b69f6371ca0e1ec15aaebf6c3b8fd1198b3eca5 Mon Sep 17 00:00:00 2001 From: Peter Eckersley Date: Tue, 18 Nov 2014 02:46:59 -0800 Subject: [PATCH] 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)