switch to sign_domains command if domain parameter is given

[andy/dehydrated.git] / README.md

diff --git a/README.md b/README.md
index 5c0b3e1941d1830fbbe99d9c37f89bb2f6aefc2f..1b2c6cfff734f432fd9dce35c5c1ea473fb66267 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
-# letsencrypt.sh
+# letsencrypt.sh [![Build Status](https://travis-ci.org/lukas2511/letsencrypt.sh.svg?branch=master)](https://travis-ci.org/lukas2511/letsencrypt.sh)
 
-This is a client for signing certificates with an ACME-server (currently only provided by letsencrypt) implemented as a relatively simple 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.
 
@@ -19,9 +19,29 @@ Feel free to report any issues you find with this script or contribute by submit
 
 ## Usage:
 
-Add domains to domains.txt like in this example:
+```text
+Usage: ./letsencrypt.sh [-h] [command [argument]] [parameter [argument]] [parameter [argument]] ...
 
+Default command: cron
+
+Commands:
+ --cron (-c)                      Sign/renew non-existant/changed(TODO)/expiring certificates.
+ --revoke (-r) path/to/cert.pem   Revoke specified certificate
+ --help (-h)                      Show help text
+ --env (-e)                       Output configuration variables for use in other scripts
+
+Parameters:
+ --domain (-d) domain.tld         Use specified domain name instead of domains.txt, use multiple times for certificate with SAN names
+ --force (-x)                     force renew of certificate even if it is longer valid than value in RENEW_DAYS
+ --config (-f) path/to/config.sh  Use specified config file
+ --privkey (-p) path/to/key.pem   Use specified private key instead of account key (useful for revocation)
 ```
+
+### domains.txt
+
+The file `domains.txt` should have the following format:
+
+```text
 example.com www.example.com
 example.net www.example.net wiki.example.net
 ```
@@ -29,18 +49,7 @@ 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
+### example nginx config
 
 If you want to use nginx you can set up a location block to serve your challenge responses:
 
@@ -50,6 +59,9 @@ location /.well-known/acme-challenge {
 }
 ```
 
+For this to work i'd suggest either configuring `/var/www/letsencrypt` as WELLKNOWN directory,
+or to create a symlink to the default location next to the script: `ln -s /var/www/letsencrypt .acme-challenges`
+
 ## Import
 
 ### import-account.pl
@@ -59,7 +71,7 @@ This perl-script can be used to import the account key from the original letsenc
 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: `perl import-account.pl`
+Usage: `./import-account.pl`
 
 ### import-certs.sh