1 # An ACME Shell script: acme.sh
3 [![FreeBSD](https://github.com/acmesh-official/acme.sh/actions/workflows/FreeBSD.yml/badge.svg)](https://github.com/acmesh-official/acme.sh/actions/workflows/FreeBSD.yml)
4 [![MacOS](https://github.com/acmesh-official/acme.sh/actions/workflows/MacOS.yml/badge.svg)](https://github.com/acmesh-official/acme.sh/actions/workflows/MacOS.yml)
5 [![Ubuntu](https://github.com/acmesh-official/acme.sh/actions/workflows/Ubuntu.yml/badge.svg)](https://github.com/acmesh-official/acme.sh/actions/workflows/Ubuntu.yml)
6 [![Windows](https://github.com/acmesh-official/acme.sh/actions/workflows/Windows.yml/badge.svg)](https://github.com/acmesh-official/acme.sh/actions/workflows/Windows.yml)
7 [![Solaris](https://github.com/acmesh-official/acme.sh/actions/workflows/Solaris.yml/badge.svg)](https://github.com/acmesh-official/acme.sh/actions/workflows/Solaris.yml)
9 ![Shellcheck](https://github.com/acmesh-official/acme.sh/workflows/Shellcheck/badge.svg)
10 ![PebbleStrict](https://github.com/acmesh-official/acme.sh/workflows/PebbleStrict/badge.svg)
11 ![DockerHub](https://github.com/acmesh-official/acme.sh/workflows/Build%20DockerHub/badge.svg)
14 <a href="https://opencollective.com/acmesh" alt="Financial Contributors on Open Collective"><img src="https://opencollective.com/acmesh/all/badge.svg?label=financial+contributors" /></a>
15 [![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)
16 [![Docker stars](https://img.shields.io/docker/stars/neilpang/acme.sh.svg)](https://hub.docker.com/r/neilpang/acme.sh "Click to view the image on Docker Hub")
17 [![Docker pulls](https://img.shields.io/docker/pulls/neilpang/acme.sh.svg)](https://hub.docker.com/r/neilpang/acme.sh "Click to view the image on Docker Hub")
21 - An ACME protocol client written purely in Shell (Unix shell) language.
22 - Full ACME protocol implementation.
24 - Support SAN and wildcard certs
25 - Simple, powerful and very easy to use. You only need 3 minutes to learn it.
26 - Bash, dash and sh compatible.
27 - Purely written in Shell with no dependencies on python.
28 - Just one script to issue, renew and install your certificates automatically.
29 - DOES NOT require `root/sudoer` access.
32 - Cron job notifications for renewal or error etc.
34 It's probably the `easiest & smartest` shell script to automatically issue & renew the free certificates.
36 Wiki: https://github.com/acmesh-official/acme.sh/wiki
38 For Docker Fans: [acme.sh :two_hearts: Docker ](https://github.com/acmesh-official/acme.sh/wiki/Run-acme.sh-in-docker)
40 Twitter: [@neilpangxa](https://twitter.com/neilpangxa)
43 # [中文说明](https://github.com/acmesh-official/acme.sh/wiki/%E8%AF%B4%E6%98%8E)
46 - [FreeBSD.org](https://blog.crashed.org/letsencrypt-in-freebsd-org/)
47 - [ruby-china.org](https://ruby-china.org/topics/31983)
48 - [Proxmox](https://pve.proxmox.com/wiki/Certificate_Management)
49 - [pfsense](https://github.com/pfsense/FreeBSD-ports/pull/89)
50 - [webfaction](https://community.webfaction.com/questions/19988/using-letsencrypt)
51 - [Loadbalancer.org](https://www.loadbalancer.org/blog/loadbalancer-org-with-lets-encrypt-quick-and-dirty)
52 - [discourse.org](https://meta.discourse.org/t/setting-up-lets-encrypt/40709)
53 - [Centminmod](https://centminmod.com/letsencrypt-acmetool-https.html)
54 - [splynx](https://forum.splynx.com/t/free-ssl-cert-for-splynx-lets-encrypt/297)
55 - [archlinux](https://www.archlinux.org/packages/community/any/acme.sh)
56 - [opnsense.org](https://github.com/opnsense/plugins/tree/master/security/acme-client/src/opnsense/scripts/OPNsense/AcmeClient)
57 - [CentOS Web Panel](http://centos-webpanel.com/)
58 - [lnmp.org](https://lnmp.org/)
59 - [more...](https://github.com/acmesh-official/acme.sh/wiki/Blogs-and-tutorials)
63 | NO | Status| Platform|
64 |----|-------|---------|
65 |1|[![MacOS](https://github.com/acmesh-official/acme.sh/actions/workflows/MacOS.yml/badge.svg)](https://github.com/acmesh-official/acme.sh/actions/workflows/MacOS.yml)|Mac OSX
66 |2|[![Windows](https://github.com/acmesh-official/acme.sh/actions/workflows/Windows.yml/badge.svg)](https://github.com/acmesh-official/acme.sh/actions/workflows/Windows.yml)|Windows (cygwin with curl, openssl and crontab included)
67 |3|[![FreeBSD](https://github.com/acmesh-official/acme.sh/actions/workflows/FreeBSD.yml/badge.svg)](https://github.com/acmesh-official/acme.sh/actions/workflows/FreeBSD.yml)|FreeBSD
68 |4|[![Solaris](https://github.com/acmesh-official/acme.sh/actions/workflows/Solaris.yml/badge.svg)](https://github.com/acmesh-official/acme.sh/actions/workflows/Solaris.yml)|Solaris
69 |5|[![Ubuntu](https://github.com/acmesh-official/acme.sh/actions/workflows/Ubuntu.yml/badge.svg)](https://github.com/acmesh-official/acme.sh/actions/workflows/Ubuntu.yml)| Ubuntu
72 |8|[![Linux](https://github.com/acmesh-official/acme.sh/actions/workflows/Linux.yml/badge.svg)](https://github.com/acmesh-official/acme.sh/actions/workflows/Linux.yml)| Debian
73 |9|[![Linux](https://github.com/acmesh-official/acme.sh/actions/workflows/Linux.yml/badge.svg)](https://github.com/acmesh-official/acme.sh/actions/workflows/Linux.yml)|CentOS
74 |10|[![Linux](https://github.com/acmesh-official/acme.sh/actions/workflows/Linux.yml/badge.svg)](https://github.com/acmesh-official/acme.sh/actions/workflows/Linux.yml)|openSUSE
75 |11|[![Linux](https://github.com/acmesh-official/acme.sh/actions/workflows/Linux.yml/badge.svg)](https://github.com/acmesh-official/acme.sh/actions/workflows/Linux.yml)|Alpine Linux (with curl)
76 |12|[![Linux](https://github.com/acmesh-official/acme.sh/actions/workflows/Linux.yml/badge.svg)](https://github.com/acmesh-official/acme.sh/actions/workflows/Linux.yml)|Archlinux
77 |13|[![Linux](https://github.com/acmesh-official/acme.sh/actions/workflows/Linux.yml/badge.svg)](https://github.com/acmesh-official/acme.sh/actions/workflows/Linux.yml)|fedora
78 |14|[![Linux](https://github.com/acmesh-official/acme.sh/actions/workflows/Linux.yml/badge.svg)](https://github.com/acmesh-official/acme.sh/actions/workflows/Linux.yml)|Kali Linux
79 |15|[![Linux](https://github.com/acmesh-official/acme.sh/actions/workflows/Linux.yml/badge.svg)](https://github.com/acmesh-official/acme.sh/actions/workflows/Linux.yml)|Oracle Linux
80 |16|[![Linux](https://github.com/acmesh-official/acme.sh/actions/workflows/Linux.yml/badge.svg)](https://github.com/acmesh-official/acme.sh/actions/workflows/Linux.yml)|Mageia
81 |17|[![Linux](https://github.com/acmesh-official/acme.sh/actions/workflows/Linux.yml/badge.svg)](https://github.com/acmesh-official/acme.sh/actions/workflows/Linux.yml)|Gentoo Linux
82 |18|[![Linux](https://github.com/acmesh-official/acme.sh/actions/workflows/Linux.yml/badge.svg)](https://github.com/acmesh-official/acme.sh/actions/workflows/Linux.yml)|ClearLinux
83 |19|-----| Cloud Linux https://github.com/acmesh-official/acme.sh/issues/111
84 |20|-----| OpenWRT: Tested and working. See [wiki page](https://github.com/acmesh-official/acme.sh/wiki/How-to-run-on-OpenWRT)
85 |21|[![](https://acmesh-official.github.io/acmetest/status/proxmox.svg)](https://github.com/acmesh-official/letest#here-are-the-latest-status)| Proxmox: See Proxmox VE Wiki. Version [4.x, 5.0, 5.1](https://pve.proxmox.com/wiki/HTTPS_Certificate_Configuration_(Version_4.x,_5.0_and_5.1)#Let.27s_Encrypt_using_acme.sh), version [5.2 and up](https://pve.proxmox.com/wiki/Certificate_Management)
88 Check our [testing project](https://github.com/acmesh-official/acmetest):
90 https://github.com/acmesh-official/acmetest
94 - [ZeroSSL.com CA](https://github.com/acmesh-official/acme.sh/wiki/ZeroSSL.com-CA)(default)
96 - [BuyPass.com CA](https://github.com/acmesh-official/acme.sh/wiki/BuyPass.com-CA)
97 - [SSL.com CA](https://github.com/acmesh-official/acme.sh/wiki/SSL.com-CA)
98 - [Google.com Public CA](https://github.com/acmesh-official/acme.sh/wiki/Google-Public-CA)
99 - [Pebble strict Mode](https://github.com/letsencrypt/pebble)
100 - Any other [RFC8555](https://tools.ietf.org/html/rfc8555)-compliant CA
106 - Standalone tls-alpn mode
110 - [DNS alias mode](https://github.com/acmesh-official/acme.sh/wiki/DNS-alias-mode)
111 - [Stateless mode](https://github.com/acmesh-official/acme.sh/wiki/Stateless-Mode)
116 ### 1. Install online
118 Check this project: https://github.com/acmesh-official/get.acme.sh
121 curl https://get.acme.sh | sh -s email=my@example.com
127 wget -O - https://get.acme.sh | sh -s email=my@example.com
131 ### 2. Or, Install from git
133 Clone this project and launch installation:
136 git clone https://github.com/acmesh-official/acme.sh.git
138 ./acme.sh --install -m my@example.com
141 You `don't have to be root` then, although `it is recommended`.
143 Advanced Installation: https://github.com/acmesh-official/acme.sh/wiki/How-to-install
145 The installer will perform 3 actions:
147 1. Create and copy `acme.sh` to your home dir (`$HOME`): `~/.acme.sh/`.
148 All certs will be placed in this folder too.
149 2. Create alias for: `acme.sh=~/.acme.sh/acme.sh`.
150 3. Create daily cron job to check and renew the certs if needed.
155 0 0 * * * "/home/user/.acme.sh"/acme.sh --cron --home "/home/user/.acme.sh" > /dev/null
158 After the installation, you must close the current terminal and reopen it to make the alias take effect.
160 Ok, you are ready to issue certs now.
165 root@v1:~# acme.sh -h
168 # 2. Just issue a cert
170 **Example 1:** Single domain.
173 acme.sh --issue -d example.com -w /home/wwwroot/example.com
179 acme.sh --issue -d example.com -w /home/username/public_html
185 acme.sh --issue -d example.com -w /var/www/html
188 **Example 2:** Multiple domains in the same cert.
191 acme.sh --issue -d example.com -d www.example.com -d cp.example.com -w /home/wwwroot/example.com
194 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.
196 Second argument **"example.com"** is the main domain you want to issue the cert for.
197 You must have at least one domain there.
199 You must point and bind all the domains to the same webroot dir: `/home/wwwroot/example.com`.
201 The certs will be placed in `~/.acme.sh/example.com/`
203 The certs will be renewed automatically every **60** days.
205 More examples: https://github.com/acmesh-official/acme.sh/wiki/How-to-issue-a-cert
208 # 3. Install the cert to Apache/Nginx etc.
210 After the cert is generated, you probably want to install/copy the cert to your Apache/Nginx or other servers.
211 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.
215 acme.sh --install-cert -d example.com \
216 --cert-file /path/to/certfile/in/apache/cert.pem \
217 --key-file /path/to/keyfile/in/apache/key.pem \
218 --fullchain-file /path/to/fullchain/certfile/apache/fullchain.pem \
219 --reloadcmd "service apache2 force-reload"
224 acme.sh --install-cert -d example.com \
225 --key-file /path/to/keyfile/in/nginx/key.pem \
226 --fullchain-file /path/to/fullchain/nginx/cert.pem \
227 --reloadcmd "service nginx force-reload"
230 Only the domain is required, all the other parameters are optional.
232 The ownership and permission info of existing files are preserved. You can pre-create the files to define the ownership and permission.
234 Install/copy the cert/key to the production Apache or Nginx path.
236 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`.
239 **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.**
241 # 4. Use Standalone server to issue cert
243 **(requires you to be root/sudoer or have permission to listen on port 80 (TCP))**
245 Port `80` (TCP) **MUST** be free to listen on, otherwise you will be prompted to free it and try again.
248 acme.sh --issue --standalone -d example.com -d www.example.com -d cp.example.com
251 More examples: https://github.com/acmesh-official/acme.sh/wiki/How-to-issue-a-cert
253 # 5. Use Standalone ssl server to issue cert
255 **(requires you to be root/sudoer or have permission to listen on port 443 (TCP))**
257 Port `443` (TCP) **MUST** be free to listen on, otherwise you will be prompted to free it and try again.
260 acme.sh --issue --alpn -d example.com -d www.example.com -d cp.example.com
263 More examples: https://github.com/acmesh-official/acme.sh/wiki/How-to-issue-a-cert
268 **(requires you to be root/sudoer, since it is required to interact with Apache server)**
270 If you are running a web server, it is recommended to use the `Webroot mode`.
272 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.
274 Just set string "apache" as the second argument and it will force use of apache plugin automatically.
277 acme.sh --issue --apache -d example.com -d www.example.com -d cp.example.com
280 **This apache mode is only to issue the cert, it will not change your apache 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 with your apache server, don't worry.**
284 More examples: https://github.com/acmesh-official/acme.sh/wiki/How-to-issue-a-cert
288 **(requires you to be root/sudoer, since it is required to interact with Nginx server)**
290 If you are running a web server, it is recommended to use the `Webroot mode`.
292 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.
294 Just set string "nginx" as the second argument.
296 It will configure nginx server automatically to verify the domain and then restore the nginx config to the original version.
298 So, the config is not changed.
301 acme.sh --issue --nginx -d example.com -d www.example.com -d cp.example.com
304 **This nginx mode is only to issue the cert, it will not change your nginx config files.
305 You will need to configure your website config files to use the cert by yourself.
306 We don't want to mess with your nginx server, don't worry.**
308 More examples: https://github.com/acmesh-official/acme.sh/wiki/How-to-issue-a-cert
310 # 8. Automatic DNS API integration
312 If your DNS provider supports API access, we can use that API to automatically issue the certs.
314 You don't have to do anything manually!
316 ### Currently acme.sh supports most of the dns providers:
318 https://github.com/acmesh-official/acme.sh/wiki/dnsapi
320 # 9. Use DNS manual mode:
322 See: https://github.com/acmesh-official/acme.sh/wiki/dns-manual-mode first.
324 If your dns provider doesn't support any api access, you can add the txt record by hand.
327 acme.sh --issue --dns -d example.com -d www.example.com -d cp.example.com
330 You should get an output like below:
333 Add the following txt record:
334 Domain:_acme-challenge.example.com
335 Txt value:9ihDbjYfTExAYeDs4DBUeuTo18KBzwvTEjUnSwd32-c
337 Add the following txt record:
338 Domain:_acme-challenge.www.example.com
339 Txt value:9ihDbjxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
341 Please add those txt records to the domains. Waiting for the dns to take effect.
344 Then just rerun with `renew` argument:
347 acme.sh --renew -d example.com
352 **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.**
354 **Please use dns api mode instead.**
356 # 10. Issue ECC certificates
358 `Let's Encrypt` can now issue **ECDSA** certificates.
360 And we support them too!
362 Just set the `keylength` parameter with a prefix `ec-`.
366 ### Single domain ECC certificate
369 acme.sh --issue -w /home/wwwroot/example.com -d example.com --keylength ec-256
372 ### SAN multi domain ECC certificate
375 acme.sh --issue -w /home/wwwroot/example.com -d example.com -d www.example.com --keylength ec-256
378 Please look at the `keylength` parameter above.
382 1. **ec-256 (prime256v1, "ECDSA P-256")**
383 2. **ec-384 (secp384r1, "ECDSA P-384")**
384 3. **ec-521 (secp521r1, "ECDSA P-521", which is not supported by Let's Encrypt yet.)**
388 # 11. Issue Wildcard certificates
390 It's simple, just give a wildcard domain as the `-d` parameter.
393 acme.sh --issue -d example.com -d '*.example.com' --dns dns_cf
398 # 12. How to renew the certs
400 No, you don't need to renew the certs manually. All the certs will be renewed automatically every **60** days.
402 However, you can also force to renew a cert:
405 acme.sh --renew -d example.com --force
411 acme.sh --renew -d example.com --force --ecc
415 # 13. How to stop cert renewal
417 To stop renewal of a cert, you can execute the following to remove the cert from the renewal list:
420 acme.sh --remove -d example.com [--ecc]
423 The cert/key file is not removed from the disk.
425 You can remove the respective directory (e.g. `~/.acme.sh/example.com`) by yourself.
428 # 14. How to upgrade `acme.sh`
430 acme.sh is in constant development, so it's strongly recommended to use the latest code.
432 You can update acme.sh to the latest code:
438 You can also enable auto upgrade:
441 acme.sh --upgrade --auto-upgrade
444 Then **acme.sh** will be kept up to date automatically.
446 Disable auto upgrade:
449 acme.sh --upgrade --auto-upgrade 0
453 # 15. Issue a cert from an existing CSR
455 https://github.com/acmesh-official/acme.sh/wiki/Issue-a-cert-from-existing-CSR
458 # 16. Send notifications in cronjob
460 https://github.com/acmesh-official/acme.sh/wiki/notify
465 Speak ACME language using shell, directly to "Let's Encrypt".
470 # 18. Acknowledgments
472 1. Acme-tiny: https://github.com/diafygi/acme-tiny
473 2. ACME protocol: https://github.com/ietf-wg-acme/acme
478 ### Code Contributors
480 This project exists thanks to all the people who contribute.
481 <a href="https://github.com/acmesh-official/acme.sh/graphs/contributors"><img src="https://opencollective.com/acmesh/contributors.svg?width=890&button=false" /></a>
483 ### Financial Contributors
485 Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/acmesh/contribute)]
489 <a href="https://opencollective.com/acmesh"><img src="https://opencollective.com/acmesh/individuals.svg?width=890"></a>
493 Support this project with your organization. Your logo will show up here with a link to your website. [[Contribute](https://opencollective.com/acmesh/contribute)]
495 <a href="https://opencollective.com/acmesh/organization/0/website"><img src="https://opencollective.com/acmesh/organization/0/avatar.svg"></a>
496 <a href="https://opencollective.com/acmesh/organization/1/website"><img src="https://opencollective.com/acmesh/organization/1/avatar.svg"></a>
497 <a href="https://opencollective.com/acmesh/organization/2/website"><img src="https://opencollective.com/acmesh/organization/2/avatar.svg"></a>
498 <a href="https://opencollective.com/acmesh/organization/3/website"><img src="https://opencollective.com/acmesh/organization/3/avatar.svg"></a>
499 <a href="https://opencollective.com/acmesh/organization/4/website"><img src="https://opencollective.com/acmesh/organization/4/avatar.svg"></a>
500 <a href="https://opencollective.com/acmesh/organization/5/website"><img src="https://opencollective.com/acmesh/organization/5/avatar.svg"></a>
501 <a href="https://opencollective.com/acmesh/organization/6/website"><img src="https://opencollective.com/acmesh/organization/6/avatar.svg"></a>
502 <a href="https://opencollective.com/acmesh/organization/7/website"><img src="https://opencollective.com/acmesh/organization/7/avatar.svg"></a>
503 <a href="https://opencollective.com/acmesh/organization/8/website"><img src="https://opencollective.com/acmesh/organization/8/avatar.svg"></a>
504 <a href="https://opencollective.com/acmesh/organization/9/website"><img src="https://opencollective.com/acmesh/organization/9/avatar.svg"></a>
506 # 19. License & Others
510 Please Star and Fork me.
512 [Issues](https://github.com/acmesh-official/acme.sh/issues) and [pull requests](https://github.com/acmesh-official/acme.sh/pulls) are welcome.
516 Your donation makes **acme.sh** better:
518 1. PayPal/Alipay(支付宝)/Wechat(微信): [https://donate.acme.sh/](https://donate.acme.sh/)
520 [Donate List](https://github.com/acmesh-official/acme.sh/wiki/Donate-list)