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.

509 lines
17 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
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
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
8 years ago
7 years ago
7 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
9 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
7 years ago
7 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
7 years ago
8 years ago
7 years ago
8 years ago
7 years ago
8 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
7 years ago
8 years ago
8 years ago
7 years ago
8 years ago
7 years ago
7 years ago
7 years ago
7 years ago
9 years ago
9 years ago
7 years ago
9 years ago
7 years ago
9 years ago
9 years ago
9 years ago
9 years ago
7 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](http://centminmod.com/letsencrypt-acmetool-https.html)
  29. - [splynx](https://forum.splynx.com/t/free-ssl-cert-for-splynx-lets-encrypt/297)
  30. - [archlinux](https://aur.archlinux.org/packages/acme.sh-git/)
  31. - [opnsense.org](https://github.com/opnsense/plugins/tree/master/security/acme-client/src/opnsense/scripts/OPNsense/AcmeClient)
  32. - [more...](https://github.com/Neilpang/acme.sh/wiki/Blogs-and-tutorials)
  33. # Tested OS
  34. | NO | Status| Platform|
  35. |----|-------|---------|
  36. |1|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/ubuntu-latest.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)| Ubuntu
  37. |2|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/debian-latest.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)| Debian
  38. |3|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/centos-latest.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|CentOS
  39. |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)
  40. |5|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/freebsd.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|FreeBSD
  41. |6|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/pfsense.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|pfsense
  42. |7|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/opensuse-latest.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|openSUSE
  43. |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)
  44. |9|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/base-archlinux.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|Archlinux
  45. |10|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/fedora-latest.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|fedora
  46. |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
  47. |12|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/oraclelinux-latest.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|Oracle Linux
  48. |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
  49. |14|-----| Cloud Linux https://github.com/Neilpang/le/issues/111
  50. |15|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/openbsd.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|OpenBSD
  51. |16|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/mageia.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|Mageia
  52. |17|-----| OpenWRT: Tested and working. See [wiki page](https://github.com/Neilpang/acme.sh/wiki/How-to-run-on-OpenWRT)
  53. |18|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/solaris.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|SunOS/Solaris
  54. |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
  55. |20|[![Build Status](https://travis-ci.org/Neilpang/acme.sh.svg?branch=master)](https://travis-ci.org/Neilpang/acme.sh)|Mac OSX
  56. For all build statuses, check our [weekly build project](https://github.com/Neilpang/acmetest):
  57. https://github.com/Neilpang/acmetest
  58. # Supported modes
  59. - Webroot mode
  60. - Standalone mode
  61. - Apache mode
  62. - Nginx mode
  63. - DNS mode
  64. - [DNS alias mode](https://github.com/Neilpang/acme.sh/wiki/DNS-alias-mode)
  65. - [Stateless mode](https://github.com/Neilpang/acme.sh/wiki/Stateless-Mode)
  66. # 1. How to install
  67. ### 1. Install online
  68. Check this project: https://github.com/Neilpang/get.acme.sh
  69. ```bash
  70. curl https://get.acme.sh | sh
  71. ```
  72. Or:
  73. ```bash
  74. wget -O - https://get.acme.sh | sh
  75. ```
  76. ### 2. Or, Install from git
  77. Clone this project and launch installation:
  78. ```bash
  79. git clone https://github.com/Neilpang/acme.sh.git
  80. cd ./acme.sh
  81. ./acme.sh --install
  82. ```
  83. You `don't have to be root` then, although `it is recommended`.
  84. Advanced Installation: https://github.com/Neilpang/acme.sh/wiki/How-to-install
  85. The installer will perform 3 actions:
  86. 1. Create and copy `acme.sh` to your home dir (`$HOME`): `~/.acme.sh/`.
  87. All certs will be placed in this folder too.
  88. 2. Create alias for: `acme.sh=~/.acme.sh/acme.sh`.
  89. 3. Create daily cron job to check and renew the certs if needed.
  90. Cron entry example:
  91. ```bash
  92. 0 0 * * * "/home/user/.acme.sh"/acme.sh --cron --home "/home/user/.acme.sh" > /dev/null
  93. ```
  94. After the installation, you must close the current terminal and reopen it to make the alias take effect.
  95. Ok, you are ready to issue certs now.
  96. Show help message:
  97. ```sh
  98. root@v1:~# acme.sh -h
  99. ```
  100. # 2. Just issue a cert
  101. **Example 1:** Single domain.
  102. ```bash
  103. acme.sh --issue -d example.com -w /home/wwwroot/example.com
  104. ```
  105. or:
  106. ```bash
  107. acme.sh --issue -d example.com -w /home/username/public_html
  108. ```
  109. or:
  110. ```bash
  111. acme.sh --issue -d example.com -w /var/www/html
  112. ```
  113. **Example 2:** Multiple domains in the same cert.
  114. ```bash
  115. acme.sh --issue -d example.com -d www.example.com -d cp.example.com -w /home/wwwroot/example.com
  116. ```
  117. 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.
  118. Second argument **"example.com"** is the main domain you want to issue the cert for.
  119. You must have at least one domain there.
  120. You must point and bind all the domains to the same webroot dir: `/home/wwwroot/example.com`.
  121. The certs will be placed in `~/.acme.sh/example.com/`
  122. The certs will be renewed automatically every **60** days.
  123. More examples: https://github.com/Neilpang/acme.sh/wiki/How-to-issue-a-cert
  124. # 3. Install the cert to Apache/Nginx etc.
  125. After the cert is generated, you probably want to install/copy the cert to your Apache/Nginx or other servers.
  126. 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.
  127. **Apache** example:
  128. ```bash
  129. acme.sh --install-cert -d example.com \
  130. --cert-file /path/to/certfile/in/apache/cert.pem \
  131. --key-file /path/to/keyfile/in/apache/key.pem \
  132. --fullchain-file /path/to/fullchain/certfile/apache/fullchain.pem \
  133. --reloadcmd "service apache2 force-reload"
  134. ```
  135. **Nginx** example:
  136. ```bash
  137. acme.sh --install-cert -d example.com \
  138. --key-file /path/to/keyfile/in/nginx/key.pem \
  139. --fullchain-file /path/to/fullchain/nginx/cert.pem \
  140. --reloadcmd "service nginx force-reload"
  141. ```
  142. Only the domain is required, all the other parameters are optional.
  143. The ownership and permission info of existing files are preserved. You can pre-create the files to define the ownership and permission.
  144. Install/copy the cert/key to the production Apache or Nginx path.
  145. 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`.
  146. **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.**
  147. # 4. Use Standalone server to issue cert
  148. **(requires you to be root/sudoer or have permission to listen on port 80 (TCP))**
  149. Port `80` (TCP) **MUST** be free to listen on, otherwise you will be prompted to free it and try again.
  150. ```bash
  151. acme.sh --issue --standalone -d example.com -d www.example.com -d cp.example.com
  152. ```
  153. More examples: https://github.com/Neilpang/acme.sh/wiki/How-to-issue-a-cert
  154. # 5. Use Standalone TLS server to issue cert
  155. **(requires you to be root/sudoer or have permission to listen on port 443 (TCP))**
  156. acme.sh supports `tls-sni-01` validation.
  157. Port `443` (TCP) **MUST** be free to listen on, otherwise you will be prompted to free it and try again.
  158. ```bash
  159. acme.sh --issue --tls -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. # 6. Use Apache mode
  163. **(requires you to be root/sudoer, since it is required to interact with Apache server)**
  164. If you are running a web server, Apache or Nginx, it is recommended to use the `Webroot mode`.
  165. 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.
  166. Just set string "apache" as the second argument and it will force use of apache plugin automatically.
  167. ```sh
  168. acme.sh --issue --apache -d example.com -d www.example.com -d cp.example.com
  169. ```
  170. **This apache mode is only to issue the cert, it will not change your apache config files.
  171. You will need to configure your website config files to use the cert by yourself.
  172. We don't want to mess your apache server, don't worry.**
  173. More examples: https://github.com/Neilpang/acme.sh/wiki/How-to-issue-a-cert
  174. # 7. Use Nginx mode
  175. **(requires you to be root/sudoer, since it is required to interact with Nginx server)**
  176. If you are running a web server, Apache or Nginx, it is recommended to use the `Webroot mode`.
  177. 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.
  178. Just set string "nginx" as the second argument.
  179. It will configure nginx server automatically to verify the domain and then restore the nginx config to the original version.
  180. So, the config is not changed.
  181. ```sh
  182. acme.sh --issue --nginx -d example.com -d www.example.com -d cp.example.com
  183. ```
  184. **This nginx mode is only to issue the cert, it will not change your nginx config files.
  185. You will need to configure your website config files to use the cert by yourself.
  186. We don't want to mess your nginx server, don't worry.**
  187. More examples: https://github.com/Neilpang/acme.sh/wiki/How-to-issue-a-cert
  188. # 8. Automatic DNS API integration
  189. If your DNS provider supports API access, we can use that API to automatically issue the certs.
  190. You don't have to do anything manually!
  191. ### Currently acme.sh supports:
  192. 1. CloudFlare.com API
  193. 1. DNSPod.cn API
  194. 1. CloudXNS.com API
  195. 1. GoDaddy.com API
  196. 1. PowerDNS.com API
  197. 1. OVH, kimsufi, soyoustart and runabove API
  198. 1. nsupdate API
  199. 1. LuaDNS.com API
  200. 1. DNSMadeEasy.com API
  201. 1. AWS Route 53
  202. 1. aliyun.com(阿里云) API
  203. 1. ISPConfig 3.1 API
  204. 1. Alwaysdata.com API
  205. 1. Linode.com API
  206. 1. FreeDNS (https://freedns.afraid.org/)
  207. 1. cyon.ch
  208. 1. Domain-Offensive/Resellerinterface/Domainrobot API
  209. 1. Gandi LiveDNS API
  210. 1. Knot DNS API
  211. 1. DigitalOcean API (native)
  212. 1. ClouDNS.net API
  213. 1. Infoblox NIOS API (https://www.infoblox.com/)
  214. 1. VSCALE (https://vscale.io/)
  215. 1. Dynu API (https://www.dynu.com)
  216. 1. DNSimple API
  217. 1. NS1.com API
  218. 1. DuckDNS.org API
  219. 1. Name.com API
  220. 1. Dyn Managed DNS API
  221. 1. Yandex PDD API (https://pdd.yandex.ru)
  222. 1. Hurricane Electric DNS service (https://dns.he.net)
  223. 1. UnoEuro API (https://www.unoeuro.com/)
  224. 1. INWX (https://www.inwx.de/)
  225. 1. Servercow (https://servercow.de)
  226. 1. Namesilo (https://www.namesilo.com)
  227. 1. InternetX autoDNS API (https://internetx.com)
  228. 1. Azure DNS
  229. 1. selectel.com(selectel.ru) DNS API
  230. 1. zonomi.com DNS API
  231. 1. DreamHost.com API
  232. 1. DirectAdmin API
  233. 1. All-inkl/Kasserver API
  234. And:
  235. **lexicon DNS API: https://github.com/Neilpang/acme.sh/wiki/How-to-use-lexicon-dns-api
  236. (DigitalOcean, DNSimple, DNSMadeEasy, DNSPark, EasyDNS, Namesilo, NS1, PointHQ, Rage4 and Vultr etc.)**
  237. **More APIs coming soon...**
  238. 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.
  239. For more details: [How to use DNS API](dnsapi)
  240. # 9. Use DNS manual mode:
  241. If your dns provider doesn't support any api access, you can add the txt record by your hand.
  242. ```bash
  243. acme.sh --issue --dns -d example.com -d www.example.com -d cp.example.com
  244. ```
  245. You should get an output like below:
  246. ```sh
  247. Add the following txt record:
  248. Domain:_acme-challenge.example.com
  249. Txt value:9ihDbjYfTExAYeDs4DBUeuTo18KBzwvTEjUnSwd32-c
  250. Add the following txt record:
  251. Domain:_acme-challenge.www.example.com
  252. Txt value:9ihDbjxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
  253. Please add those txt records to the domains. Waiting for the dns to take effect.
  254. ```
  255. Then just rerun with `renew` argument:
  256. ```bash
  257. acme.sh --renew -d example.com
  258. ```
  259. Ok, it's done.
  260. **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.**
  261. **Please use dns api mode instead.**
  262. # 10. Issue ECC certificates
  263. `Let's Encrypt` can now issue **ECDSA** certificates.
  264. And we support them too!
  265. Just set the `keylength` parameter with a prefix `ec-`.
  266. For example:
  267. ### Single domain ECC certificate
  268. ```bash
  269. acme.sh --issue -w /home/wwwroot/example.com -d example.com --keylength ec-256
  270. ```
  271. ### SAN multi domain ECC certificate
  272. ```bash
  273. acme.sh --issue -w /home/wwwroot/example.com -d example.com -d www.example.com --keylength ec-256
  274. ```
  275. Please look at the `keylength` parameter above.
  276. Valid values are:
  277. 1. **ec-256 (prime256v1, "ECDSA P-256")**
  278. 2. **ec-384 (secp384r1, "ECDSA P-384")**
  279. 3. **ec-521 (secp521r1, "ECDSA P-521", which is not supported by Let's Encrypt yet.)**
  280. # 11. Issue Wildcard certificates
  281. It's simple, just give a wildcard domain as the `-d` parameter.
  282. ```sh
  283. acme.sh --issue -d example.com -d *.example.com --dns dns_cf
  284. ```
  285. # 12. How to renew the certs
  286. No, you don't need to renew the certs manually. All the certs will be renewed automatically every **60** days.
  287. However, you can also force to renew a cert:
  288. ```sh
  289. acme.sh --renew -d example.com --force
  290. ```
  291. or, for ECC cert:
  292. ```sh
  293. acme.sh --renew -d example.com --force --ecc
  294. ```
  295. # 13. How to stop cert renewal
  296. To stop renewal of a cert, you can execute the following to remove the cert from the renewal list:
  297. ```sh
  298. acme.sh --remove -d example.com [--ecc]
  299. ```
  300. The cert/key file is not removed from the disk.
  301. You can remove the respective directory (e.g. `~/.acme.sh/example.com`) by yourself.
  302. # 14. How to upgrade `acme.sh`
  303. acme.sh is in constant development, so it's strongly recommended to use the latest code.
  304. You can update acme.sh to the latest code:
  305. ```sh
  306. acme.sh --upgrade
  307. ```
  308. You can also enable auto upgrade:
  309. ```sh
  310. acme.sh --upgrade --auto-upgrade
  311. ```
  312. Then **acme.sh** will be kept up to date automatically.
  313. Disable auto upgrade:
  314. ```sh
  315. acme.sh --upgrade --auto-upgrade 0
  316. ```
  317. # 15. Issue a cert from an existing CSR
  318. https://github.com/Neilpang/acme.sh/wiki/Issue-a-cert-from-existing-CSR
  319. # 16. Under the Hood
  320. Speak ACME language using shell, directly to "Let's Encrypt".
  321. TODO:
  322. # 17. Acknowledgments
  323. 1. Acme-tiny: https://github.com/diafygi/acme-tiny
  324. 2. ACME protocol: https://github.com/ietf-wg-acme/acme
  325. # 18. License & Others
  326. License is GPLv3
  327. Please Star and Fork me.
  328. [Issues](https://github.com/Neilpang/acme.sh/issues) and [pull requests](https://github.com/Neilpang/acme.sh/pulls) are welcome.
  329. # 19. Donate
  330. Your donation makes **acme.sh** better:
  331. 1. PayPal/Alipay(支付宝)/Wechat(微信): [https://donate.acme.sh/](https://donate.acme.sh/)
  332. [Donate List](https://github.com/Neilpang/acme.sh/wiki/Donate-list)