stilez
5 years ago
committed by
GitHub
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 134 additions and 402 deletions
-
536README.md
@ -1,503 +1,235 @@ |
|||||
# 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) |
|
||||
|
|
||||
[![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) |
|
||||
- An ACME protocol client written purely in Shell (Unix shell) language. |
|
||||
- Full ACME protocol implementation. |
|
||||
- Support ACME v1 and ACME v2 |
|
||||
- Support ACME v2 wildcard certs |
|
||||
- Simple, powerful and very easy to use. You only need 3 minutes to learn it. |
|
||||
- Bash, dash and sh compatible. |
|
||||
- Simplest shell script for Let's Encrypt free certificate client. |
|
||||
- Purely written in Shell with no dependencies on python or the official Let's Encrypt client. |
|
||||
- Just one script to issue, renew and install your certificates automatically. |
|
||||
- DOES NOT require `root/sudoer` access. |
|
||||
- Docker friendly |
|
||||
- IPv6 support |
|
||||
|
|
||||
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 |
|
||||
|
|
||||
For Docker Fans: [acme.sh :two_hearts: Docker ](https://github.com/Neilpang/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) |
|
||||
|
|
||||
# Who: |
|
||||
- [FreeBSD.org](https://blog.crashed.org/letsencrypt-in-freebsd-org/) |
|
||||
- [ruby-china.org](https://ruby-china.org/topics/31983) |
|
||||
- [Proxmox](https://pve.proxmox.com/wiki/HTTPS_Certificate_Configuration_(Version_4.x_and_newer)) |
|
||||
- [pfsense](https://github.com/pfsense/FreeBSD-ports/pull/89) |
|
||||
- [webfaction](https://community.webfaction.com/questions/19988/using-letsencrypt) |
|
||||
- [Loadbalancer.org](https://www.loadbalancer.org/blog/loadbalancer-org-with-lets-encrypt-quick-and-dirty) |
|
||||
- [discourse.org](https://meta.discourse.org/t/setting-up-lets-encrypt/40709) |
|
||||
- [Centminmod](https://centminmod.com/letsencrypt-acmetool-https.html) |
|
||||
- [splynx](https://forum.splynx.com/t/free-ssl-cert-for-splynx-lets-encrypt/297) |
|
||||
- [archlinux](https://aur.archlinux.org/packages/acme.sh-git/) |
|
||||
- [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) |
|
||||
|
|
||||
# Tested OS |
|
||||
|
|
||||
| NO | Status| Platform| |
|
||||
|----|-------|---------| |
|
||||
|1|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/ubuntu-latest.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)| Ubuntu |
|
||||
|2|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/debian-latest.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)| Debian |
|
||||
|3|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/centos-latest.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|CentOS |
|
||||
|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) |
|
||||
|5|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/freebsd.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|FreeBSD |
|
||||
|6|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/pfsense.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|pfsense |
|
||||
|7|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/opensuse-latest.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|openSUSE |
|
||||
|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) |
|
||||
|9|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/base-archlinux.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|Archlinux |
|
||||
|10|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/fedora-latest.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|fedora |
|
||||
|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 |
|
||||
|12|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/oraclelinux-latest.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|Oracle Linux |
|
||||
|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 |
|
||||
|14|-----| Cloud Linux https://github.com/Neilpang/le/issues/111 |
|
||||
|15|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/openbsd.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|OpenBSD |
|
||||
|16|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/mageia.svg)](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://cdn.rawgit.com/Neilpang/acmetest/master/status/solaris.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|SunOS/Solaris |
|
||||
|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 |
|
||||
|20|[![Build Status](https://travis-ci.org/Neilpang/acme.sh.svg?branch=master)](https://travis-ci.org/Neilpang/acme.sh)|Mac OSX |
|
||||
|
|
||||
For all build statuses, check our [weekly build project](https://github.com/Neilpang/acmetest): |
|
||||
|
|
||||
https://github.com/Neilpang/acmetest |
|
||||
|
|
||||
|
|
||||
# Supported modes |
|
||||
|
|
||||
- Webroot mode |
|
||||
- Standalone mode |
|
||||
- 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) |
|
||||
|
|
||||
|
|
||||
# 1. How to install |
|
||||
|
|
||||
### 1. Install online |
|
||||
|
|
||||
Check this project: https://github.com/Neilpang/get.acme.sh |
|
||||
|
|
||||
```bash |
|
||||
curl https://get.acme.sh | sh |
|
||||
``` |
|
||||
|
|
||||
Or: |
|
||||
|
|
||||
```bash |
|
||||
wget -O - https://get.acme.sh | sh |
|
||||
``` |
|
||||
|
|
||||
|
|
||||
### 2. Or, Install from git |
|
||||
|
|
||||
Clone this project and launch installation: |
|
||||
|
|
||||
```bash |
|
||||
git clone https://github.com/Neilpang/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 |
|
||||
|
|
||||
The installer will perform 3 actions: |
|
||||
|
|
||||
1. Create and copy `acme.sh` to your home dir (`$HOME`): `~/.acme.sh/`. |
|
||||
All certs will be placed in this folder too. |
|
||||
2. Create alias for: `acme.sh=~/.acme.sh/acme.sh`. |
|
||||
3. Create daily cron job to check and renew the certs if needed. |
|
||||
|
|
||||
Cron entry example: |
|
||||
|
|
||||
```bash |
|
||||
0 0 * * * "/home/user/.acme.sh"/acme.sh --cron --home "/home/user/.acme.sh" > /dev/null |
|
||||
``` |
|
||||
|
|
||||
After the installation, you must close the current terminal and reopen it to make the alias take effect. |
|
||||
|
|
||||
Ok, you are ready to issue certs now. |
|
||||
|
|
||||
Show help message: |
|
||||
|
|
||||
```sh |
|
||||
root@v1:~# acme.sh -h |
|
||||
``` |
|
||||
|
Skip to content |
||||
|
Pull requests |
||||
|
Issues |
||||
|
Marketplace |
||||
|
Explore |
||||
|
@stilez |
||||
|
Learn Git and GitHub without any code! |
||||
|
|
||||
# 2. Just issue a cert |
|
||||
|
Using the Hello World guide, you’ll start a branch, write comments, and open a pull request. |
||||
|
|
||||
**Example 1:** Single domain. |
|
||||
|
395 |
||||
|
14.7k |
||||
|
|
||||
```bash |
|
||||
acme.sh --issue -d example.com -w /home/wwwroot/example.com |
|
||||
``` |
|
||||
|
1.9k |
||||
|
|
||||
or: |
|
||||
|
Neilpang/acme.sh |
||||
|
Code |
||||
|
Issues 415 |
||||
|
Pull requests 110 |
||||
|
Actions |
||||
|
Projects 0 |
||||
|
Wiki |
||||
|
Security |
||||
|
Insights |
||||
|
You’re editing a file in a project you don’t have write access to. Submitting a change to this file will write it to a new branch in your fork stilez/acme.sh, so you can send a pull request. |
||||
|
acme.sh/ |
||||
|
|
||||
```bash |
|
||||
acme.sh --issue -d example.com -w /home/username/public_html |
|
||||
``` |
|
||||
|
1 |
||||
|
|
||||
or: |
|
||||
|
|
||||
```bash |
|
||||
acme.sh --issue -d example.com -w /var/www/html |
|
||||
``` |
|
||||
|
|
||||
**Example 2:** Multiple domains in the same cert. |
|
||||
|
|
||||
```bash |
|
||||
acme.sh --issue -d example.com -d www.example.com -d cp.example.com -w /home/wwwroot/example.com |
|
||||
``` |
|
||||
|
|
||||
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. |
|
||||
|
|
||||
Second argument **"example.com"** is the main domain you want to issue the cert for. |
|
||||
You must have at least one domain there. |
|
||||
|
|
||||
You must point and bind all the domains to the same webroot dir: `/home/wwwroot/example.com`. |
|
||||
|
|
||||
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 |
|
||||
|
|
||||
|
|
||||
# 3. Install the cert to Apache/Nginx etc. |
|
||||
|
|
||||
After the cert is generated, you probably want to install/copy the cert to your Apache/Nginx or other servers. |
|
||||
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. |
|
||||
|
|
||||
**Apache** example: |
|
||||
```bash |
|
||||
acme.sh --install-cert -d example.com \ |
|
||||
--cert-file /path/to/certfile/in/apache/cert.pem \ |
|
||||
--key-file /path/to/keyfile/in/apache/key.pem \ |
|
||||
--fullchain-file /path/to/fullchain/certfile/apache/fullchain.pem \ |
|
||||
--reloadcmd "service apache2 force-reload" |
|
||||
``` |
|
||||
|
|
||||
**Nginx** example: |
|
||||
```bash |
|
||||
acme.sh --install-cert -d example.com \ |
|
||||
--key-file /path/to/keyfile/in/nginx/key.pem \ |
|
||||
--fullchain-file /path/to/fullchain/nginx/cert.pem \ |
|
||||
--reloadcmd "service nginx force-reload" |
|
||||
``` |
|
||||
|
|
||||
Only the domain is required, all the other parameters are optional. |
|
||||
|
|
||||
The ownership and permission info of existing files are preserved. You can pre-create the files to define the ownership and permission. |
|
||||
|
|
||||
Install/copy the cert/key to the production Apache or Nginx path. |
|
||||
|
|
||||
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`. |
|
||||
|
|
||||
|
|
||||
**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.** |
|
||||
|
|
||||
# 4. Use Standalone server to issue cert |
|
||||
|
|
||||
**(requires you to be root/sudoer or have permission to listen on port 80 (TCP))** |
|
||||
|
|
||||
Port `80` (TCP) **MUST** be free to listen on, otherwise you will be prompted to free it and try again. |
|
||||
|
|
||||
```bash |
|
||||
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 |
|
||||
|
|
||||
|
|
||||
# 5. Use Apache mode |
|
||||
|
|
||||
**(requires you to be root/sudoer, since it is required to interact with Apache server)** |
|
||||
|
|
||||
If you are running a web server, Apache or Nginx, it is recommended to use the `Webroot mode`. |
|
||||
|
|
||||
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. |
|
||||
|
|
||||
Just set string "apache" as the second argument and it will force use of apache plugin automatically. |
|
||||
|
|
||||
```sh |
|
||||
acme.sh --issue --apache -d example.com -d www.example.com -d cp.example.com |
|
||||
``` |
|
||||
|
|
||||
**This apache mode is only to issue the cert, it will not change your apache config files. |
|
||||
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 |
|
||||
|
# 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) |
||||
|
|
||||
# 6. Use Nginx mode |
|
||||
|
2 |
||||
|
|
||||
**(requires you to be root/sudoer, since it is required to interact with Nginx server)** |
|
||||
|
|
||||
|
|
||||
If you are running a web server, Apache or Nginx, it is recommended to use the `Webroot mode`. |
|
||||
|
3 |
||||
|
|
||||
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. |
|
||||
|
<a href="https://opencollective.com/acmesh" alt="Financial Contributors on Open Collective"><img src="https://opencollective.com/acmesh/all/badge.svg?label=financial+contributors" /></a> [![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) |
||||
|
|
||||
Just set string "nginx" as the second argument. |
|
||||
|
4 |
||||
|
|
||||
It will configure nginx server automatically to verify the domain and then restore the nginx config to the original version. |
|
||||
|
- An ACME protocol client written purely in Shell (Unix shell) language. |
||||
|
|
||||
So, the config is not changed. |
|
||||
|
5 |
||||
|
|
||||
```sh |
|
||||
acme.sh --issue --nginx -d example.com -d www.example.com -d cp.example.com |
|
||||
``` |
|
||||
|
- Full ACME protocol implementation. |
||||
|
|
||||
**This nginx mode is only to issue the cert, it will not change your nginx config files. |
|
||||
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.** |
|
||||
|
6 |
||||
|
|
||||
More examples: https://github.com/Neilpang/acme.sh/wiki/How-to-issue-a-cert |
|
||||
|
- Support ACME v1 and ACME v2 |
||||
|
|
||||
# 7. Automatic DNS API integration |
|
||||
|
7 |
||||
|
|
||||
If your DNS provider supports API access, we can use that API to automatically issue the certs. |
|
||||
|
- Support ACME v2 wildcard certs |
||||
|
|
||||
You don't have to do anything manually! |
|
||||
|
8 |
||||
|
|
||||
### Currently acme.sh supports: |
|
||||
|
- Simple, powerful and very easy to use. You only need 3 minutes to learn it. |
||||
|
|
||||
1. CloudFlare.com API |
|
||||
1. DNSPod.cn API |
|
||||
1. CloudXNS.com API |
|
||||
1. GoDaddy.com API |
|
||||
1. PowerDNS.com API |
|
||||
1. OVH, kimsufi, soyoustart and runabove API |
|
||||
1. nsupdate API |
|
||||
1. LuaDNS.com API |
|
||||
1. DNSMadeEasy.com API |
|
||||
1. AWS Route 53 |
|
||||
1. aliyun.com(阿里云) API |
|
||||
1. ISPConfig 3.1 API |
|
||||
1. Alwaysdata.com API |
|
||||
1. Linode.com API |
|
||||
1. FreeDNS (https://freedns.afraid.org/) |
|
||||
1. cyon.ch |
|
||||
1. Domain-Offensive/Resellerinterface/Domainrobot API |
|
||||
1. Gandi LiveDNS API |
|
||||
1. Knot DNS API |
|
||||
1. DigitalOcean API (native) |
|
||||
1. ClouDNS.net API |
|
||||
1. Infoblox NIOS API (https://www.infoblox.com/) |
|
||||
1. VSCALE (https://vscale.io/) |
|
||||
1. Dynu API (https://www.dynu.com) |
|
||||
1. DNSimple API |
|
||||
1. NS1.com API |
|
||||
1. DuckDNS.org API |
|
||||
1. Name.com API |
|
||||
1. Dyn Managed DNS API |
|
||||
1. Yandex PDD API (https://pdd.yandex.ru) |
|
||||
1. Hurricane Electric DNS service (https://dns.he.net) |
|
||||
1. UnoEuro API (https://www.unoeuro.com/) |
|
||||
1. INWX (https://www.inwx.de/) |
|
||||
1. Servercow (https://servercow.de) |
|
||||
1. Namesilo (https://www.namesilo.com) |
|
||||
1. InternetX autoDNS API (https://internetx.com) |
|
||||
1. Azure DNS |
|
||||
1. selectel.com(selectel.ru) DNS API |
|
||||
1. zonomi.com DNS API |
|
||||
1. DreamHost.com API |
|
||||
1. DirectAdmin API |
|
||||
1. KingHost (https://www.kinghost.com.br/) |
|
||||
1. Zilore (https://zilore.com) |
|
||||
1. Loopia.se API |
|
||||
1. acme-dns (https://github.com/joohoi/acme-dns) |
|
||||
1. TELE3 (https://www.tele3.cz) |
|
||||
1. EUSERV.EU (https://www.euserv.eu) |
|
||||
1. Plesk XML API (https://www.plesk.com) |
|
||||
|
9 |
||||
|
|
||||
And: |
|
||||
|
- Bash, dash and sh compatible. |
||||
|
|
||||
**lexicon DNS API: https://github.com/Neilpang/acme.sh/wiki/How-to-use-lexicon-dns-api |
|
||||
(DigitalOcean, DNSimple, DNSMadeEasy, DNSPark, EasyDNS, Namesilo, NS1, PointHQ, Rage4 and Vultr etc.)** |
|
||||
|
10 |
||||
|
|
||||
|
- Simplest shell script for Let's Encrypt free certificate client. |
||||
|
|
||||
**More APIs coming soon...** |
|
||||
|
11 |
||||
|
|
||||
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. |
|
||||
|
- Purely written in Shell with no dependencies on python or the official Let's Encrypt client. |
||||
|
|
||||
For more details: [How to use DNS API](dnsapi) |
|
||||
|
12 |
||||
|
|
||||
# 8. Use DNS manual mode: |
|
||||
|
- Just one script to issue, renew and install your certificates automatically. |
||||
|
|
||||
See: https://github.com/Neilpang/acme.sh/wiki/dns-manual-mode first. |
|
||||
|
13 |
||||
|
|
||||
If your dns provider doesn't support any api access, you can add the txt record by your hand. |
|
||||
|
- DOES NOT require `root/sudoer` access. |
||||
|
|
||||
```bash |
|
||||
acme.sh --issue --dns -d example.com -d www.example.com -d cp.example.com |
|
||||
``` |
|
||||
|
14 |
||||
|
|
||||
You should get an output like below: |
|
||||
|
- Docker friendly |
||||
|
|
||||
```sh |
|
||||
Add the following txt record: |
|
||||
Domain:_acme-challenge.example.com |
|
||||
Txt value:9ihDbjYfTExAYeDs4DBUeuTo18KBzwvTEjUnSwd32-c |
|
||||
|
15 |
||||
|
|
||||
Add the following txt record: |
|
||||
Domain:_acme-challenge.www.example.com |
|
||||
Txt value:9ihDbjxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx |
|
||||
|
- IPv6 support |
||||
|
|
||||
Please add those txt records to the domains. Waiting for the dns to take effect. |
|
||||
``` |
|
||||
|
16 |
||||
|
|
||||
Then just rerun with `renew` argument: |
|
||||
|
- Cron job notifications for renewal or error etc. |
||||
|
|
||||
```bash |
|
||||
acme.sh --renew -d example.com |
|
||||
``` |
|
||||
|
17 |
||||
|
|
||||
Ok, it's done. |
|
||||
|
|
||||
|
|
||||
**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.** |
|
||||
|
18 |
||||
|
|
||||
**Please use dns api mode instead.** |
|
||||
|
It's probably the `easiest & smartest` shell script to automatically issue & renew the free certificates from Let's Encrypt. |
||||
|
|
||||
# 9. Issue ECC certificates |
|
||||
|
19 |
||||
|
|
||||
`Let's Encrypt` can now issue **ECDSA** certificates. |
|
||||
|
|
||||
|
|
||||
And we support them too! |
|
||||
|
20 |
||||
|
|
||||
Just set the `keylength` parameter with a prefix `ec-`. |
|
||||
|
Wiki: https://github.com/Neilpang/acme.sh/wiki |
||||
|
|
||||
For example: |
|
||||
|
21 |
||||
|
|
||||
### Single domain ECC certificate |
|
||||
|
|
||||
|
|
||||
```bash |
|
||||
acme.sh --issue -w /home/wwwroot/example.com -d example.com --keylength ec-256 |
|
||||
``` |
|
||||
|
22 |
||||
|
|
||||
### SAN multi domain ECC certificate |
|
||||
|
For Docker Fans: [acme.sh :two_hearts: Docker ](https://github.com/Neilpang/acme.sh/wiki/Run-acme.sh-in-docker) |
||||
|
|
||||
```bash |
|
||||
acme.sh --issue -w /home/wwwroot/example.com -d example.com -d www.example.com --keylength ec-256 |
|
||||
``` |
|
||||
|
23 |
||||
|
|
||||
Please look at the `keylength` parameter above. |
|
||||
|
|
||||
|
|
||||
Valid values are: |
|
||||
|
24 |
||||
|
|
||||
1. **ec-256 (prime256v1, "ECDSA P-256")** |
|
||||
2. **ec-384 (secp384r1, "ECDSA P-384")** |
|
||||
3. **ec-521 (secp521r1, "ECDSA P-521", which is not supported by Let's Encrypt yet.)** |
|
||||
|
Twitter: [@neilpangxa](https://twitter.com/neilpangxa) |
||||
|
|
||||
|
25 |
||||
|
|
||||
|
|
||||
|
|
||||
# 10. Issue Wildcard certificates |
|
||||
|
26 |
||||
|
|
||||
It's simple, just give a wildcard domain as the `-d` parameter. |
|
||||
|
|
||||
|
|
||||
```sh |
|
||||
acme.sh --issue -d example.com -d '*.example.com' --dns dns_cf |
|
||||
``` |
|
||||
|
27 |
||||
|
|
||||
|
# [中文说明](https://github.com/Neilpang/acme.sh/wiki/%E8%AF%B4%E6%98%8E) |
||||
|
|
||||
|
28 |
||||
|
|
||||
# 11. How to renew the certs |
|
||||
|
|
||||
|
|
||||
No, you don't need to renew the certs manually. All the certs will be renewed automatically every **60** days. |
|
||||
|
29 |
||||
|
|
||||
However, you can also force to renew a cert: |
|
||||
|
# Who: |
||||
|
|
||||
```sh |
|
||||
acme.sh --renew -d example.com --force |
|
||||
``` |
|
||||
|
30 |
||||
|
|
||||
or, for ECC cert: |
|
||||
|
- [FreeBSD.org](https://blog.crashed.org/letsencrypt-in-freebsd-org/) |
||||
|
|
||||
```sh |
|
||||
acme.sh --renew -d example.com --force --ecc |
|
||||
``` |
|
||||
|
31 |
||||
|
|
||||
|
- [ruby-china.org](https://ruby-china.org/topics/31983) |
||||
|
|
||||
# 12. How to stop cert renewal |
|
||||
|
32 |
||||
|
|
||||
To stop renewal of a cert, you can execute the following to remove the cert from the renewal list: |
|
||||
|
- [Proxmox](https://pve.proxmox.com/wiki/HTTPS_Certificate_Configuration_(Version_4.x_and_newer)) |
||||
|
|
||||
```sh |
|
||||
acme.sh --remove -d example.com [--ecc] |
|
||||
``` |
|
||||
|
33 |
||||
|
|
||||
The cert/key file is not removed from the disk. |
|
||||
|
- [pfsense](https://github.com/pfsense/FreeBSD-ports/pull/89) |
||||
|
|
||||
You can remove the respective directory (e.g. `~/.acme.sh/example.com`) by yourself. |
|
||||
|
34 |
||||
|
|
||||
|
- [webfaction](https://community.webfaction.com/questions/19988/using-letsencrypt) |
||||
|
|
||||
# 13. How to upgrade `acme.sh` |
|
||||
|
35 |
||||
|
|
||||
acme.sh is in constant development, so it's strongly recommended to use the latest code. |
|
||||
|
- [Loadbalancer.org](https://www.loadbalancer.org/blog/loadbalancer-org-with-lets-encrypt-quick-and-dirty) |
||||
|
|
||||
You can update acme.sh to the latest code: |
|
||||
|
36 |
||||
|
|
||||
```sh |
|
||||
acme.sh --upgrade |
|
||||
``` |
|
||||
|
- [discourse.org](https://meta.discourse.org/t/setting-up-lets-encrypt/40709) |
||||
|
|
||||
You can also enable auto upgrade: |
|
||||
|
37 |
||||
|
|
||||
```sh |
|
||||
acme.sh --upgrade --auto-upgrade |
|
||||
``` |
|
||||
|
- [Centminmod](https://centminmod.com/letsencrypt-acmetool-https.html) |
||||
|
|
||||
Then **acme.sh** will be kept up to date automatically. |
|
||||
|
38 |
||||
|
|
||||
Disable auto upgrade: |
|
||||
|
- [splynx](https://forum.splynx.com/t/free-ssl-cert-for-splynx-lets-encrypt/297) |
||||
|
|
||||
```sh |
|
||||
acme.sh --upgrade --auto-upgrade 0 |
|
||||
``` |
|
||||
|
39 |
||||
|
|
||||
|
- [archlinux](https://www.archlinux.org/packages/community/any/acme.sh) |
||||
|
|
||||
# 14. Issue a cert from an existing CSR |
|
||||
|
40 |
||||
|
|
||||
https://github.com/Neilpang/acme.sh/wiki/Issue-a-cert-from-existing-CSR |
|
||||
|
- [opnsense.org](https://github.com/opnsense/plugins/tree/master/security/acme-client/src/opnsense/scripts/OPNsense/AcmeClient) |
||||
|
|
||||
|
41 |
||||
|
|
||||
# 15. Under the Hood |
|
||||
|
- [CentOS Web Panel](http://centos-webpanel.com/) |
||||
|
|
||||
Speak ACME language using shell, directly to "Let's Encrypt". |
|
||||
|
42 |
||||
|
|
||||
TODO: |
|
||||
|
- [lnmp.org](https://lnmp.org/) |
||||
|
|
||||
|
43 |
||||
|
|
||||
# 16. Acknowledgments |
|
||||
|
- [more...](https://github.com/Neilpang/acme.sh/wiki/Blogs-and-tutorials) |
||||
|
|
||||
1. Acme-tiny: https://github.com/diafygi/acme-tiny |
|
||||
2. ACME protocol: https://github.com/ietf-wg-acme/acme |
|
||||
|
44 |
||||
|
|
||||
|
|
||||
|
|
||||
# 17. License & Others |
|
||||
|
45 |
||||
|
|
||||
License is GPLv3 |
|
||||
|
# Tested OS |
||||
|
|
||||
Please Star and Fork me. |
|
||||
|
46 |
||||
|
|
||||
[Issues](https://github.com/Neilpang/acme.sh/issues) and [pull requests](https://github.com/Neilpang/acme.sh/pulls) are welcome. |
|
||||
|
|
||||
|
|
||||
|
47 |
||||
|
|
||||
# 18. Donate |
|
||||
Your donation makes **acme.sh** better: |
|
||||
|
| NO | Status| Platform| |
||||
|
|
||||
1. PayPal/Alipay(支付宝)/Wechat(微信): [https://donate.acme.sh/](https://donate.acme.sh/) |
|
||||
|
@stilez |
||||
|
Propose file change |
||||
|
Commit summary |
||||
|
Optional extended description |
||||
|
|
||||
|
© 2019 GitHub, Inc. |
||||
|
Terms |
||||
|
Privacy |
||||
|
Security |
||||
|
Status |
||||
|
Help |
||||
|
|
||||
|
Contact GitHub |
||||
|
Pricing |
||||
|
API |
||||
|
Training |
||||
|
Blog |
||||
|
About |
||||
|
|
||||
[Donate List](https://github.com/Neilpang/acme.sh/wiki/Donate-list) |
|
Write
Preview
Loading…
Cancel
Save
Reference in new issue