]> git.street.me.uk Git - andy/dehydrated.git/blame - README.md
changed dependency check for diff to be compatible with openbsd diff (fixes #219)
[andy/dehydrated.git] / README.md
CommitLineData
fa6857fe 1# letsencrypt.sh [![Build Status](https://travis-ci.org/lukas2511/letsencrypt.sh.svg?branch=master)](https://travis-ci.org/lukas2511/letsencrypt.sh)
61f0b7ed 2
e567a87e 3This is a client for signing certificates with an ACME-server (currently only provided by letsencrypt) implemented as a relatively simple bash-script.
274e8e41
LS
4
5It uses the `openssl` utility for everything related to actually handling keys and certificates, so you need to have that installed.
6
e45f28bb 7Other dependencies are: curl, sed, grep, mktemp (all found on almost any system, curl being the only exception)
274e8e41
LS
8
9Current features:
10- Signing of a list of domains
429ec400 11- Signing of a CSR
e45f28bb 12- Renewal if a certificate is about to expire or SAN (subdomains) changed
12c566b1 13- Certificate revocation
274e8e41
LS
14
15Please keep in mind that this software and even the acme-protocol are relatively young and may still have some unresolved issues.
16Feel free to report any issues you find with this script or contribute by submitting a pullrequest.
0d7913ab 17
12c77ca5
LS
18### Getting started
19
20For 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
22Generally 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
26If you have any problems take a look at our [Troubleshooting](docs/troubleshooting.md) guide.
27
0d7913ab
LS
28## Usage:
29
8662a000
LS
30```text
31Usage: ./letsencrypt.sh [-h] [command [argument]] [parameter [argument]] [parameter [argument]] ...
0d7913ab 32
083c6736 33Default command: help
8662a000
LS
34
35Commands:
083c6736 36 --cron (-c) Sign/renew non-existant/changed/expiring certificates.
429ec400 37 --signcsr (-s) path/to/csr.pem Sign a given CSR, output CRT on stdout (advanced usage)
8662a000 38 --revoke (-r) path/to/cert.pem Revoke specified certificate
63b61b89 39 --cleanup (-gc) Move unused certificate files to archive directory
8662a000
LS
40 --help (-h) Show help text
41 --env (-e) Output configuration variables for use in other scripts
42
43Parameters:
92a822e0
LS
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
8e77ba5e 46 --ocsp Sets option in CSR indicating OCSP stapling to be mandatory
8662a000 47 --privkey (-p) path/to/key.pem Use specified private key instead of account key (useful for revocation)
d5b28586 48 --config (-f) path/to/config Use specified config file
ed27e013 49 --hook (-k) path/to/hook.sh Use specified script for hooks
785ffa55 50 --out (-o) certs/directory Output certificates into the specified directory
e925b293 51 --challenge (-t) http-01|dns-01 Which challenge should be used? Currently http-01 and dns-01 are supported
63b61b89 52 --algo (-a) rsa|prime256v1|secp384r1 Which public key algorithm should be used? Supported: rsa, prime256v1 and secp384r1
0d7913ab 53```