1 # 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)
3 [![Join the chat at https://gitter.im/acme-sh/Lobby](https://badges.gitter.im/acme-sh/Lobby.svg)](https://gitter.im/acme-sh/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
4 - An ACME protocol client written purely in Shell (Unix shell) language.
5 - Full ACME protocol implementation.
6 - Support ACME v1 and ACME v2
7 - Support ACME v2 wildcard certs
8 - Simple, powerful and very easy to use. You only need 3 minutes to learn it.
9 - Bash, dash and sh compatible.
10 - Simplest shell script for Let's Encrypt free certificate client.
11 - Purely written in Shell with no dependencies on python or the official Let's Encrypt client.
12 - Just one script to issue, renew and install your certificates automatically.
13 - DOES NOT require `root/sudoer` access.
17 It's probably the `easiest & smartest` shell script to automatically issue & renew the free certificates from Let's Encrypt.
19 Wiki: https://github.com/Neilpang/acme.sh/wiki
21 For Docker Fans: [acme.sh :two_hearts: Docker ](https://github.com/Neilpang/acme.sh/wiki/Run-acme.sh-in-docker)
23 Twitter: [@neilpangxa](https://twitter.com/neilpangxa)
26 # [中文说明](https://github.com/Neilpang/acme.sh/wiki/%E8%AF%B4%E6%98%8E)
29 - [FreeBSD.org](https://blog.crashed.org/letsencrypt-in-freebsd-org/)
30 - [ruby-china.org](https://ruby-china.org/topics/31983)
31 - [Proxmox](https://pve.proxmox.com/wiki/HTTPS_Certificate_Configuration_(Version_4.x_and_newer))
32 - [pfsense](https://github.com/pfsense/FreeBSD-ports/pull/89)
33 - [webfaction](https://community.webfaction.com/questions/19988/using-letsencrypt)
34 - [Loadbalancer.org](https://www.loadbalancer.org/blog/loadbalancer-org-with-lets-encrypt-quick-and-dirty)
35 - [discourse.org](https://meta.discourse.org/t/setting-up-lets-encrypt/40709)
36 - [Centminmod](https://centminmod.com/letsencrypt-acmetool-https.html)
37 - [splynx](https://forum.splynx.com/t/free-ssl-cert-for-splynx-lets-encrypt/297)
38 - [archlinux](https://www.archlinux.org/packages/community/any/acme.sh)
39 - [opnsense.org](https://github.com/opnsense/plugins/tree/master/security/acme-client/src/opnsense/scripts/OPNsense/AcmeClient)
40 - [CentOS Web Panel](http://centos-webpanel.com/)
41 - [lnmp.org](https://lnmp.org/)
42 - [more...](https://github.com/Neilpang/acme.sh/wiki/Blogs-and-tutorials)
46 | NO | Status| Platform|
47 |----|-------|---------|
48 |1|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/ubuntu-latest.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)| Ubuntu
49 |2|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/debian-latest.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)| Debian
50 |3|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/centos-latest.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|CentOS
51 |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)
52 |5|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/freebsd.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|FreeBSD
53 |6|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/pfsense.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|pfsense
54 |7|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/opensuse-latest.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|openSUSE
55 |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)
56 |9|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/base-archlinux.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|Archlinux
57 |10|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/fedora-latest.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|fedora
58 |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
59 |12|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/oraclelinux-latest.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|Oracle Linux
60 |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
61 |14|-----| Cloud Linux https://github.com/Neilpang/le/issues/111
62 |15|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/openbsd.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|OpenBSD
63 |16|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/mageia.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|Mageia
64 |17|-----| OpenWRT: Tested and working. See [wiki page](https://github.com/Neilpang/acme.sh/wiki/How-to-run-on-OpenWRT)
65 |18|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/solaris.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|SunOS/Solaris
66 |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
67 |20|[![Build Status](https://travis-ci.org/Neilpang/acme.sh.svg?branch=master)](https://travis-ci.org/Neilpang/acme.sh)|Mac OSX
69 For all build statuses, check our [weekly build project](https://github.com/Neilpang/acmetest):
71 https://github.com/Neilpang/acmetest
75 - Letsencrypt.org CA(default)
76 - [BuyPass.com CA](https://github.com/Neilpang/acme.sh/wiki/BuyPass.com-CA)
82 - Standalone tls-alpn mode
86 - [DNS alias mode](https://github.com/Neilpang/acme.sh/wiki/DNS-alias-mode)
87 - [Stateless mode](https://github.com/Neilpang/acme.sh/wiki/Stateless-Mode)
94 Check this project: https://github.com/Neilpang/get.acme.sh
97 curl https://get.acme.sh | sh
103 wget -O - https://get.acme.sh | sh
107 ### 2. Or, Install from git
109 Clone this project and launch installation:
112 git clone https://github.com/Neilpang/acme.sh.git
117 You `don't have to be root` then, although `it is recommended`.
119 Advanced Installation: https://github.com/Neilpang/acme.sh/wiki/How-to-install
121 The installer will perform 3 actions:
123 1. Create and copy `acme.sh` to your home dir (`$HOME`): `~/.acme.sh/`.
124 All certs will be placed in this folder too.
125 2. Create alias for: `acme.sh=~/.acme.sh/acme.sh`.
126 3. Create daily cron job to check and renew the certs if needed.
131 0 0 * * * "/home/user/.acme.sh"/acme.sh --cron --home "/home/user/.acme.sh" > /dev/null
134 After the installation, you must close the current terminal and reopen it to make the alias take effect.
136 Ok, you are ready to issue certs now.
141 root@v1:~# acme.sh -h
144 # 2. Just issue a cert
146 **Example 1:** Single domain.
149 acme.sh --issue -d example.com -w /home/wwwroot/example.com
155 acme.sh --issue -d example.com -w /home/username/public_html
161 acme.sh --issue -d example.com -w /var/www/html
164 **Example 2:** Multiple domains in the same cert.
167 acme.sh --issue -d example.com -d www.example.com -d cp.example.com -w /home/wwwroot/example.com
170 The parameter `/home/wwwroot/example.com` or `/home/username/public_html` or `/var/www/html` is the web root folder where you host your website files. You **MUST** have `write access` to this folder.
172 Second argument **"example.com"** is the main domain you want to issue the cert for.
173 You must have at least one domain there.
175 You must point and bind all the domains to the same webroot dir: `/home/wwwroot/example.com`.
177 The certs will be placed in `~/.acme.sh/example.com/`
179 The certs will be renewed automatically every **60** days.
181 More examples: https://github.com/Neilpang/acme.sh/wiki/How-to-issue-a-cert
184 # 3. Install the cert to Apache/Nginx etc.
186 After the cert is generated, you probably want to install/copy the cert to your Apache/Nginx or other servers.
187 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.
191 acme.sh --install-cert -d example.com \
192 --cert-file /path/to/certfile/in/apache/cert.pem \
193 --key-file /path/to/keyfile/in/apache/key.pem \
194 --fullchain-file /path/to/fullchain/certfile/apache/fullchain.pem \
195 --reloadcmd "service apache2 force-reload"
200 acme.sh --install-cert -d example.com \
201 --key-file /path/to/keyfile/in/nginx/key.pem \
202 --fullchain-file /path/to/fullchain/nginx/cert.pem \
203 --reloadcmd "service nginx force-reload"
206 Only the domain is required, all the other parameters are optional.
208 The ownership and permission info of existing files are preserved. You can pre-create the files to define the ownership and permission.
210 Install/copy the cert/key to the production Apache or Nginx path.
212 The cert will be renewed every **60** days by default (which is configurable). Once the cert is renewed, the Apache/Nginx service will be reloaded automatically by the command: `service apache2 force-reload` or `service nginx force-reload`.
215 **Please take care: The reloadcmd is very important. The cert can be automatically renewed, but, without a correct 'reloadcmd' the cert may not be flushed to your server(like nginx or apache), then your website will not be able to show renewed cert in 60 days.**
217 # 4. Use Standalone server to issue cert
219 **(requires you to be root/sudoer or have permission to listen on port 80 (TCP))**
221 Port `80` (TCP) **MUST** be free to listen on, otherwise you will be prompted to free it and try again.
224 acme.sh --issue --standalone -d example.com -d www.example.com -d cp.example.com
227 More examples: https://github.com/Neilpang/acme.sh/wiki/How-to-issue-a-cert
229 # 5. Use Standalone ssl server to issue cert
231 **(requires you to be root/sudoer or have permission to listen on port 443 (TCP))**
233 Port `443` (TCP) **MUST** be free to listen on, otherwise you will be prompted to free it and try again.
236 acme.sh --issue --alpn -d example.com -d www.example.com -d cp.example.com
239 More examples: https://github.com/Neilpang/acme.sh/wiki/How-to-issue-a-cert
244 **(requires you to be root/sudoer, since it is required to interact with Apache server)**
246 If you are running a web server, Apache or Nginx, it is recommended to use the `Webroot mode`.
248 Particularly, if you are running an Apache server, you can use Apache mode instead. This mode doesn't write any files to your web root folder.
250 Just set string "apache" as the second argument and it will force use of apache plugin automatically.
253 acme.sh --issue --apache -d example.com -d www.example.com -d cp.example.com
256 **This apache mode is only to issue the cert, it will not change your apache config files.
257 You will need to configure your website config files to use the cert by yourself.
258 We don't want to mess your apache server, don't worry.**
260 More examples: https://github.com/Neilpang/acme.sh/wiki/How-to-issue-a-cert
264 **(requires you to be root/sudoer, since it is required to interact with Nginx server)**
266 If you are running a web server, Apache or Nginx, it is recommended to use the `Webroot mode`.
268 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.
270 Just set string "nginx" as the second argument.
272 It will configure nginx server automatically to verify the domain and then restore the nginx config to the original version.
274 So, the config is not changed.
277 acme.sh --issue --nginx -d example.com -d www.example.com -d cp.example.com
280 **This nginx mode is only to issue the cert, it will not change your nginx config files.
281 You will need to configure your website config files to use the cert by yourself.
282 We don't want to mess your nginx server, don't worry.**
284 More examples: https://github.com/Neilpang/acme.sh/wiki/How-to-issue-a-cert
286 # 8. Automatic DNS API integration
288 If your DNS provider supports API access, we can use that API to automatically issue the certs.
290 You don't have to do anything manually!
292 ### Currently acme.sh supports:
294 1. CloudFlare.com API
299 1. OVH, kimsufi, soyoustart and runabove API
302 1. DNSMadeEasy.com API
304 1. aliyun.com(阿里云) API
306 1. Alwaysdata.com API
308 1. FreeDNS (https://freedns.afraid.org/)
310 1. Domain-Offensive/Resellerinterface/Domainrobot API
313 1. DigitalOcean API (native)
315 1. Infoblox NIOS API (https://www.infoblox.com/)
316 1. VSCALE (https://vscale.io/)
317 1. Dynu API (https://www.dynu.com)
322 1. Dyn Managed DNS API
323 1. Yandex PDD API (https://pdd.yandex.ru)
324 1. Hurricane Electric DNS service (https://dns.he.net)
325 1. UnoEuro API (https://www.unoeuro.com/)
326 1. INWX (https://www.inwx.de/)
327 1. Servercow (https://servercow.de)
328 1. Namesilo (https://www.namesilo.com)
329 1. InternetX autoDNS API (https://internetx.com)
331 1. selectel.com(selectel.ru) DNS API
332 1. zonomi.com DNS API
335 1. KingHost (https://www.kinghost.com.br/)
336 1. Zilore (https://zilore.com)
338 1. acme-dns (https://github.com/joohoi/acme-dns)
339 1. TELE3 (https://www.tele3.cz)
340 1. EUSERV.EU (https://www.euserv.eu)
341 1. DNSPod.com API (https://www.dnspod.com)
342 1. Google Cloud DNS API
343 1. ConoHa (https://www.conoha.jp)
344 1. netcup DNS API (https://www.netcup.de)
345 1. GratisDNS.dk (https://gratisdns.dk)
346 1. Namecheap API (https://www.namecheap.com/)
347 1. MyDNS.JP API (https://www.mydns.jp/)
348 1. hosting.de (https://www.hosting.de)
349 1. Neodigit.net API (https://www.neodigit.net)
350 1. Exoscale.com API (https://www.exoscale.com/)
351 1. PointDNS API (https://pointhq.com/)
352 1. Active24.cz API (https://www.active24.cz/)
353 1. do.de API (https://www.do.de/)
354 1. Nexcess API (https://www.nexcess.net)
355 1. Thermo.io API (https://www.thermo.io)
356 1. Futurehosting API (https://www.futurehosting.com)
357 1. Rackspace Cloud DNS (https://www.rackspace.com)
358 1. Online.net API (https://online.net/)
359 1. MyDevil.net (https://www.mydevil.net/)
363 **lexicon DNS API: https://github.com/Neilpang/acme.sh/wiki/How-to-use-lexicon-dns-api
364 (DigitalOcean, DNSimple, DNSMadeEasy, DNSPark, EasyDNS, Namesilo, NS1, PointHQ, Rage4 and Vultr etc.)**
367 **More APIs coming soon...**
369 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.
371 For more details: [How to use DNS API](dnsapi)
373 # 9. Use DNS manual mode:
375 See: https://github.com/Neilpang/acme.sh/wiki/dns-manual-mode first.
377 If your dns provider doesn't support any api access, you can add the txt record by your hand.
380 acme.sh --issue --dns -d example.com -d www.example.com -d cp.example.com
383 You should get an output like below:
386 Add the following txt record:
387 Domain:_acme-challenge.example.com
388 Txt value:9ihDbjYfTExAYeDs4DBUeuTo18KBzwvTEjUnSwd32-c
390 Add the following txt record:
391 Domain:_acme-challenge.www.example.com
392 Txt value:9ihDbjxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
394 Please add those txt records to the domains. Waiting for the dns to take effect.
397 Then just rerun with `renew` argument:
400 acme.sh --renew -d example.com
405 **Take care, this is dns manual mode, it can not be renewed automatically. you will have to add a new txt record to your domain by your hand when you renew your cert.**
407 **Please use dns api mode instead.**
409 # 10. Issue ECC certificates
411 `Let's Encrypt` can now issue **ECDSA** certificates.
413 And we support them too!
415 Just set the `keylength` parameter with a prefix `ec-`.
419 ### Single domain ECC certificate
422 acme.sh --issue -w /home/wwwroot/example.com -d example.com --keylength ec-256
425 ### SAN multi domain ECC certificate
428 acme.sh --issue -w /home/wwwroot/example.com -d example.com -d www.example.com --keylength ec-256
431 Please look at the `keylength` parameter above.
435 1. **ec-256 (prime256v1, "ECDSA P-256")**
436 2. **ec-384 (secp384r1, "ECDSA P-384")**
437 3. **ec-521 (secp521r1, "ECDSA P-521", which is not supported by Let's Encrypt yet.)**
441 # 11. Issue Wildcard certificates
443 It's simple, just give a wildcard domain as the `-d` parameter.
446 acme.sh --issue -d example.com -d '*.example.com' --dns dns_cf
451 # 12. How to renew the certs
453 No, you don't need to renew the certs manually. All the certs will be renewed automatically every **60** days.
455 However, you can also force to renew a cert:
458 acme.sh --renew -d example.com --force
464 acme.sh --renew -d example.com --force --ecc
468 # 13. How to stop cert renewal
470 To stop renewal of a cert, you can execute the following to remove the cert from the renewal list:
473 acme.sh --remove -d example.com [--ecc]
476 The cert/key file is not removed from the disk.
478 You can remove the respective directory (e.g. `~/.acme.sh/example.com`) by yourself.
481 # 14. How to upgrade `acme.sh`
483 acme.sh is in constant development, so it's strongly recommended to use the latest code.
485 You can update acme.sh to the latest code:
491 You can also enable auto upgrade:
494 acme.sh --upgrade --auto-upgrade
497 Then **acme.sh** will be kept up to date automatically.
499 Disable auto upgrade:
502 acme.sh --upgrade --auto-upgrade 0
506 # 15. Issue a cert from an existing CSR
508 https://github.com/Neilpang/acme.sh/wiki/Issue-a-cert-from-existing-CSR
513 Speak ACME language using shell, directly to "Let's Encrypt".
518 # 17. Acknowledgments
520 1. Acme-tiny: https://github.com/diafygi/acme-tiny
521 2. ACME protocol: https://github.com/ietf-wg-acme/acme
524 # 18. License & Others
528 Please Star and Fork me.
530 [Issues](https://github.com/Neilpang/acme.sh/issues) and [pull requests](https://github.com/Neilpang/acme.sh/pulls) are welcome.
534 Your donation makes **acme.sh** better:
536 1. PayPal/Alipay(支付宝)/Wechat(微信): [https://donate.acme.sh/](https://donate.acme.sh/)
538 [Donate List](https://github.com/Neilpang/acme.sh/wiki/Donate-list)