acme.sh/README.md

An ACME Shell script: acme.sh

• An ACME protocol client written purely in Shell (Unix shell) language.
• Fully ACME protocol implementation.
• Simple, powerful and very easy to use. You only need 3 minutes to learn.
• 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 Let's Encrypt official client.
• Just one script, to issue, renew and install your certificates automatically.
• DOES NOT require root/sudoer access.

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

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

中文说明

#Tested OS

NO	Status	Platform
1		Ubuntu
2		Debian
3		CentOS
4		Windows (cygwin with curl, openssl and crontab included)
5		FreeBSD
6		pfsense
7		openSUSE
8		Alpine Linux (with curl)
9		Archlinux
10		fedora
11		Kali Linux
12		Oracle Linux
13		Proxmox https://pve.proxmox.com/wiki/HTTPSCertificateConfiguration#Let.27s_Encrypt_using_acme.sh
14	-----	Cloud Linux https://github.com/Neilpang/le/issues/111
15		OpenBSD
16		Mageia
17	-----	OpenWRT: Tested and working. See wiki page
18		SunOS/Solaris
19		Gentoo Linux

For all build statuses, check our daily build project:

https://github.com/Neilpang/acmetest

Supported Mode

1. Webroot mode
2. Standalone mode
3. Apache mode
4. Dns mode

1. How to install

1. Install online:

Check this project: https://github.com/Neilpang/get.acme.sh

curl https://get.acme.sh | sh

Or:

wget -O -  https://get.acme.sh | sh

2. Or, Install from git:

Clone this project:

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.
2. Create alias for: acme.sh=~/.acme.sh/acme.sh.
3. Create everyday cron job to check and renew the cert 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 current terminal and reopen again to make the alias take effect.

Ok, you are ready to issue cert 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

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 is the web root folder. You MUST have write access to this folder.

Second argument "example.com" is the main domain you want to issue cert for. You must have at least a domain there.

You must point and bind all the domains to the same webroot dir: /home/wwwroot/example.com.

Generate/issued certs will be placed in ~/.acme.sh/example.com/

The issued cert will be renewed every 60 days automatically.

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

3. Install the issued cert to apache/nginx etc.

After you issue a cert, you probably want to install/copy the cert to your nginx/apache or other servers you may be using.

acme.sh --installcert -d example.com \
--certpath /path/to/certfile/in/apache/nginx  \
--keypath  /path/to/keyfile/in/apache/nginx  \
--capath   /path/to/ca/certfile/apache/nginx   \
--fullchainpath path/to/fullchain/certfile/apache/nginx \
--reloadcmd  "service apache2|nginx reload"

Only the domain is required, all the other parameters are optional.

Install/copy the issued 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 will be automatically reloaded by the command: service apache2 reload or service nginx reload.

4. Use Standalone server to issue cert

(requires you be root/sudoer, or you have permission to listen tcp 80 port)

The tcp 80 port MUST be free to listen, otherwise you will be prompted to free the 80 port and try again.

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 Standalone tls server to issue cert

(requires you be root/sudoer, or you have permission to listen tcp 443 port)

acme.sh supports tls-sni-01 validation.

The tcp 443 port MUST be free to listen, otherwise you will be prompted to free the 443 port and try again.

acme.sh --issue --tls -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

6. Use Apache mode

(requires you 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 should use apache mode instead. This mode doesn't write any files to your web root folder.

Just set string "apache" as the second argument, it will force use of apache plugin automatically.

acme.sh --issue --apache -d example.com -d www.example.com -d user.example.com

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

7. Use DNS mode:

Support the dns-01 challenge.

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

You should get the 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 finished.

8. Automatic DNS API integration

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

You don't have do anything manually!

Currently acme.sh supports:

1. Cloudflare.com API
2. Dnspod.cn API
3. Cloudxns.com API
4. Godaddy.com API
5. OVH, kimsufi, soyoustart and runabove API
6. AWS Route 53, see: https://github.com/Neilpang/acme.sh/issues/65
7. PowerDNS API
8. 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 are coming soon...

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

For more details: How to use dns api

9. Issue ECC certificate:

Let's Encrypt now can issue ECDSA certificates.

And we also support it.

Just set the length parameter with a prefix ec-.

For example:

Single domain ECC cerfiticate:

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 last parameter above.

Valid values are:

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

10. How to renew the cert

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 any cert:

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

or, for ECC cert:

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

11. How to upgrade acme.sh

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

You can update acme.sh to the latest code:

acme.sh --upgrade

You can enable auto upgrade:

acme.sh  --upgrade  --auto-upgrade

Then acme.sh will keep up to date automatically.

Disable auto upgrade:

acme.sh  --upgrade  --auto-upgrade 0

12. Issue a cert from an existing CSR

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

Under the Hood

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

TODO:

Acknowledgment

1. Acme-tiny: https://github.com/diafygi/acme-tiny
2. ACME protocol: https://github.com/ietf-wg-acme/acme
3. Certbot: https://github.com/certbot/certbot

License & Others

License is GPLv3

Please Star and Fork me.

Issues and pull requests are welcomed.

Donate

1. PayPal: donate@acme.sh

Donate List