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.

345 lines
11 KiB

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
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
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
9 years ago
8 years ago
9 years ago
8 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
8 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
8 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
8 years ago
  1. # An ACME Shell script: acme.sh
  2. - An ACME protocol client written purely in Shell (Unix shell) language.
  3. - Fully ACME protocol implementation.
  4. - Simple, powerful and very easy to use. You only need 3 minutes to learn.
  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 Let's Encrypt official client.
  8. - Just one script, to issue, renew and install your certificates automatically.
  9. - DOES NOT require `root/sudoer` access.
  10. It's probably the `easiest&smallest&smartest` shell script to automatically issue & renew the free certificates from Let's Encrypt.
  11. Wiki: https://github.com/Neilpang/acme.sh/wiki
  12. #Tested OS
  13. | NO | Status| Platform|
  14. |----|-------|---------|
  15. |1|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/ubuntu-latest.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)| Ubuntu
  16. |2|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/debian-latest.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)| Debian
  17. |3|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/centos-latest.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|CentOS
  18. |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)
  19. |5|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/freebsd.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|FreeBSD
  20. |6|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/pfsense.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|pfsense
  21. |7|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/opensuse-latest.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|openSUSE
  22. |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)
  23. |9|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/base-archlinux.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|Archlinux
  24. |10|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/fedora-latest.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|fedora
  25. |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
  26. |12|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/oraclelinux-latest.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|Oracle Linux
  27. |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
  28. |14|-----| Cloud Linux https://github.com/Neilpang/le/issues/111
  29. |15|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/openbsd.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|OpenBSD
  30. |16|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/mageia.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|Mageia
  31. |17|-----| OpenWRT: Tested and working. See [wiki page](https://github.com/Neilpang/acme.sh/wiki/How-to-run-on-OpenWRT)
  32. |18|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/solaris.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|SunOS/Solaris
  33. For all build statuses, check our [daily build project](https://github.com/Neilpang/acmetest):
  34. https://github.com/Neilpang/acmetest
  35. # Supported Mode
  36. 1. Webroot mode
  37. 2. Standalone mode
  38. 3. Apache mode
  39. 4. Dns mode
  40. # 1. How to install
  41. ### 1. Install online:
  42. Check this project: https://github.com/Neilpang/get.acme.sh
  43. ```bash
  44. curl https://get.acme.sh | sh
  45. ```
  46. Or:
  47. ```bash
  48. wget -O - https://get.acme.sh | sh
  49. ```
  50. ### 2. Or, Install from git:
  51. Clone this project:
  52. ```bash
  53. git clone https://github.com/Neilpang/acme.sh.git
  54. cd ./acme.sh
  55. ./acme.sh --install
  56. ```
  57. You `don't have to be root` then, although `it is recommended`.
  58. Advanced Installation: https://github.com/Neilpang/acme.sh/wiki/How-to-install
  59. The installer will perform 3 actions:
  60. 1. Create and copy `acme.sh` to your home dir (`$HOME`): `~/.acme.sh/`.
  61. All certs will be placed in this folder.
  62. 2. Create alias for: `acme.sh=~/.acme.sh/acme.sh`.
  63. 3. Create everyday cron job to check and renew the cert if needed.
  64. Cron entry example:
  65. ```bash
  66. 0 0 * * * "/home/user/.acme.sh"/acme.sh --cron --home "/home/user/.acme.sh" > /dev/null
  67. ```
  68. After the installation, you must close current terminal and reopen again to make the alias take effect.
  69. Ok, you are ready to issue cert now.
  70. Show help message:
  71. ```
  72. root@v1:~# acme.sh -h
  73. ```
  74. # 2. Just issue a cert:
  75. **Example 1:** Single domain.
  76. ```bash
  77. acme.sh --issue -d aa.com -w /home/wwwroot/aa.com
  78. ```
  79. **Example 2:** Multiple domains in the same cert.
  80. ```bash
  81. acme.sh --issue -d aa.com -d www.aa.com -d cp.aa.com -w /home/wwwroot/aa.com
  82. ```
  83. The parameter `/home/wwwroot/aa.com` is the web root folder. You **MUST** have `write access` to this folder.
  84. Second argument **"aa.com"** is the main domain you want to issue cert for.
  85. You must have at least a domain there.
  86. You must point and bind all the domains to the same webroot dir: `/home/wwwroot/aa.com`.
  87. Generate/issued certs will be placed in `~/.acme.sh/aa.com/`
  88. The issued cert will be renewed every 80 days automatically.
  89. More examples: https://github.com/Neilpang/acme.sh/wiki/How-to-issue-a-cert
  90. # 3. Install the issued cert to apache/nginx etc.
  91. After you issue a cert, you probably want to install/copy the cert to your nginx/apache or other servers you may be using.
  92. ```bash
  93. acme.sh --installcert -d aa.com \
  94. --certpath /path/to/certfile/in/apache/nginx \
  95. --keypath /path/to/keyfile/in/apache/nginx \
  96. --capath /path/to/ca/certfile/apache/nginx \
  97. --fullchainpath path/to/fullchain/certfile/apache/nginx \
  98. --reloadcmd "service apache2|nginx reload"
  99. ```
  100. Only the domain is required, all the other parameters are optional.
  101. Install/copy the issued cert/key to the production apache or nginx path.
  102. The cert will be `renewed every 80 days by default` (which is configurable). Once the cert is renewed, the apache/nginx will be automatically reloaded by the command: `service apache2 reload` or `service nginx reload`.
  103. # 4. Use Standalone server to issue cert
  104. **(requires you be root/sudoer, or you have permission to listen tcp 80 port)**
  105. The tcp `80` port **MUST** be free to listen, otherwise you will be prompted to free the `80` port and try again.
  106. ```bash
  107. acme.sh --issue --standalone -d aa.com -d www.aa.com -d cp.aa.com
  108. ```
  109. More examples: https://github.com/Neilpang/acme.sh/wiki/How-to-issue-a-cert
  110. # 5. Use Standalone tls server to issue cert
  111. **(requires you be root/sudoer, or you have permission to listen tcp 443 port)**
  112. acme.sh supports `tls-sni-01` validation.
  113. The tcp `443` port **MUST** be free to listen, otherwise you will be prompted to free the `443` port and try again.
  114. ```bash
  115. acme.sh --issue --tls -d aa.com -d www.aa.com -d cp.aa.com
  116. ```
  117. More examples: https://github.com/Neilpang/acme.sh/wiki/How-to-issue-a-cert
  118. # 6. Use Apache mode
  119. **(requires you be root/sudoer, since it is required to interact with apache server)**
  120. If you are running a web server, apache or nginx, it is recommended to use the `Webroot mode`.
  121. 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.
  122. Just set string "apache" as the second argument, it will force use of apache plugin automatically.
  123. ```
  124. acme.sh --issue --apache -d aa.com -d www.aa.com -d user.aa.com
  125. ```
  126. More examples: https://github.com/Neilpang/acme.sh/wiki/How-to-issue-a-cert
  127. # 7. Use DNS mode:
  128. Support the `dns-01` challenge.
  129. ```bash
  130. acme.sh --issue --dns -d aa.com -d www.aa.com -d user.aa.com
  131. ```
  132. You should get the output like below:
  133. ```
  134. Add the following txt record:
  135. Domain:_acme-challenge.aa.com
  136. Txt value:9ihDbjYfTExAYeDs4DBUeuTo18KBzwvTEjUnSwd32-c
  137. Add the following txt record:
  138. Domain:_acme-challenge.www.aa.com
  139. Txt value:9ihDbjxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
  140. Please add those txt records to the domains. Waiting for the dns to take effect.
  141. ```
  142. Then just rerun with `renew` argument:
  143. ```bash
  144. acme.sh --renew -d aa.com
  145. ```
  146. Ok, it's finished.
  147. # 8. Automatic DNS API integration
  148. If your DNS provider supports API access, we can use API to automatically issue the certs.
  149. You don't have do anything manually!
  150. ### Currently acme.sh supports:
  151. 1. Cloudflare.com API
  152. 2. Dnspod.cn API
  153. 3. Cloudxns.com API
  154. 4. Godaddy.com API
  155. 5. OVH, kimsufi, soyoustart and runabove API
  156. 6. AWS Route 53, see: https://github.com/Neilpang/acme.sh/issues/65
  157. 7. lexicon dns api: https://github.com/Neilpang/acme.sh/wiki/How-to-use-lexicon-dns-api
  158. (DigitalOcean, DNSimple, DnsMadeEasy, DNSPark, EasyDNS, Namesilo, NS1, PointHQ, Rage4 and Vultr etc.)
  159. ##### More APIs are coming soon...
  160. If your DNS provider is not on the supported list above, you can write your own script API easily. If you do please consider submitting a [Pull Request](https://github.com/Neilpang/acme.sh/pulls) and contribute to the project.
  161. For more details: [How to use dns api](dnsapi)
  162. # 9. Issue ECC certificate:
  163. `Let's Encrypt` now can issue **ECDSA** certificates.
  164. And we also support it.
  165. Just set the `length` parameter with a prefix `ec-`.
  166. For example:
  167. ### Single domain ECC cerfiticate:
  168. ```bash
  169. acme.sh --issue -w /home/wwwroot/aa.com -d aa.com --keylength ec-256
  170. ```
  171. SAN multi domain ECC certificate:
  172. ```bash
  173. acme.sh --issue -w /home/wwwroot/aa.com -d aa.com -d www.aa.com --keylength ec-256
  174. ```
  175. Please look at the last parameter above.
  176. Valid values are:
  177. 1. **ec-256 (prime256v1, "ECDSA P-256")**
  178. 2. **ec-384 (secp384r1, "ECDSA P-384")**
  179. 3. **ec-521 (secp521r1, "ECDSA P-521", which is not supported by Let's Encrypt yet.)**
  180. # 10. How to renew the cert
  181. No, you don't need to renew the certs manually. All the certs will be renewed automatically every 80 days.
  182. However, you can also force to renew any cert:
  183. ```
  184. acme.sh --renew -d aa.com --force
  185. ```
  186. or, for ECC cert:
  187. ```
  188. acme.sh --renew -d aa.com --force --ecc
  189. ```
  190. # 11. How to upgrade `acme.sh`
  191. acme.sh is in developing, it's strongly recommended to use the latest code.
  192. You can update acme.sh to the latest code:
  193. ```
  194. acme.sh --upgrade
  195. ```
  196. You can enable auto upgrade:
  197. ```
  198. acme.sh --upgrade --auto-upgrade
  199. ```
  200. Then **acme.sh** will keep up to date automatically.
  201. Disable auto upgrade:
  202. ```
  203. acme.sh --upgrade --auto-upgrade 0
  204. ```
  205. # 12. Issue a cert from an existing CSR
  206. https://github.com/Neilpang/acme.sh/wiki/Issue-a-cert-from-existing-CSR
  207. # Under the Hood
  208. Speak ACME language using shell, directly to "Let's Encrypt".
  209. TODO:
  210. # Acknowledgment
  211. 1. Acme-tiny: https://github.com/diafygi/acme-tiny
  212. 2. ACME protocol: https://github.com/ietf-wg-acme/acme
  213. 3. Certbot: https://github.com/certbot/certbot
  214. # License & Others
  215. License is GPLv3
  216. Please Star and Fork me.
  217. [Issues](https://github.com/Neilpang/acme.sh/issues) and [pull requests](https://github.com/Neilpang/acme.sh/pulls) are welcomed.
  218. # Donate
  219. 1. PayPal: donate@acme.sh
  220. [Donate List](https://github.com/Neilpang/acme.sh/wiki/Donate-list)