acme.sh/README.md

409 lines
13 KiB
Markdown
Raw Normal View History

2016-11-09 15:44:24 +00:00
# An ACME Shell script: acme.sh [![Build Status](https://travis-ci.org/Neilpang/acme.sh.svg?branch=master)](https://travis-ci.org/Neilpang/acme.sh)
- An ACME protocol client written purely in Shell (Unix shell) language.
2016-11-15 13:13:58 +00:00
- Full ACME protocol implementation.
- Simple, powerful and very easy to use. You only need 3 minutes to learn it.
- Bash, dash and sh compatible.
- Simplest shell script for Let's Encrypt free certificate client.
2016-11-15 13:13:58 +00:00
- Purely written in Shell with no dependencies on python or the official Let's Encrypt client.
- Just one script to issue, renew and install your certificates automatically.
2016-04-21 13:12:48 +00:00
- DOES NOT require `root/sudoer` access.
2015-12-26 13:44:39 +00:00
It's probably the `easiest&smallest&smartest` shell script to automatically issue & renew the free certificates from Let's Encrypt.
2015-12-26 13:44:39 +00:00
2016-04-14 13:44:26 +00:00
Wiki: https://github.com/Neilpang/acme.sh/wiki
2016-04-05 14:48:33 +00:00
2016-11-15 13:13:58 +00:00
2017-01-30 06:29:40 +00:00
Twitter: [@neilpangxa](https://twitter.com/neilpangxa)
2016-09-30 13:27:23 +00:00
# [中文说明](https://github.com/Neilpang/acme.sh/wiki/%E8%AF%B4%E6%98%8E)
2016-11-15 13:13:58 +00:00
# Tested OS
2016-04-21 13:09:08 +00:00
| NO | Status| Platform|
|----|-------|---------|
2016-04-25 05:48:03 +00:00
|1|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/ubuntu-latest.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)| Ubuntu
|2|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/debian-latest.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)| Debian
|3|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/centos-latest.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|CentOS
2016-04-25 05:49:02 +00:00
|4|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/windows-cygwin.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|Windows (cygwin with curl, openssl and crontab included)
2016-04-25 05:48:03 +00:00
|5|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/freebsd.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|FreeBSD
|6|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/pfsense.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|pfsense
|7|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/opensuse-latest.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|openSUSE
|8|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/alpine-latest.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|Alpine Linux (with curl)
|9|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/base-archlinux.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|Archlinux
|10|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/fedora-latest.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|fedora
|11|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/kalilinux-kali-linux-docker.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|Kali Linux
|12|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/oraclelinux-latest.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|Oracle Linux
|13|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/proxmox.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)| Proxmox https://pve.proxmox.com/wiki/HTTPSCertificateConfiguration#Let.27s_Encrypt_using_acme.sh
2016-04-24 05:57:50 +00:00
|14|-----| Cloud Linux https://github.com/Neilpang/le/issues/111
2016-04-25 05:48:03 +00:00
|15|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/openbsd.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|OpenBSD
2016-06-05 11:53:22 +00:00
|16|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/mageia.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|Mageia
|17|-----| OpenWRT: Tested and working. See [wiki page](https://github.com/Neilpang/acme.sh/wiki/How-to-run-on-OpenWRT)
2016-08-11 05:47:38 +00:00
|18|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/solaris.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|SunOS/Solaris
2016-10-30 09:26:00 +00:00
|19|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/gentoo-stage3-amd64.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|Gentoo Linux
2016-12-06 11:03:59 +00:00
|20|[![Build Status](https://travis-ci.org/Neilpang/acme.sh.svg?branch=master)](https://travis-ci.org/Neilpang/acme.sh)|Mac OSX
2015-12-26 13:44:39 +00:00
2016-11-15 13:13:58 +00:00
For all build statuses, check our [daily build project](https://github.com/Neilpang/acmetest):
2015-12-26 13:44:39 +00:00
2016-04-14 13:44:26 +00:00
https://github.com/Neilpang/acmetest
2016-03-11 13:57:05 +00:00
2016-11-15 13:13:58 +00:00
# Supported modes
2016-01-10 02:59:51 +00:00
2016-11-15 13:13:58 +00:00
- Webroot mode
- Standalone mode
- Apache mode
2017-02-13 15:29:37 +00:00
- Nginx mode
2016-11-15 13:13:58 +00:00
- DNS mode
2017-02-06 13:37:21 +00:00
- [Stateless mode](https://github.com/Neilpang/acme.sh/wiki/Stateless-Mode)
2016-04-10 04:54:01 +00:00
2016-08-25 14:13:34 +00:00
# 1. How to install
2015-12-26 13:44:39 +00:00
2016-11-15 13:13:58 +00:00
### 1. Install online
2015-12-26 13:44:39 +00:00
2016-04-24 10:50:09 +00:00
Check this project: https://github.com/Neilpang/get.acme.sh
2016-04-14 14:27:51 +00:00
```bash
curl https://get.acme.sh | sh
2016-03-27 12:43:32 +00:00
```
Or:
```bash
wget -O - https://get.acme.sh | sh
2016-03-27 12:43:32 +00:00
```
2016-11-15 13:13:58 +00:00
### 2. Or, Install from git
2016-11-15 13:13:58 +00:00
Clone this project and launch installation:
```bash
2016-04-14 13:44:26 +00:00
git clone https://github.com/Neilpang/acme.sh.git
cd ./acme.sh
2016-04-14 13:44:26 +00:00
./acme.sh --install
2015-12-26 13:44:39 +00:00
```
2016-03-27 12:43:32 +00:00
You `don't have to be root` then, although `it is recommended`.
2016-11-15 13:13:58 +00:00
Advanced Installation: https://github.com/Neilpang/acme.sh/wiki/How-to-install
2016-04-21 13:43:28 +00:00
The installer will perform 3 actions:
2016-11-15 13:13:58 +00:00
1. Create and copy `acme.sh` to your home dir (`$HOME`): `~/.acme.sh/`.
All certs will be placed in this folder too.
2. Create alias for: `acme.sh=~/.acme.sh/acme.sh`.
3. Create daily cron job to check and renew the certs if needed.
Cron entry example:
```bash
0 0 * * * "/home/user/.acme.sh"/acme.sh --cron --home "/home/user/.acme.sh" > /dev/null
```
2015-12-27 05:52:46 +00:00
2016-11-15 13:13:58 +00:00
After the installation, you must close the current terminal and reopen it to make the alias take effect.
Ok, you are ready to issue certs now.
2015-12-27 05:52:46 +00:00
2015-12-26 13:44:39 +00:00
Show help message:
2015-12-26 13:44:39 +00:00
```
root@v1:~# acme.sh -h
2015-12-26 13:44:39 +00:00
```
2016-11-15 13:13:58 +00:00
# 2. Just issue a cert
2016-03-07 01:52:54 +00:00
**Example 1:** Single domain.
2016-03-07 01:52:54 +00:00
```bash
acme.sh --issue -d example.com -w /home/wwwroot/example.com
2015-12-26 13:44:39 +00:00
```
**Example 2:** Multiple domains in the same cert.
```bash
2016-11-15 13:13:58 +00:00
acme.sh --issue -d example.com -d www.example.com -d cp.example.com -w /home/wwwroot/example.com
2015-12-26 13:44:39 +00:00
```
2016-03-07 01:52:54 +00:00
The parameter `/home/wwwroot/example.com` is the web root folder. You **MUST** have `write access` to this folder.
2015-12-26 13:44:39 +00:00
2016-11-15 13:13:58 +00:00
Second argument **"example.com"** is the main domain you want to issue the cert for.
You must have at least one domain there.
2015-12-26 13:44:39 +00:00
You must point and bind all the domains to the same webroot dir: `/home/wwwroot/example.com`.
2015-12-26 13:44:39 +00:00
2016-11-15 13:13:58 +00:00
Generated/issued certs will be placed in `~/.acme.sh/example.com/`
2015-12-26 13:44:39 +00:00
2016-11-15 13:13:58 +00:00
The issued cert will be renewed automatically every **60** days.
2015-12-26 13:44:39 +00:00
2016-04-14 13:44:26 +00:00
More examples: https://github.com/Neilpang/acme.sh/wiki/How-to-issue-a-cert
2016-11-15 13:13:58 +00:00
# 3. Install the issued cert to Apache/Nginx etc.
2016-11-15 13:13:58 +00:00
After you issue a cert, you probably want to install/copy the cert to your Apache/Nginx or other servers.
You **MUST** use this command to copy the certs to the target files, **DO NOT** use the certs files in **~/.acme.sh/** folder, they are for internal use only, the folder structure may change in the future.
2016-11-15 13:13:58 +00:00
**Apache** example:
```bash
2017-02-11 13:29:36 +00:00
acme.sh --install-cert -d example.com \
2016-11-15 13:13:58 +00:00
--certpath /path/to/certfile/in/apache/cert.pem \
--keypath /path/to/keyfile/in/apache/key.pem \
--fullchainpath /path/to/fullchain/certfile/apache/fullchain.pem \
2016-12-22 12:06:55 +00:00
--reloadcmd "service apache2 force-reload"
2016-11-03 11:19:51 +00:00
```
2016-11-15 13:13:58 +00:00
**Nginx** example:
2016-11-03 11:19:51 +00:00
```bash
2017-02-11 13:29:36 +00:00
acme.sh --install-cert -d example.com \
2016-11-15 13:13:58 +00:00
--keypath /path/to/keyfile/in/nginx/key.pem \
--fullchainpath /path/to/fullchain/nginx/cert.pem \
2016-12-22 12:06:55 +00:00
--reloadcmd "service nginx force-reload"
2015-12-26 13:44:39 +00:00
```
Only the domain is required, all the other parameters are optional.
The ownership and permission info of existing files are preserved. You may want to precreate the files to have defined ownership and permission.
2016-11-15 13:13:58 +00:00
Install/copy the issued cert/key to the production Apache or Nginx path.
The cert will be `renewed every **60** days by default` (which is configurable). Once the cert is renewed, the Apache/Nginx service will be restarted automatically by the command: `service apache2 restart` or `service nginx restart`.
2015-12-26 13:44:39 +00:00
2016-08-25 14:13:34 +00:00
# 4. Use Standalone server to issue cert
2015-12-26 13:44:39 +00:00
2016-11-15 13:13:58 +00:00
**(requires you to be root/sudoer or have permission to listen on port 80 (TCP))**
2016-01-05 13:59:27 +00:00
2016-11-15 13:13:58 +00:00
Port `80` (TCP) **MUST** be free to listen on, otherwise you will be prompted to free it and try again.
```bash
acme.sh --issue --standalone -d example.com -d www.example.com -d cp.example.com
2016-01-05 13:59:27 +00:00
```
2016-04-14 13:44:26 +00:00
More examples: https://github.com/Neilpang/acme.sh/wiki/How-to-issue-a-cert
2016-11-15 13:13:58 +00:00
# 5. Use Standalone TLS server to issue cert
**(requires you to be root/sudoer or have permission to listen on port 443 (TCP))**
acme.sh supports `tls-sni-01` validation.
2016-11-15 13:13:58 +00:00
Port `443` (TCP) **MUST** be free to listen on, otherwise you will be prompted to free it and try again.
```bash
acme.sh --issue --tls -d example.com -d www.example.com -d cp.example.com
```
More examples: https://github.com/Neilpang/acme.sh/wiki/How-to-issue-a-cert
2016-11-15 13:13:58 +00:00
2016-08-25 14:13:34 +00:00
# 6. Use Apache mode
2016-11-15 13:13:58 +00:00
**(requires you to be root/sudoer, since it is required to interact with Apache server)**
2016-11-15 13:13:58 +00:00
If you are running a web server, Apache or Nginx, it is recommended to use the `Webroot mode`.
2016-11-15 13:13:58 +00:00
Particularly, if you are running an Apache server, you should use Apache mode instead. This mode doesn't write any files to your web root folder.
2016-01-10 02:59:51 +00:00
2016-11-15 13:13:58 +00:00
Just set string "apache" as the second argument and it will force use of apache plugin automatically.
2016-01-10 02:59:51 +00:00
```
2016-11-15 13:13:58 +00:00
acme.sh --issue --apache -d example.com -d www.example.com -d cp.example.com
2016-01-10 02:59:51 +00:00
```
2016-04-14 13:44:26 +00:00
More examples: https://github.com/Neilpang/acme.sh/wiki/How-to-issue-a-cert
2016-01-10 02:59:51 +00:00
2017-02-13 15:29:37 +00:00
# 7. Use Nginx mode
2016-11-15 13:13:58 +00:00
2017-02-13 15:29:37 +00:00
**(requires you to be root/sudoer, since it is required to interact with Nginx server)**
If you are running a web server, Apache or Nginx, it is recommended to use the `Webroot mode`.
Particularly, if you are running an nginx server, you can use nginx mode instead. This mode doesn't write any files to your web root folder.
Just set string "nginx" as the second argument.
It will configure nginx server automatically to verify the domain and then restore the nginx config to the original version.
So, the config is not changed.
```
acme.sh --issue --nginx -d example.com -d www.example.com -d cp.example.com
```
More examples: https://github.com/Neilpang/acme.sh/wiki/How-to-issue-a-cert
# 8. Use DNS mode:
2016-01-21 16:16:43 +00:00
Support the `dns-01` challenge.
```bash
2016-11-15 13:13:58 +00:00
acme.sh --issue --dns -d example.com -d www.example.com -d cp.example.com
2016-01-21 16:16:43 +00:00
```
2016-11-15 13:13:58 +00:00
You should get an output like below:
2016-01-21 16:16:43 +00:00
```
Add the following txt record:
Domain:_acme-challenge.example.com
2016-01-21 16:16:43 +00:00
Txt value:9ihDbjYfTExAYeDs4DBUeuTo18KBzwvTEjUnSwd32-c
Add the following txt record:
Domain:_acme-challenge.www.example.com
2016-01-21 16:16:43 +00:00
Txt value:9ihDbjxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Please add those txt records to the domains. Waiting for the dns to take effect.
```
Then just rerun with `renew` argument:
```bash
acme.sh --renew -d example.com
2016-01-21 16:16:43 +00:00
```
Ok, it's finished.
2016-11-15 13:13:58 +00:00
2017-02-13 15:29:37 +00:00
# 9. Automatic DNS API integration
2016-01-21 16:16:43 +00:00
2016-11-15 13:13:58 +00:00
If your DNS provider supports API access, we can use that API to automatically issue the certs.
2015-12-26 13:44:39 +00:00
2016-11-15 13:13:58 +00:00
You don't have to do anything manually!
### Currently acme.sh supports:
2016-02-07 10:37:04 +00:00
2016-11-16 05:10:56 +00:00
1. CloudFlare.com API
1. DNSPod.cn API
1. CloudXNS.com API
1. GoDaddy.com API
1. OVH, kimsufi, soyoustart and runabove API
2016-11-20 15:21:07 +00:00
1. AWS Route 53
2016-11-16 05:10:56 +00:00
1. PowerDNS.com API
1. lexicon DNS API: https://github.com/Neilpang/acme.sh/wiki/How-to-use-lexicon-dns-api
2016-11-15 13:13:58 +00:00
(DigitalOcean, DNSimple, DNSMadeEasy, DNSPark, EasyDNS, Namesilo, NS1, PointHQ, Rage4 and Vultr etc.)
2016-11-16 05:10:56 +00:00
1. LuaDNS.com API
1. DNSMadeEasy.com API
1. nsupdate API
1. aliyun.com(阿里云) API
2016-11-24 15:00:32 +00:00
1. ISPConfig 3.1 API
1. Alwaysdata.com API
2017-01-16 08:42:17 +00:00
1. Linode.com API
2017-02-04 03:59:22 +00:00
1. FreeDNS (https://freedns.afraid.org/)
2016-11-15 13:13:58 +00:00
**More APIs coming soon...**
2016-11-15 13:13:58 +00:00
If your DNS provider is not on the supported list above, you can write your own DNS API script easily. If you do, please consider submitting a [Pull Request](https://github.com/Neilpang/acme.sh/pulls) and contribute it to the project.
2016-11-15 13:13:58 +00:00
For more details: [How to use DNS API](dnsapi)
2017-02-13 15:29:37 +00:00
# 10. Issue ECC certificates
2016-11-15 13:13:58 +00:00
`Let's Encrypt` can now issue **ECDSA** certificates.
2016-11-15 13:13:58 +00:00
And we support them too!
2016-02-12 09:56:50 +00:00
2016-03-02 14:53:07 +00:00
Just set the `length` parameter with a prefix `ec-`.
2016-02-12 09:56:50 +00:00
For example:
2016-03-10 06:17:47 +00:00
2016-11-15 13:13:58 +00:00
### Single domain ECC cerfiticate
2016-03-10 06:17:47 +00:00
```bash
2016-11-15 13:13:58 +00:00
acme.sh --issue -w /home/wwwroot/example.com -d example.com --keylength ec-256
2016-02-12 09:56:50 +00:00
```
2016-11-15 13:13:58 +00:00
### SAN multi domain ECC certificate
```bash
2016-11-15 13:13:58 +00:00
acme.sh --issue -w /home/wwwroot/example.com -d example.com -d www.example.com --keylength ec-256
2016-03-10 06:17:47 +00:00
```
2016-02-12 09:56:50 +00:00
Please look at the last parameter above.
Valid values are:
1. **ec-256 (prime256v1, "ECDSA P-256")**
2. **ec-384 (secp384r1, "ECDSA P-384")**
3. **ec-521 (secp521r1, "ECDSA P-521", which is not supported by Let's Encrypt yet.)**
2016-02-12 09:56:50 +00:00
2016-08-25 14:13:34 +00:00
2017-02-13 15:29:37 +00:00
# 11. How to renew the issued certs
2016-08-25 14:13:34 +00:00
2016-11-15 13:13:58 +00:00
No, you don't need to renew the certs manually. All the certs will be renewed automatically every **60** days.
2016-08-25 14:13:34 +00:00
However, you can also force to renew any cert:
```
2016-11-15 13:13:58 +00:00
acme.sh --renew -d example.com --force
2016-08-25 14:13:34 +00:00
```
or, for ECC cert:
2016-11-15 13:13:58 +00:00
2016-08-25 14:13:34 +00:00
```
2016-11-15 13:13:58 +00:00
acme.sh --renew -d example.com --force --ecc
2016-08-25 14:13:34 +00:00
```
2016-11-15 13:13:58 +00:00
2017-02-13 15:29:37 +00:00
# 12. How to upgrade `acme.sh`
2016-11-15 13:13:58 +00:00
2016-12-14 20:32:24 +00:00
acme.sh is in constant development, so it's strongly recommended to use the latest code.
2016-08-25 14:13:34 +00:00
You can update acme.sh to the latest code:
2016-11-15 13:13:58 +00:00
2016-08-25 14:13:34 +00:00
```
acme.sh --upgrade
```
2016-11-15 13:13:58 +00:00
You can also enable auto upgrade:
2016-09-28 14:11:00 +00:00
```
2016-11-15 13:13:58 +00:00
acme.sh --upgrade --auto-upgrade
2016-09-28 14:11:00 +00:00
```
2016-11-15 13:13:58 +00:00
Then **acme.sh** will be kept up to date automatically.
2016-09-28 14:11:00 +00:00
Disable auto upgrade:
2016-11-15 13:13:58 +00:00
2016-09-28 14:11:00 +00:00
```
2016-11-15 13:13:58 +00:00
acme.sh --upgrade --auto-upgrade 0
2016-09-28 14:11:00 +00:00
```
2016-11-15 13:13:58 +00:00
2017-02-13 15:29:37 +00:00
# 13. Issue a cert from an existing CSR
2016-08-27 06:00:26 +00:00
https://github.com/Neilpang/acme.sh/wiki/Issue-a-cert-from-existing-CSR
# Under the Hood
2015-12-26 13:44:39 +00:00
Speak ACME language using shell, directly to "Let's Encrypt".
2015-12-26 13:44:39 +00:00
TODO:
2016-11-15 13:13:58 +00:00
# Acknowledgments
2016-01-11 05:23:02 +00:00
1. Acme-tiny: https://github.com/diafygi/acme-tiny
2. ACME protocol: https://github.com/ietf-wg-acme/acme
2016-05-14 11:47:03 +00:00
3. Certbot: https://github.com/certbot/certbot
2016-01-11 05:23:02 +00:00
2016-11-15 13:13:58 +00:00
2016-09-27 14:03:42 +00:00
# License & Others
2015-12-26 13:44:39 +00:00
License is GPLv3
2015-12-26 13:47:28 +00:00
Please Star and Fork me.
2015-12-26 13:44:39 +00:00
2016-11-15 13:13:58 +00:00
[Issues](https://github.com/Neilpang/acme.sh/issues) and [pull requests](https://github.com/Neilpang/acme.sh/pulls) are welcome.
2015-12-26 13:44:39 +00:00
2016-07-16 13:57:29 +00:00
# Donate
2015-12-26 13:44:39 +00:00
2016-11-15 13:13:58 +00:00
1. PayPal: donate@acme.sh
2016-08-23 15:16:19 +00:00
2016-11-15 13:13:58 +00:00
[Donate List](https://github.com/Neilpang/acme.sh/wiki/Donate-list)