An ACME Shell script: acme.sh

An ACME protocol client written purely in Shell (Unix shell) language.
Full ACME protocol implementation.
Support ECDSA certs
Support SAN and wildcard certs
Simple, powerful and very easy to use. You only need 3 minutes to learn it.
Bash, dash and sh compatible.
Purely written in Shell with no dependencies on python.
Just one script to issue, renew and install your certificates automatically.
DOES NOT require root/sudoer access.
Docker ready
IPv6 ready
Cron job notifications for renewal or error etc.
A fork which doesn't target your Apache / Nginx configuration with intention to mess them completely up

It's probably the easiest & smartest shell script to automatically issue & renew the free certificates.

Wiki: https://github.com/acmesh-official/acme.sh/wiki

For Docker Fans: acme.sh 💕 Docker

Twitter: @neilpangxa

中文说明

Who:

FreeBSD.org
ruby-china.org
Proxmox
pfsense
webfaction
Loadbalancer.org
discourse.org
Centminmod
splynx
archlinux
opnsense.org
CentOS Web Panel
lnmp.org
more...

Tested OS

Check our testing project:

https://github.com/acmesh-official/acmetest

Supported CA

ZeroSSL.com CA(default)
Letsencrypt.org CA
BuyPass.com CA
SSL.com CA
Google.com Public CA
Pebble strict Mode
Any other RFC8555-compliant CA

Supported modes

Webroot mode
Standalone mode
Standalone tls-alpn mode
DNS mode
DNS alias mode
Stateless mode

1. How to install

1. Install online

curl https://raw.githubusercontent.com/HQJaTu/acme.sh/main/acme.sh | sh -s email=my@example.com

Or:

wget -O -  https://raw.githubusercontent.com/HQJaTu/acme.sh/main/acme.sh | sh -s email=my@example.com

2. Or, Install from git

Clone this project and launch installation:

git clone https://github.com/HQJaTu/acme.sh.git
cd ./acme.sh
./acme.sh --install -m my@example.com

You don't have to be root then, although it is recommended.

Advanced Installation: https://github.com/acmesh-official/acme.sh/wiki/How-to-install

The installer will perform 3 actions:

Create and copy acme.sh to your home dir ($HOME): ~/.acme.sh/. All certs will be placed in this folder too.
Create alias for: acme.sh=~/.acme.sh/acme.sh.
Create daily cron job to check and renew the certs if needed.

Cron entry example:

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:

root@v1:~# acme.sh -h

2. Just issue a cert

Example 1: Single domain.

acme.sh --issue -d example.com -w /home/wwwroot/example.com

or:

acme.sh --issue -d example.com -w /home/username/public_html

or:

acme.sh --issue -d example.com -w /var/www/html

Example 2: Multiple domains in the same cert.

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/acmesh-official/acme.sh/wiki/How-to-issue-a-cert

3. Install the cert to Apache/Nginx etc.

Not with this tool!

If you want a poorly written crappy tool to overwrite your precious configuration, use something else!

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.

acme.sh --issue --standalone -d example.com -d www.example.com -d cp.example.com

More examples: https://github.com/acmesh-official/acme.sh/wiki/How-to-issue-a-cert

5. Use Standalone ssl server to issue cert

(requires you to be root/sudoer or have permission to listen on port 443 (TCP))

Port 443 (TCP) MUST be free to listen on, otherwise you will be prompted to free it and try again.

acme.sh --issue --alpn -d example.com -d www.example.com -d cp.example.com

More examples: https://github.com/acmesh-official/acme.sh/wiki/How-to-issue-a-cert

8. Automatic DNS API integration

If your DNS provider supports API access, we can use that API to automatically issue the certs.

You don't have to do anything manually!

Currently acme.sh supports most of the dns providers:

https://github.com/acmesh-official/acme.sh/wiki/dnsapi

CloudFlare.com API
DNSPod.cn API
CloudXNS.com API
GoDaddy.com API
PowerDNS.com API
OVH, kimsufi, soyoustart and runabove API
nsupdate API
LuaDNS.com API
DNSMadeEasy.com API
AWS Route 53
aliyun.com(阿里云) API
ISPConfig 3.1 API
Alwaysdata.com API
Linode.com API
FreeDNS (https://freedns.afraid.org/)
cyon.ch
Domain-Offensive/Resellerinterface/Domainrobot API
Gandi LiveDNS API
Knot DNS API
DigitalOcean API (native)
ClouDNS.net API
Infoblox NIOS API (https://www.infoblox.com/)
VSCALE (https://vscale.io/)
Dynu API (https://www.dynu.com)
DNSimple API
NS1.com API
DuckDNS.org API
Name.com API
Dyn Managed DNS API
Yandex PDD API (https://pdd.yandex.ru)
Hurricane Electric DNS service (https://dns.he.net)
UnoEuro API (https://www.unoeuro.com/)
INWX (https://www.inwx.de/)
Servercow (https://servercow.de)
Namesilo (https://www.namesilo.com)
InternetX autoDNS API (https://internetx.com)
Azure DNS
selectel.com(selectel.ru) DNS API
zonomi.com DNS API
DreamHost.com API
DirectAdmin API
KingHost (https://www.kinghost.com.br/)
Zilore (https://zilore.com)
Loopia.se API
acme-dns (https://github.com/joohoi/acme-dns)
TELE3 (https://www.tele3.cz)
EUSERV.EU (https://www.euserv.eu)
DNSPod.com API (https://www.dnspod.com)
Google Cloud DNS API
ConoHa (https://www.conoha.jp)
netcup DNS API (https://www.netcup.de)
GratisDNS.dk (https://gratisdns.dk)
Namecheap API (https://www.namecheap.com/)
MyDNS.JP API (https://www.mydns.jp/)
hosting.de (https://www.hosting.de)
Neodigit.net API (https://www.neodigit.net)
Exoscale.com API (https://www.exoscale.com/)
PointDNS API (https://pointhq.com/)
Active24.cz API (https://www.active24.cz/)
do.de API (https://www.do.de/)
NederHost API (https://www.nederhost.nl/)
Nexcess API (https://www.nexcess.net)
Thermo.io API (https://www.thermo.io)
Futurehosting API (https://www.futurehosting.com)
Rackspace Cloud DNS (https://www.rackspace.com)
Online.net API (https://online.net/)
MyDevil.net (https://www.mydevil.net/)

And:

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.)

More APIs coming soon...

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 and contribute it to the project.

For more details: How to use DNS API

9. Use DNS manual mode:

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 hand.

acme.sh --issue --dns -d example.com -d www.example.com -d cp.example.com

You should get an output like below:

Add the following txt record:
Domain:_acme-challenge.example.com
Txt value:9ihDbjYfTExAYeDs4DBUeuTo18KBzwvTEjUnSwd32-c

Add the following txt record:
Domain:_acme-challenge.www.example.com
Txt value:9ihDbjxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Please add those txt records to the domains. Waiting for the dns to take effect.

Then just rerun with renew argument:

acme.sh --renew -d example.com

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.

Please use dns api mode instead.

10. Issue ECC certificates

Let's Encrypt can now issue ECDSA certificates.

And we support them too!

Just set the keylength parameter with a prefix ec-.

For example:

Single domain ECC certificate

acme.sh --issue -w /home/wwwroot/example.com -d example.com --keylength ec-256

SAN multi domain ECC certificate

acme.sh --issue -w /home/wwwroot/example.com -d example.com -d www.example.com --keylength ec-256

Please look at the keylength parameter above.

Valid values are:

ec-256 (prime256v1, "ECDSA P-256")
ec-384 (secp384r1, "ECDSA P-384")
ec-521 (secp521r1, "ECDSA P-521", which is not supported by Let's Encrypt yet.)

11. Issue Wildcard certificates

It's simple, just give a wildcard domain as the -d parameter.

acme.sh  --issue -d example.com  -d '*.example.com'  --dns dns_cf

12. 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.

However, you can also force to renew a cert:

acme.sh --renew -d example.com --force

or, for ECC cert:

acme.sh --renew -d example.com --force --ecc

13. How to stop cert renewal

To stop renewal of a cert, you can execute the following to remove the cert from the renewal list:

acme.sh --remove -d example.com [--ecc]

The cert/key file is not removed from the disk.

You can remove the respective directory (e.g. ~/.acme.sh/example.com) by yourself.

14. How to upgrade `acme.sh`

acme.sh is in constant development, so it's strongly recommended to use the latest code.

You can update acme.sh to the latest code:

acme.sh --upgrade

15. Issue a cert from an existing CSR

https://github.com/acmesh-official/acme.sh/wiki/Issue-a-cert-from-existing-CSR

16. Send notifications in cronjob

https://github.com/acmesh-official/acme.sh/wiki/notify

16. Send notifications in cronjob

https://github.com/Neilpang/acme.sh/wiki/notify

17. Under the Hood

Speak ACME language using shell, directly to "Let's Encrypt".

TODO:

18. Acknowledgments

Acme-tiny: https://github.com/diafygi/acme-tiny
ACME protocol: https://github.com/ietf-wg-acme/acme

19. License & Others

License is GPLv3

Please Star and Fork me.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

README.md

README.md

An ACME Shell script: acme.sh

中文说明

Who:

Tested OS

Supported CA

Supported modes

1. How to install

1. Install online

2. Or, Install from git

2. Just issue a cert

3. Install the cert to Apache/Nginx etc.

4. Use Standalone server to issue cert

5. Use Standalone ssl server to issue cert

8. Automatic DNS API integration

Currently acme.sh supports most of the dns providers:

9. Use DNS manual mode:

10. Issue ECC certificates

Single domain ECC certificate

SAN multi domain ECC certificate

11. Issue Wildcard certificates

12. How to renew the certs

13. How to stop cert renewal

14. How to upgrade `acme.sh`

15. Issue a cert from an existing CSR

16. Send notifications in cronjob

16. Send notifications in cronjob

17. Under the Hood

18. Acknowledgments

19. License & Others

Files

README.md

Latest commit

History

README.md

File metadata and controls

An ACME Shell script: acme.sh

中文说明

Who:

Tested OS

Supported CA

Supported modes

1. How to install

1. Install online

2. Or, Install from git

2. Just issue a cert

3. Install the cert to Apache/Nginx etc.

4. Use Standalone server to issue cert

5. Use Standalone ssl server to issue cert

8. Automatic DNS API integration

Currently acme.sh supports most of the dns providers:

9. Use DNS manual mode:

10. Issue ECC certificates

Single domain ECC certificate

SAN multi domain ECC certificate

11. Issue Wildcard certificates

12. How to renew the certs

13. How to stop cert renewal

14. How to upgrade acme.sh

15. Issue a cert from an existing CSR

16. Send notifications in cronjob

16. Send notifications in cronjob

17. Under the Hood

18. Acknowledgments

19. License & Others

14. How to upgrade `acme.sh`