README.md

   1 # dehydrated [![Build Status](https://travis-ci.org/lukas2511/dehydrated.svg?branch=master)](https://travis-ci.org/lukas2511/dehydrated)
   2
   3 ![](docs/logo.jpg)
   4
   5 *Note: This project was renamed from letsencrypt.sh because the original name was violating Let's Encrypts trademark policy. I know that this results in quite a lot of installations failing but I didn't have a choice...
   6 For now there is a wrapper script for compatibility with old config locations and symlinks, but it will be removed in a few weeks.*
   7
   8 This is a client for signing certificates with an ACME-server (currently only provided by letsencrypt) implemented as a relatively simple bash-script.
   9
  10 It uses the `openssl` utility for everything related to actually handling keys and certificates, so you need to have that installed.
  11
  12 Other dependencies are: curl, sed, grep, mktemp (all found on almost any system, curl being the only exception)
  13
  14 Current features:
  15 - Signing of a list of domains
  16 - Signing of a CSR
  17 - Renewal if a certificate is about to expire or SAN (subdomains) changed
  18 - Certificate revocation
  19
  20 Please keep in mind that this software and even the acme-protocol are relatively young and may still have some unresolved issues.
  21 Feel free to report any issues you find with this script or contribute by submitting a pullrequest.
  22
  23 ### Getting started
  24
  25 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).
  26
  27 Generally you want to set up your WELLKNOWN path first, and then fill in domains.txt.
  28
  29 **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).
  30
  31 If you have any problems take a look at our [Troubleshooting](docs/troubleshooting.md) guide.
  32
  33 ## Usage:
  34
  35 ```text
  36 Usage: ./dehydrated [-h] [command [argument]] [parameter [argument]] [parameter [argument]] ...
  37
  38 Default command: help
  39
  40 Commands:
  41  --cron (-c)                      Sign/renew non-existant/changed/expiring certificates.
  42  --signcsr (-s) path/to/csr.pem   Sign a given CSR, output CRT on stdout (advanced usage)
  43  --revoke (-r) path/to/cert.pem   Revoke specified certificate
  44  --cleanup (-gc)                  Move unused certificate files to archive directory
  45  --help (-h)                      Show help text
  46  --env (-e)                       Output configuration variables for use in other scripts
  47
  48 Parameters:
  49  --full-chain (-fc)               Print full chain when using --signcsr
  50  --ipv4 (-4)                      Resolve names to IPv4 addresses only
  51  --ipv6 (-6)                      Resolve names to IPv6 addresses only
  52  --domain (-d) domain.tld         Use specified domain name(s) instead of domains.txt entry (one certificate!)
  53  --keep-going (-g)                Keep going after encountering an error while creating/renewing multiple certificates in cron mode
  54  --force (-x)                     Force renew of certificate even if it is longer valid than value in RENEW_DAYS
  55  --no-lock (-n)                   Don't use lockfile (potentially dangerous!)
  56  --ocsp                           Sets option in CSR indicating OCSP stapling to be mandatory
  57  --privkey (-p) path/to/key.pem   Use specified private key instead of account key (useful for revocation)
  58  --config (-f) path/to/config     Use specified config file
  59  --hook (-k) path/to/hook.sh      Use specified script for hooks
  60  --out (-o) certs/directory       Output certificates into the specified directory
  61  --challenge (-t) http-01|dns-01  Which challenge should be used? Currently http-01 and dns-01 are supported
  62  --algo (-a) rsa|prime256v1|secp384r1 Which public key algorithm should be used? Supported: rsa, prime256v1 and secp384r1
  63 ```