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