|
|
|
@@ -17,14 +17,14 @@
|
|
|
|
|
|
|
|
|
|
It's probably the `easiest & smartest` shell script to automatically issue & renew the free certificates from Let's Encrypt.
|
|
|
|
|
|
|
|
|
|
Wiki: https://github.com/Neilpang/acme.sh/wiki
|
|
|
|
|
Wiki: https://github.com/acmesh-official/acme.sh/wiki
|
|
|
|
|
|
|
|
|
|
For Docker Fans: [acme.sh :two_hearts: Docker ](https://github.com/Neilpang/acme.sh/wiki/Run-acme.sh-in-docker)
|
|
|
|
|
For Docker Fans: [acme.sh :two_hearts: Docker ](https://github.com/acmesh-official/acme.sh/wiki/Run-acme.sh-in-docker)
|
|
|
|
|
|
|
|
|
|
Twitter: [@neilpangxa](https://twitter.com/neilpangxa)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
# [中文说明](https://github.com/Neilpang/acme.sh/wiki/%E8%AF%B4%E6%98%8E)
|
|
|
|
|
# [中文说明](https://github.com/acmesh-official/acme.sh/wiki/%E8%AF%B4%E6%98%8E)
|
|
|
|
|
|
|
|
|
|
# Who:
|
|
|
|
|
- [FreeBSD.org](https://blog.crashed.org/letsencrypt-in-freebsd-org/)
|
|
|
|
@@ -40,41 +40,41 @@ Twitter: [@neilpangxa](https://twitter.com/neilpangxa)
|
|
|
|
|
- [opnsense.org](https://github.com/opnsense/plugins/tree/master/security/acme-client/src/opnsense/scripts/OPNsense/AcmeClient)
|
|
|
|
|
- [CentOS Web Panel](http://centos-webpanel.com/)
|
|
|
|
|
- [lnmp.org](https://lnmp.org/)
|
|
|
|
|
- [more...](https://github.com/Neilpang/acme.sh/wiki/Blogs-and-tutorials)
|
|
|
|
|
- [more...](https://github.com/acmesh-official/acme.sh/wiki/Blogs-and-tutorials)
|
|
|
|
|
|
|
|
|
|
# Tested OS
|
|
|
|
|
|
|
|
|
|
| NO | Status| Platform|
|
|
|
|
|
|----|-------|---------|
|
|
|
|
|
|1|[](https://github.com/Neilpang/letest#here-are-the-latest-status)| Ubuntu
|
|
|
|
|
|2|[](https://github.com/Neilpang/letest#here-are-the-latest-status)| Debian
|
|
|
|
|
|3|[](https://github.com/Neilpang/letest#here-are-the-latest-status)|CentOS
|
|
|
|
|
|4|[](https://github.com/Neilpang/letest#here-are-the-latest-status)|Windows (cygwin with curl, openssl and crontab included)
|
|
|
|
|
|5|[](https://github.com/Neilpang/letest#here-are-the-latest-status)|FreeBSD
|
|
|
|
|
|6|[](https://github.com/Neilpang/letest#here-are-the-latest-status)|pfsense
|
|
|
|
|
|7|[](https://github.com/Neilpang/letest#here-are-the-latest-status)|openSUSE
|
|
|
|
|
|8|[](https://github.com/Neilpang/letest#here-are-the-latest-status)|Alpine Linux (with curl)
|
|
|
|
|
|9|[](https://github.com/Neilpang/letest#here-are-the-latest-status)|Archlinux
|
|
|
|
|
|10|[](https://github.com/Neilpang/letest#here-are-the-latest-status)|fedora
|
|
|
|
|
|11|[](https://github.com/Neilpang/letest#here-are-the-latest-status)|Kali Linux
|
|
|
|
|
|12|[](https://github.com/Neilpang/letest#here-are-the-latest-status)|Oracle Linux
|
|
|
|
|
|13|[](https://github.com/Neilpang/letest#here-are-the-latest-status)| Proxmox https://pve.proxmox.com/wiki/HTTPSCertificateConfiguration#Let.27s_Encrypt_using_acme.sh
|
|
|
|
|
|14|-----| Cloud Linux https://github.com/Neilpang/le/issues/111
|
|
|
|
|
|15|[](https://github.com/Neilpang/letest#here-are-the-latest-status)|OpenBSD
|
|
|
|
|
|16|[](https://github.com/Neilpang/letest#here-are-the-latest-status)|Mageia
|
|
|
|
|
|17|-----| OpenWRT: Tested and working. See [wiki page](https://github.com/Neilpang/acme.sh/wiki/How-to-run-on-OpenWRT)
|
|
|
|
|
|18|[](https://github.com/Neilpang/letest#here-are-the-latest-status)|SunOS/Solaris
|
|
|
|
|
|19|[](https://github.com/Neilpang/letest#here-are-the-latest-status)|Gentoo Linux
|
|
|
|
|
|1|[](https://github.com/acmesh-official/letest#here-are-the-latest-status)| Ubuntu
|
|
|
|
|
|2|[](https://github.com/acmesh-official/letest#here-are-the-latest-status)| Debian
|
|
|
|
|
|3|[](https://github.com/acmesh-official/letest#here-are-the-latest-status)|CentOS
|
|
|
|
|
|4|[](https://github.com/acmesh-official/letest#here-are-the-latest-status)|Windows (cygwin with curl, openssl and crontab included)
|
|
|
|
|
|5|[](https://github.com/acmesh-official/letest#here-are-the-latest-status)|FreeBSD
|
|
|
|
|
|6|[](https://github.com/acmesh-official/letest#here-are-the-latest-status)|pfsense
|
|
|
|
|
|7|[](https://github.com/acmesh-official/letest#here-are-the-latest-status)|openSUSE
|
|
|
|
|
|8|[](https://github.com/acmesh-official/letest#here-are-the-latest-status)|Alpine Linux (with curl)
|
|
|
|
|
|9|[](https://github.com/acmesh-official/letest#here-are-the-latest-status)|Archlinux
|
|
|
|
|
|10|[](https://github.com/acmesh-official/letest#here-are-the-latest-status)|fedora
|
|
|
|
|
|11|[](https://github.com/acmesh-official/letest#here-are-the-latest-status)|Kali Linux
|
|
|
|
|
|12|[](https://github.com/acmesh-official/letest#here-are-the-latest-status)|Oracle Linux
|
|
|
|
|
|13|[](https://github.com/acmesh-official/letest#here-are-the-latest-status)| Proxmox https://pve.proxmox.com/wiki/HTTPSCertificateConfiguration#Let.27s_Encrypt_using_acme.sh
|
|
|
|
|
|14|-----| Cloud Linux https://github.com/acmesh-official/acme.sh/issues/111
|
|
|
|
|
|15|[](https://github.com/acmesh-official/letest#here-are-the-latest-status)|OpenBSD
|
|
|
|
|
|16|[](https://github.com/acmesh-official/letest#here-are-the-latest-status)|Mageia
|
|
|
|
|
|17|-----| OpenWRT: Tested and working. See [wiki page](https://github.com/acmesh-official/acme.sh/wiki/How-to-run-on-OpenWRT)
|
|
|
|
|
|18|[](https://github.com/acmesh-official/letest#here-are-the-latest-status)|SunOS/Solaris
|
|
|
|
|
|19|[](https://github.com/acmesh-official/letest#here-are-the-latest-status)|Gentoo Linux
|
|
|
|
|
|20|[](https://travis-ci.org/Neilpang/acme.sh)|Mac OSX
|
|
|
|
|
|
|
|
|
|
For all build statuses, check our [weekly build project](https://github.com/Neilpang/acmetest):
|
|
|
|
|
For all build statuses, check our [weekly build project](https://github.com/acmesh-official/acmetest):
|
|
|
|
|
|
|
|
|
|
https://github.com/Neilpang/acmetest
|
|
|
|
|
https://github.com/acmesh-official/acmetest
|
|
|
|
|
|
|
|
|
|
# Supported CA
|
|
|
|
|
|
|
|
|
|
- Letsencrypt.org CA(default)
|
|
|
|
|
- [BuyPass.com CA](https://github.com/Neilpang/acme.sh/wiki/BuyPass.com-CA)
|
|
|
|
|
- [BuyPass.com CA](https://github.com/acmesh-official/acme.sh/wiki/BuyPass.com-CA)
|
|
|
|
|
- [Pebble strict Mode](https://github.com/letsencrypt/pebble)
|
|
|
|
|
|
|
|
|
|
# Supported modes
|
|
|
|
@@ -85,15 +85,15 @@ https://github.com/Neilpang/acmetest
|
|
|
|
|
- Apache mode
|
|
|
|
|
- Nginx mode
|
|
|
|
|
- DNS mode
|
|
|
|
|
- [DNS alias mode](https://github.com/Neilpang/acme.sh/wiki/DNS-alias-mode)
|
|
|
|
|
- [Stateless mode](https://github.com/Neilpang/acme.sh/wiki/Stateless-Mode)
|
|
|
|
|
- [DNS alias mode](https://github.com/acmesh-official/acme.sh/wiki/DNS-alias-mode)
|
|
|
|
|
- [Stateless mode](https://github.com/acmesh-official/acme.sh/wiki/Stateless-Mode)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
# 1. How to install
|
|
|
|
|
|
|
|
|
|
### 1. Install online
|
|
|
|
|
|
|
|
|
|
Check this project: https://github.com/Neilpang/get.acme.sh
|
|
|
|
|
Check this project: https://github.com/acmesh-official/get.acme.sh
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
curl https://get.acme.sh | sh
|
|
|
|
@@ -111,14 +111,14 @@ wget -O - https://get.acme.sh | sh
|
|
|
|
|
Clone this project and launch installation:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
git clone https://github.com/Neilpang/acme.sh.git
|
|
|
|
|
git clone https://github.com/acmesh-official/acme.sh.git
|
|
|
|
|
cd ./acme.sh
|
|
|
|
|
./acme.sh --install
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
You `don't have to be root` then, although `it is recommended`.
|
|
|
|
|
|
|
|
|
|
Advanced Installation: https://github.com/Neilpang/acme.sh/wiki/How-to-install
|
|
|
|
|
Advanced Installation: https://github.com/acmesh-official/acme.sh/wiki/How-to-install
|
|
|
|
|
|
|
|
|
|
The installer will perform 3 actions:
|
|
|
|
|
|
|
|
|
@@ -180,7 +180,7 @@ The certs will be placed in `~/.acme.sh/example.com/`
|
|
|
|
|
|
|
|
|
|
The certs will be renewed automatically every **60** days.
|
|
|
|
|
|
|
|
|
|
More examples: https://github.com/Neilpang/acme.sh/wiki/How-to-issue-a-cert
|
|
|
|
|
More examples: https://github.com/acmesh-official/acme.sh/wiki/How-to-issue-a-cert
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
# 3. Install the cert to Apache/Nginx etc.
|
|
|
|
@@ -226,7 +226,7 @@ Port `80` (TCP) **MUST** be free to listen on, otherwise you will be prompted to
|
|
|
|
|
acme.sh --issue --standalone -d example.com -d www.example.com -d cp.example.com
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
More examples: https://github.com/Neilpang/acme.sh/wiki/How-to-issue-a-cert
|
|
|
|
|
More examples: https://github.com/acmesh-official/acme.sh/wiki/How-to-issue-a-cert
|
|
|
|
|
|
|
|
|
|
# 5. Use Standalone ssl server to issue cert
|
|
|
|
|
|
|
|
|
@@ -238,7 +238,7 @@ Port `443` (TCP) **MUST** be free to listen on, otherwise you will be prompted t
|
|
|
|
|
acme.sh --issue --alpn -d example.com -d www.example.com -d cp.example.com
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
More examples: https://github.com/Neilpang/acme.sh/wiki/How-to-issue-a-cert
|
|
|
|
|
More examples: https://github.com/acmesh-official/acme.sh/wiki/How-to-issue-a-cert
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
# 6. Use Apache mode
|
|
|
|
@@ -259,7 +259,7 @@ acme.sh --issue --apache -d example.com -d www.example.com -d cp.example.com
|
|
|
|
|
You will need to configure your website config files to use the cert by yourself.
|
|
|
|
|
We don't want to mess your apache server, don't worry.**
|
|
|
|
|
|
|
|
|
|
More examples: https://github.com/Neilpang/acme.sh/wiki/How-to-issue-a-cert
|
|
|
|
|
More examples: https://github.com/acmesh-official/acme.sh/wiki/How-to-issue-a-cert
|
|
|
|
|
|
|
|
|
|
# 7. Use Nginx mode
|
|
|
|
|
|
|
|
|
@@ -283,7 +283,7 @@ acme.sh --issue --nginx -d example.com -d www.example.com -d cp.example.com
|
|
|
|
|
You will need to configure your website config files to use the cert by yourself.
|
|
|
|
|
We don't want to mess your nginx server, don't worry.**
|
|
|
|
|
|
|
|
|
|
More examples: https://github.com/Neilpang/acme.sh/wiki/How-to-issue-a-cert
|
|
|
|
|
More examples: https://github.com/acmesh-official/acme.sh/wiki/How-to-issue-a-cert
|
|
|
|
|
|
|
|
|
|
# 8. Automatic DNS API integration
|
|
|
|
|
|
|
|
|
@@ -293,11 +293,11 @@ You don't have to do anything manually!
|
|
|
|
|
|
|
|
|
|
### Currently acme.sh supports most of the dns providers:
|
|
|
|
|
|
|
|
|
|
https://github.com/Neilpang/acme.sh/wiki/dnsapi
|
|
|
|
|
https://github.com/acmesh-official/acme.sh/wiki/dnsapi
|
|
|
|
|
|
|
|
|
|
# 9. Use DNS manual mode:
|
|
|
|
|
|
|
|
|
|
See: https://github.com/Neilpang/acme.sh/wiki/dns-manual-mode first.
|
|
|
|
|
See: https://github.com/acmesh-official/acme.sh/wiki/dns-manual-mode first.
|
|
|
|
|
|
|
|
|
|
If your dns provider doesn't support any api access, you can add the txt record by your hand.
|
|
|
|
|
|
|
|
|
@@ -430,12 +430,12 @@ acme.sh --upgrade --auto-upgrade 0
|
|
|
|
|
|
|
|
|
|
# 15. Issue a cert from an existing CSR
|
|
|
|
|
|
|
|
|
|
https://github.com/Neilpang/acme.sh/wiki/Issue-a-cert-from-existing-CSR
|
|
|
|
|
https://github.com/acmesh-official/acme.sh/wiki/Issue-a-cert-from-existing-CSR
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
# 16. Send notifications in cronjob
|
|
|
|
|
|
|
|
|
|
https://github.com/Neilpang/acme.sh/wiki/notify
|
|
|
|
|
https://github.com/acmesh-official/acme.sh/wiki/notify
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
# 17. Under the Hood
|
|
|
|
@@ -456,7 +456,7 @@ TODO:
|
|
|
|
|
### Code Contributors
|
|
|
|
|
|
|
|
|
|
This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
|
|
|
|
|
<a href="https://github.com/Neilpang/acme.sh/graphs/contributors"><img src="https://opencollective.com/acmesh/contributors.svg?width=890&button=false" /></a>
|
|
|
|
|
<a href="https://github.com/acmesh-official/acme.sh/graphs/contributors"><img src="https://opencollective.com/acmesh/contributors.svg?width=890&button=false" /></a>
|
|
|
|
|
|
|
|
|
|
### Financial Contributors
|
|
|
|
|
|
|
|
|
@@ -487,7 +487,7 @@ License is GPLv3
|
|
|
|
|
|
|
|
|
|
Please Star and Fork me.
|
|
|
|
|
|
|
|
|
|
[Issues](https://github.com/Neilpang/acme.sh/issues) and [pull requests](https://github.com/Neilpang/acme.sh/pulls) are welcome.
|
|
|
|
|
[Issues](https://github.com/acmesh-official/acme.sh/issues) and [pull requests](https://github.com/acmesh-official/acme.sh/pulls) are welcome.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
# 20. Donate
|
|
|
|
@@ -495,4 +495,4 @@ Your donation makes **acme.sh** better:
|
|
|
|
|
|
|
|
|
|
1. PayPal/Alipay(支付宝)/Wechat(微信): [https://donate.acme.sh/](https://donate.acme.sh/)
|
|
|
|
|
|
|
|
|
|
[Donate List](https://github.com/Neilpang/acme.sh/wiki/Donate-list)
|
|
|
|
|
[Donate List](https://github.com/acmesh-official/acme.sh/wiki/Donate-list)
|
|
|
|
|