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.

348 lines
11 KiB

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