X-Git-Url: https://git.street.me.uk/andy/dehydrated.git/blobdiff_plain/0c1e958d1919c58bb926193d5ae0acb1b1128876..69eea9527fd4fc4993e712ca581d25f2d41a01dc:/README.md diff --git a/README.md b/README.md index 408cab6..6476bbf 100644 --- a/README.md +++ b/README.md @@ -2,14 +2,13 @@ ![](docs/logo.jpg) -*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... -For now there is a wrapper script for compatibility with old config locations and symlinks, but it will be removed in a few weeks.* +*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... For now there is a wrapper script for compatibility with old config locations and symlinks, but it will be removed in a few weeks.* -This is a client for signing certificates with an ACME-server (currently only provided by letsencrypt) implemented as a relatively simple bash-script. +This is a client for signing certificates with an ACME-server (currently only provided by Let's Encrypt) 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. -Other dependencies are: curl, sed, grep, mktemp (all found on almost any system, curl being the only exception) +Other dependencies are: cURL, sed, grep, mktemp (all found on almost any system, cURL being the only exception) Current features: - Signing of a list of domains @@ -17,8 +16,7 @@ Current features: - Renewal if a certificate is about to expire or SAN (subdomains) changed - Certificate revocation -Please keep in mind that this software and even the acme-protocol are relatively young and may still have some unresolved issues. -Feel free to report any issues you find with this script or contribute by submitting a pullrequest. +Please keep in mind that this software and even the acme-protocol are relatively young and may still have some unresolved issues. Feel free to report any issues you find with this script or contribute by submitting a pull request. ### Getting started @@ -26,7 +24,7 @@ For getting started I recommend taking a look at [docs/domains_txt.md](docs/doma Generally you want to set up your WELLKNOWN path first, and then fill in domains.txt. -**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). +**Please note that you should use the staging URL when experimenting with this script to not hit Let's Encrypt's rate limits.** See [docs/staging.md](docs/staging.md). If you have any problems take a look at our [Troubleshooting](docs/troubleshooting.md) guide.