You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

498 lines
18 KiB

8 years ago
8 years ago
9 years ago
8 years ago
9 years ago
9 years ago
9 years ago
8 years ago
8 years ago
8 years ago
8 years ago
7 years ago
8 years ago
9 years ago
6 years ago
9 years ago
6 years ago
6 years ago
8 years ago
9 years ago
8 years ago
9 years ago
9 years ago
7 years ago
8 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
7 years ago
9 years ago
9 years ago
9 years ago
9 years ago
8 years ago
9 years ago
9 years ago
8 years ago
9 years ago
9 years ago
9 years ago
7 years ago
9 years ago
7 years ago
9 years ago
7 years ago
7 years ago
8 years ago
8 years ago
8 years ago
8 years ago
9 years ago
7 years ago
7 years ago
8 years ago
9 years ago
7 years ago
8 years ago
9 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
9 years ago
6 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
8 years ago
8 years ago
7 years ago
8 years ago
7 years ago
7 years ago
8 years ago
7 years ago
7 years ago
8 years ago
7 years ago
8 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
8 years ago
8 years ago
7 years ago
8 years ago
7 years ago
7 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
8 years ago
9 years ago
8 years ago
  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)
  2. <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> [![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)
  3. - An ACME protocol client written purely in Shell (Unix shell) language.
  4. - Full ACME protocol implementation.
  5. - Support ACME v1 and ACME v2
  6. - Support ACME v2 wildcard certs
  7. - Simple, powerful and very easy to use. You only need 3 minutes to learn it.
  8. - Bash, dash and sh compatible.
  9. - Simplest shell script for Let's Encrypt free certificate client.
  10. - Purely written in Shell with no dependencies on python or the official Let's Encrypt client.
  11. - Just one script to issue, renew and install your certificates automatically.
  12. - DOES NOT require `root/sudoer` access.
  13. - Docker friendly
  14. - IPv6 support
  15. - Cron job notifications for renewal or error etc.
  16. It's probably the `easiest & smartest` shell script to automatically issue & renew the free certificates from Let's Encrypt.
  17. Wiki: https://github.com/Neilpang/acme.sh/wiki
  18. For Docker Fans: [acme.sh :two_hearts: Docker ](https://github.com/Neilpang/acme.sh/wiki/Run-acme.sh-in-docker)
  19. Twitter: [@neilpangxa](https://twitter.com/neilpangxa)
  20. # [中文说明](https://github.com/Neilpang/acme.sh/wiki/%E8%AF%B4%E6%98%8E)
  21. # Who:
  22. - [FreeBSD.org](https://blog.crashed.org/letsencrypt-in-freebsd-org/)
  23. - [ruby-china.org](https://ruby-china.org/topics/31983)
  24. - [Proxmox](https://pve.proxmox.com/wiki/HTTPS_Certificate_Configuration_(Version_4.x_and_newer))
  25. - [pfsense](https://github.com/pfsense/FreeBSD-ports/pull/89)
  26. - [webfaction](https://community.webfaction.com/questions/19988/using-letsencrypt)
  27. - [Loadbalancer.org](https://www.loadbalancer.org/blog/loadbalancer-org-with-lets-encrypt-quick-and-dirty)
  28. - [discourse.org](https://meta.discourse.org/t/setting-up-lets-encrypt/40709)
  29. - [Centminmod](https://centminmod.com/letsencrypt-acmetool-https.html)
  30. - [splynx](https://forum.splynx.com/t/free-ssl-cert-for-splynx-lets-encrypt/297)
  31. - [archlinux](https://www.archlinux.org/packages/community/any/acme.sh)
  32. - [opnsense.org](https://github.com/opnsense/plugins/tree/master/security/acme-client/src/opnsense/scripts/OPNsense/AcmeClient)
  33. - [CentOS Web Panel](http://centos-webpanel.com/)
  34. - [lnmp.org](https://lnmp.org/)
  35. - [more...](https://github.com/Neilpang/acme.sh/wiki/Blogs-and-tutorials)
  36. # Tested OS
  37. | NO | Status| Platform|
  38. |----|-------|---------|
  39. |1|[![](https://neilpang.github.io/acmetest/status/ubuntu-latest.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)| Ubuntu
  40. |2|[![](https://neilpang.github.io/acmetest/status/debian-latest.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)| Debian
  41. |3|[![](https://neilpang.github.io/acmetest/status/centos-latest.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|CentOS
  42. |4|[![](https://neilpang.github.io/acmetest/status/windows-cygwin.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|Windows (cygwin with curl, openssl and crontab included)
  43. |5|[![](https://neilpang.github.io/acmetest/status/freebsd.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|FreeBSD
  44. |6|[![](https://neilpang.github.io/acmetest/status/pfsense.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|pfsense
  45. |7|[![](https://neilpang.github.io/acmetest/status/opensuse-latest.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|openSUSE
  46. |8|[![](https://neilpang.github.io/acmetest/status/alpine-latest.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|Alpine Linux (with curl)
  47. |9|[![](https://neilpang.github.io/acmetest/status/base-archlinux.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|Archlinux
  48. |10|[![](https://neilpang.github.io/acmetest/status/fedora-latest.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|fedora
  49. |11|[![](https://neilpang.github.io/acmetest/status/kalilinux-kali-linux-docker.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|Kali Linux
  50. |12|[![](https://neilpang.github.io/acmetest/status/oraclelinux-latest.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|Oracle Linux
  51. |13|[![](https://neilpang.github.io/acmetest/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
  52. |14|-----| Cloud Linux https://github.com/Neilpang/le/issues/111
  53. |15|[![](https://neilpang.github.io/acmetest/status/openbsd.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|OpenBSD
  54. |16|[![](https://neilpang.github.io/acmetest/status/mageia.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|Mageia
  55. |17|-----| OpenWRT: Tested and working. See [wiki page](https://github.com/Neilpang/acme.sh/wiki/How-to-run-on-OpenWRT)
  56. |18|[![](https://neilpang.github.io/acmetest/status/solaris.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|SunOS/Solaris
  57. |19|[![](https://neilpang.github.io/acmetest/status/gentoo-stage3-amd64.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|Gentoo Linux
  58. |20|[![Build Status](https://travis-ci.org/Neilpang/acme.sh.svg?branch=master)](https://travis-ci.org/Neilpang/acme.sh)|Mac OSX
  59. For all build statuses, check our [weekly build project](https://github.com/Neilpang/acmetest):
  60. https://github.com/Neilpang/acmetest
  61. # Supported CA
  62. - Letsencrypt.org CA(default)
  63. - [BuyPass.com CA](https://github.com/Neilpang/acme.sh/wiki/BuyPass.com-CA)
  64. - [Pebble strict Mode](https://github.com/letsencrypt/pebble)
  65. # Supported modes
  66. - Webroot mode
  67. - Standalone mode
  68. - Standalone tls-alpn mode
  69. - Apache mode
  70. - Nginx mode
  71. - DNS mode
  72. - [DNS alias mode](https://github.com/Neilpang/acme.sh/wiki/DNS-alias-mode)
  73. - [Stateless mode](https://github.com/Neilpang/acme.sh/wiki/Stateless-Mode)
  74. # 1. How to install
  75. ### 1. Install online
  76. Check this project: https://github.com/Neilpang/get.acme.sh
  77. ```bash
  78. curl https://get.acme.sh | sh
  79. ```
  80. Or:
  81. ```bash
  82. wget -O - https://get.acme.sh | sh
  83. ```
  84. ### 2. Or, Install from git
  85. Clone this project and launch installation:
  86. ```bash
  87. git clone https://github.com/Neilpang/acme.sh.git
  88. cd ./acme.sh
  89. ./acme.sh --install
  90. ```
  91. You `don't have to be root` then, although `it is recommended`.
  92. Advanced Installation: https://github.com/Neilpang/acme.sh/wiki/How-to-install
  93. The installer will perform 3 actions:
  94. 1. Create and copy `acme.sh` to your home dir (`$HOME`): `~/.acme.sh/`.
  95. All certs will be placed in this folder too.
  96. 2. Create alias for: `acme.sh=~/.acme.sh/acme.sh`.
  97. 3. Create daily cron job to check and renew the certs if needed.
  98. Cron entry example:
  99. ```bash
  100. 0 0 * * * "/home/user/.acme.sh"/acme.sh --cron --home "/home/user/.acme.sh" > /dev/null
  101. ```
  102. After the installation, you must close the current terminal and reopen it to make the alias take effect.
  103. Ok, you are ready to issue certs now.
  104. Show help message:
  105. ```sh
  106. root@v1:~# acme.sh -h
  107. ```
  108. # 2. Just issue a cert
  109. **Example 1:** Single domain.
  110. ```bash
  111. acme.sh --issue -d example.com -w /home/wwwroot/example.com
  112. ```
  113. or:
  114. ```bash
  115. acme.sh --issue -d example.com -w /home/username/public_html
  116. ```
  117. or:
  118. ```bash
  119. acme.sh --issue -d example.com -w /var/www/html
  120. ```
  121. **Example 2:** Multiple domains in the same cert.
  122. ```bash
  123. acme.sh --issue -d example.com -d www.example.com -d cp.example.com -w /home/wwwroot/example.com
  124. ```
  125. 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.
  126. Second argument **"example.com"** is the main domain you want to issue the cert for.
  127. You must have at least one domain there.
  128. You must point and bind all the domains to the same webroot dir: `/home/wwwroot/example.com`.
  129. The certs will be placed in `~/.acme.sh/example.com/`
  130. The certs will be renewed automatically every **60** days.
  131. More examples: https://github.com/Neilpang/acme.sh/wiki/How-to-issue-a-cert
  132. # 3. Install the cert to Apache/Nginx etc.
  133. After the cert is generated, you probably want to install/copy the cert to your Apache/Nginx or other servers.
  134. 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.
  135. **Apache** example:
  136. ```bash
  137. acme.sh --install-cert -d example.com \
  138. --cert-file /path/to/certfile/in/apache/cert.pem \
  139. --key-file /path/to/keyfile/in/apache/key.pem \
  140. --fullchain-file /path/to/fullchain/certfile/apache/fullchain.pem \
  141. --reloadcmd "service apache2 force-reload"
  142. ```
  143. **Nginx** example:
  144. ```bash
  145. acme.sh --install-cert -d example.com \
  146. --key-file /path/to/keyfile/in/nginx/key.pem \
  147. --fullchain-file /path/to/fullchain/nginx/cert.pem \
  148. --reloadcmd "service nginx force-reload"
  149. ```
  150. Only the domain is required, all the other parameters are optional.
  151. The ownership and permission info of existing files are preserved. You can pre-create the files to define the ownership and permission.
  152. Install/copy the cert/key to the production Apache or Nginx path.
  153. 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`.
  154. **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.**
  155. # 4. Use Standalone server to issue cert
  156. **(requires you to be root/sudoer or have permission to listen on port 80 (TCP))**
  157. Port `80` (TCP) **MUST** be free to listen on, otherwise you will be prompted to free it and try again.
  158. ```bash
  159. acme.sh --issue --standalone -d example.com -d www.example.com -d cp.example.com
  160. ```
  161. More examples: https://github.com/Neilpang/acme.sh/wiki/How-to-issue-a-cert
  162. # 5. Use Standalone ssl server to issue cert
  163. **(requires you to be root/sudoer or have permission to listen on port 443 (TCP))**
  164. Port `443` (TCP) **MUST** be free to listen on, otherwise you will be prompted to free it and try again.
  165. ```bash
  166. acme.sh --issue --alpn -d example.com -d www.example.com -d cp.example.com
  167. ```
  168. More examples: https://github.com/Neilpang/acme.sh/wiki/How-to-issue-a-cert
  169. # 6. Use Apache mode
  170. **(requires you to be root/sudoer, since it is required to interact with Apache server)**
  171. If you are running a web server, Apache or Nginx, it is recommended to use the `Webroot mode`.
  172. 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.
  173. Just set string "apache" as the second argument and it will force use of apache plugin automatically.
  174. ```sh
  175. acme.sh --issue --apache -d example.com -d www.example.com -d cp.example.com
  176. ```
  177. **This apache mode is only to issue the cert, it will not change your apache config files.
  178. You will need to configure your website config files to use the cert by yourself.
  179. We don't want to mess your apache server, don't worry.**
  180. More examples: https://github.com/Neilpang/acme.sh/wiki/How-to-issue-a-cert
  181. # 7. Use Nginx mode
  182. **(requires you to be root/sudoer, since it is required to interact with Nginx server)**
  183. If you are running a web server, Apache or Nginx, it is recommended to use the `Webroot mode`.
  184. 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.
  185. Just set string "nginx" as the second argument.
  186. It will configure nginx server automatically to verify the domain and then restore the nginx config to the original version.
  187. So, the config is not changed.
  188. ```sh
  189. acme.sh --issue --nginx -d example.com -d www.example.com -d cp.example.com
  190. ```
  191. **This nginx mode is only to issue the cert, it will not change your nginx config files.
  192. You will need to configure your website config files to use the cert by yourself.
  193. We don't want to mess your nginx server, don't worry.**
  194. More examples: https://github.com/Neilpang/acme.sh/wiki/How-to-issue-a-cert
  195. # 8. Automatic DNS API integration
  196. If your DNS provider supports API access, we can use that API to automatically issue the certs.
  197. You don't have to do anything manually!
  198. ### Currently acme.sh supports most of the dns providers:
  199. https://github.com/Neilpang/acme.sh/wiki/dnsapi
  200. # 9. Use DNS manual mode:
  201. See: https://github.com/Neilpang/acme.sh/wiki/dns-manual-mode first.
  202. If your dns provider doesn't support any api access, you can add the txt record by your hand.
  203. ```bash
  204. acme.sh --issue --dns -d example.com -d www.example.com -d cp.example.com
  205. ```
  206. You should get an output like below:
  207. ```sh
  208. Add the following txt record:
  209. Domain:_acme-challenge.example.com
  210. Txt value:9ihDbjYfTExAYeDs4DBUeuTo18KBzwvTEjUnSwd32-c
  211. Add the following txt record:
  212. Domain:_acme-challenge.www.example.com
  213. Txt value:9ihDbjxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
  214. Please add those txt records to the domains. Waiting for the dns to take effect.
  215. ```
  216. Then just rerun with `renew` argument:
  217. ```bash
  218. acme.sh --renew -d example.com
  219. ```
  220. Ok, it's done.
  221. **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.**
  222. **Please use dns api mode instead.**
  223. # 10. Issue ECC certificates
  224. `Let's Encrypt` can now issue **ECDSA** certificates.
  225. And we support them too!
  226. Just set the `keylength` parameter with a prefix `ec-`.
  227. For example:
  228. ### Single domain ECC certificate
  229. ```bash
  230. acme.sh --issue -w /home/wwwroot/example.com -d example.com --keylength ec-256
  231. ```
  232. ### SAN multi domain ECC certificate
  233. ```bash
  234. acme.sh --issue -w /home/wwwroot/example.com -d example.com -d www.example.com --keylength ec-256
  235. ```
  236. Please look at the `keylength` parameter above.
  237. Valid values are:
  238. 1. **ec-256 (prime256v1, "ECDSA P-256")**
  239. 2. **ec-384 (secp384r1, "ECDSA P-384")**
  240. 3. **ec-521 (secp521r1, "ECDSA P-521", which is not supported by Let's Encrypt yet.)**
  241. # 11. Issue Wildcard certificates
  242. It's simple, just give a wildcard domain as the `-d` parameter.
  243. ```sh
  244. acme.sh --issue -d example.com -d '*.example.com' --dns dns_cf
  245. ```
  246. # 12. How to renew the certs
  247. No, you don't need to renew the certs manually. All the certs will be renewed automatically every **60** days.
  248. However, you can also force to renew a cert:
  249. ```sh
  250. acme.sh --renew -d example.com --force
  251. ```
  252. or, for ECC cert:
  253. ```sh
  254. acme.sh --renew -d example.com --force --ecc
  255. ```
  256. # 13. How to stop cert renewal
  257. To stop renewal of a cert, you can execute the following to remove the cert from the renewal list:
  258. ```sh
  259. acme.sh --remove -d example.com [--ecc]
  260. ```
  261. The cert/key file is not removed from the disk.
  262. You can remove the respective directory (e.g. `~/.acme.sh/example.com`) by yourself.
  263. # 14. How to upgrade `acme.sh`
  264. acme.sh is in constant development, so it's strongly recommended to use the latest code.
  265. You can update acme.sh to the latest code:
  266. ```sh
  267. acme.sh --upgrade
  268. ```
  269. You can also enable auto upgrade:
  270. ```sh
  271. acme.sh --upgrade --auto-upgrade
  272. ```
  273. Then **acme.sh** will be kept up to date automatically.
  274. Disable auto upgrade:
  275. ```sh
  276. acme.sh --upgrade --auto-upgrade 0
  277. ```
  278. # 15. Issue a cert from an existing CSR
  279. https://github.com/Neilpang/acme.sh/wiki/Issue-a-cert-from-existing-CSR
  280. # 16. Send notifications in cronjob
  281. https://github.com/Neilpang/acme.sh/wiki/notify
  282. # 17. Under the Hood
  283. Speak ACME language using shell, directly to "Let's Encrypt".
  284. TODO:
  285. # 18. Acknowledgments
  286. 1. Acme-tiny: https://github.com/diafygi/acme-tiny
  287. 2. ACME protocol: https://github.com/ietf-wg-acme/acme
  288. ## Contributors
  289. ### Code Contributors
  290. This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
  291. <a href="https://github.com/Neilpang/acme.sh/graphs/contributors"><img src="https://opencollective.com/acmesh/contributors.svg?width=890&button=false" /></a>
  292. ### Financial Contributors
  293. Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/acmesh/contribute)]
  294. #### Individuals
  295. <a href="https://opencollective.com/acmesh"><img src="https://opencollective.com/acmesh/individuals.svg?width=890"></a>
  296. #### Organizations
  297. Support this project with your organization. Your logo will show up here with a link to your website. [[Contribute](https://opencollective.com/acmesh/contribute)]
  298. <a href="https://opencollective.com/acmesh/organization/0/website"><img src="https://opencollective.com/acmesh/organization/0/avatar.svg"></a>
  299. <a href="https://opencollective.com/acmesh/organization/1/website"><img src="https://opencollective.com/acmesh/organization/1/avatar.svg"></a>
  300. <a href="https://opencollective.com/acmesh/organization/2/website"><img src="https://opencollective.com/acmesh/organization/2/avatar.svg"></a>
  301. <a href="https://opencollective.com/acmesh/organization/3/website"><img src="https://opencollective.com/acmesh/organization/3/avatar.svg"></a>
  302. <a href="https://opencollective.com/acmesh/organization/4/website"><img src="https://opencollective.com/acmesh/organization/4/avatar.svg"></a>
  303. <a href="https://opencollective.com/acmesh/organization/5/website"><img src="https://opencollective.com/acmesh/organization/5/avatar.svg"></a>
  304. <a href="https://opencollective.com/acmesh/organization/6/website"><img src="https://opencollective.com/acmesh/organization/6/avatar.svg"></a>
  305. <a href="https://opencollective.com/acmesh/organization/7/website"><img src="https://opencollective.com/acmesh/organization/7/avatar.svg"></a>
  306. <a href="https://opencollective.com/acmesh/organization/8/website"><img src="https://opencollective.com/acmesh/organization/8/avatar.svg"></a>
  307. <a href="https://opencollective.com/acmesh/organization/9/website"><img src="https://opencollective.com/acmesh/organization/9/avatar.svg"></a>
  308. # 19. License & Others
  309. License is GPLv3
  310. Please Star and Fork me.
  311. [Issues](https://github.com/Neilpang/acme.sh/issues) and [pull requests](https://github.com/Neilpang/acme.sh/pulls) are welcome.
  312. # 20. Donate
  313. Your donation makes **acme.sh** better:
  314. 1. PayPal/Alipay(支付宝)/Wechat(微信): [https://donate.acme.sh/](https://donate.acme.sh/)
  315. [Donate List](https://github.com/Neilpang/acme.sh/wiki/Donate-list)