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.

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