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.

430 lines
15 KiB

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