README.md

   1 # letsencrypt.sh [![Build Status](https://travis-ci.org/lukas2511/letsencrypt.sh.svg?branch=master)](https://travis-ci.org/lukas2511/letsencrypt.sh)
   2
   3 This is a client for signing certificates with an ACME-server (currently only provided by letsencrypt) implemented as a relatively simple bash-script.
   4
   5 It uses the `openssl` utility for everything related to actually handling keys and certificates, so you need to have that installed.
   6
   7 Other dependencies are: curl, sed, grep, mktemp (all found on almost any system, curl being the only exception)
   8
   9 Current features:
  10 - Signing of a list of domains
  11 - Signing of a CSR
  12 - Renewal if a certificate is about to expire or SAN (subdomains) changed
  13 - Certificate revocation
  14
  15 Please keep in mind that this software and even the acme-protocol are relatively young and may still have some unresolved issues.
  16 Feel free to report any issues you find with this script or contribute by submitting a pullrequest.
  17
  18 ### Getting started
  19
  20 For getting started I recommend taking a look at [docs/domains_txt.md](docs/domains_txt.md), [docs/wellknown.md](docs/wellknown.md) and the [Usage](#usage) section on this page (you'll probably only need the `-c` option).
  21
  22 Generally you want to set up your WELLKNOWN path first, and then fill in domains.txt.
  23
  24 **Please note that you should use the staging URL when experimenting with this script to not hit letsencrypts rate limits.** See [docs/staging.md](docs/staging.md).
  25
  26 If you have any problems take a look at our [Troubleshooting](docs/troubleshooting.md) guide.
  27
  28 ## Usage:
  29
  30 ```text
  31 Usage: ./letsencrypt.sh [-h] [command [argument]] [parameter [argument]] [parameter [argument]] ...
  32
  33 Default command: help
  34
  35 Commands:
  36  --cron (-c)                      Sign/renew non-existant/changed/expiring certificates.
  37  --signcsr (-s) path/to/csr.pem   Sign a given CSR, output CRT on stdout (advanced usage)
  38  --revoke (-r) path/to/cert.pem   Revoke specified certificate
  39  --cleanup (-gc)                  Move unused certificate files to archive directory
  40  --help (-h)                      Show help text
  41  --env (-e)                       Output configuration variables for use in other scripts
  42
  43 Parameters:
  44  --domain (-d) domain.tld         Use specified domain name(s) instead of domains.txt entry (one certificate!)
  45  --force (-x)                     Force renew of certificate even if it is longer valid than value in RENEW_DAYS
  46  --privkey (-p) path/to/key.pem   Use specified private key instead of account key (useful for revocation)
  47  --config (-f) path/to/config.sh  Use specified config file
  48  --hook (-k) path/to/hook.sh      Use specified script for hooks
  49  --challenge (-t) http-01|dns-01  Which challenge should be used? Currently http-01 and dns-01 are supported
  50  --algo (-a) rsa|prime256v1|secp384r1 Which public key algorithm should be used? Supported: rsa, prime256v1 and secp384r1
  51 ```