Merge pull request #33 from M-M-M-M/clean_challenge

[andy/dehydrated.git] / README.md

diff --git a/README.md b/README.md
index 0e00322a114e2f3e3523e6429437dcba91f05775..61d02ed6f2e009f7ed266185694939cda85ec368 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,3 +1,71 @@
-# letsencrypt.sh
+# letsencrypt.sh [![Build Status](https://travis-ci.org/lukas2511/letsencrypt.sh.svg?branch=master)](https://travis-ci.org/lukas2511/letsencrypt.sh)
 
-letsencrypt client implemented as a shell-script
+This is a client for signing certificates with an ACME-server (currently only provided by letsencrypt) implemented as a relatively simple bash-script.
+
+It uses the `openssl` utility for everything related to actually handling keys and certificates, so you need to have that installed.
+
+Other dependencies are (for now): curl, sed
+
+Perl no longer is a dependency.
+The only remaining perl code in this repository is the script you can use to convert your existing letsencrypt-keyfile into something openssl (and this script) can read.
+
+Current features:
+- Signing of a list of domains
+- Renewal if a certificate is about to expire
+- Certificate revocation
+
+Please keep in mind that this software and even the acme-protocol are relatively young and may still have some unresolved issues.
+Feel free to report any issues you find with this script or contribute by submitting a pullrequest.
+
+## Usage:
+
+Add domains to domains.txt like in this example:
+
+```
+example.com www.example.com
+example.net www.example.net wiki.example.net
+```
+
+This states that there should be two certificates `example.com` and `example.net`,
+with the other domains in the corresponding line being their alternative names.
+
+You'll also need to set up a webserver to serve the challenge-response directory as configured with `$WELLKNOWN`,
+or you can use the hook in the script if you want to deploy it some other way (e.g. copy it to a server via scp).
+
+After doing those two things you can just `./letsencrypt.sh`, and it should generate certificates.
+
+It can be used inside a cronjob as it automatically detects if a certificate is about to expire.
+
+### Certificate revocation
+
+Usage: `./letsencrypt.sh revoke path/to/cert.pem`
+
+### nginx config
+
+If you want to use nginx you can set up a location block to serve your challenge responses:
+
+```
+location /.well-known/acme-challenge {
+  root /var/www/letsencrypt;
+}
+```
+
+## Import
+
+### import-account.pl
+
+This perl-script can be used to import the account key from the original letsencrypt client.
+
+You should copy `private_key.json` to the same directory as the script.
+The json-file can be found in a subdirectory of `/etc/letsencrypt/accounts/acme-v01.api.letsencrypt.org/directory`.
+
+Usage: `./import-account.pl`
+
+### import-certs.sh
+
+This script can be used to import private keys and certificates created by the original letsencrypt client.
+
+By default it expects the certificates to be found under `/etc/letsencrypt`, which is the default output directory of the original client.
+You can change the path by setting LETSENCRYPT in your config file: ```LETSENCRYPT="/etc/letsencrypt"```.
+
+Usage: `./import-certs.sh`