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.
11 It's probably the `easiest&smallest&smartest` shell script to automatically issue & renew the free certificates from Let's Encrypt.
14 Wiki: https://github.com/Neilpang/acme.sh/wiki
17 | NO | Status| Platform|
18 |----|-------|---------|
19 |1|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/ubuntu-latest.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)| Ubuntu
20 |2|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/debian-latest.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)| Debian
21 |3|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/centos-latest.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|CentOS
22 |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)
23 |5|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/freebsd.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|FreeBSD
24 |6|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/pfsense.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|pfsense
25 |7|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/opensuse-latest.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|openSUSE
26 |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)
27 |9|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/base-archlinux.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|Archlinux
28 |10|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/fedora-latest.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|fedora
29 |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
30 |12|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/oraclelinux-latest.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|Oracle Linux
31 |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
32 |14|-----| Cloud Linux https://github.com/Neilpang/le/issues/111
33 |15|[![](https://cdn.rawgit.com/Neilpang/acmetest/master/status/openbsd.svg)](https://github.com/Neilpang/letest#here-are-the-latest-status)|OpenBSD
35 For all build statuses, check our [daily build project](https://github.com/Neilpang/acmetest):
37 https://github.com/Neilpang/acmetest
46 # Upgrade from 1.x to 2.x
48 You can simply uninstall 1.x and re-install 2.x.
49 2.x is 100% compatible to 1.x. You will feel right at home as if nothing has changed.
51 # le.sh renamed to acme.sh NOW!
53 All configurations are 100% compatible between `le.sh` and `acme.sh`. You just need to uninstall `le.sh` and re-install `acme.sh` again.
54 Nothing will be broken during the process.
58 ### 1. Install online:
60 Check this project: https://github.com/Neilpang/get.acme.sh
63 curl https://get.acme.sh | sh
70 wget -O - https://get.acme.sh | sh
75 ### 2. Or, Install from git:
80 git clone https://github.com/Neilpang/acme.sh.git
85 You `don't have to be root` then, although `it is recommended`.
87 Advanced Installation: https://github.com/Neilpang/acme.sh/wiki/How-to-install
89 The installer will perform 3 actions:
91 1. Create and copy `acme.sh` to your home dir (`$HOME`): `~/.acme.sh/`.
92 All certs will be placed in this folder.
93 2. Create alias for: `acme.sh=~/.acme.sh/acme.sh`.
94 3. Create everyday cron job to check and renew the cert if needed.
99 0 0 * * * "/home/user/.acme.sh"/acme.sh --cron --home "/home/user/.acme.sh" > /dev/null
102 After the installation, you must close current terminal and reopen again to make the alias take effect.
104 Ok, you are ready to issue cert now.
109 https://github.com/Neilpang/acme.sh
111 Usage: acme.sh command ...[parameters]....
113 --help, -h Show this help message.
114 --version, -v Show version info.
115 --install Install acme.sh to your system.
116 --uninstall Uninstall acme.sh, and uninstall the cron job.
117 --issue Issue a cert.
118 --installcert Install the issued cert to apache/nginx or any other server.
119 --renew, -r Renew a cert.
120 --renewAll Renew all the certs
121 --revoke Revoke a cert.
122 --installcronjob Install the cron job to renew certs, you don't need to call this. The 'install' command can automatically install the cron job.
123 --uninstallcronjob Uninstall the cron job. The 'uninstall' command can do this automatically.
124 --cron Run cron job to renew all the certs.
125 --toPkcs Export the certificate and key to a pfx file.
126 --createAccountKey, -cak Create an account private key, professional use.
127 --createDomainKey, -cdk Create an domain private key, professional use.
128 --createCSR, -ccsr Create CSR , professional use.
131 --domain, -d domain.tld Specifies a domain, used to issue, renew or revoke etc.
132 --force, -f Used to force to install or force to renew a cert immediately.
133 --staging, --test Use staging server, just for test.
134 --debug Output debug info.
136 --webroot, -w /path/to/webroot Specifies the web root folder for web root mode.
137 --standalone Use standalone mode.
138 --apache Use apache mode.
139 --dns [dns-cf|dns-dp|dns-cx|/path/to/api/file] Use dns mode or dns api.
141 --keylength, -k [2048] Specifies the domain key length: 2048, 3072, 4096, 8192 or ec-256, ec-384.
142 --accountkeylength, -ak [2048] Specifies the account key length.
144 These parameters are to install the cert to nginx/apache or anyother server after issue/renew a cert:
146 --certpath /path/to/real/cert/file After issue/renew, the cert will be copied to this path.
147 --keypath /path/to/real/key/file After issue/renew, the key will be copied to this path.
148 --capath /path/to/real/ca/file After issue/renew, the intermediate cert will be copied to this path.
149 --fullchainpath /path/to/fullchain/file After issue/renew, the fullchain cert will be copied to this path.
151 --reloadcmd "service nginx reload" After issue/renew, it's used to reload the server.
153 --accountconf Specifies a customized account config file.
154 --home Specifies the home dir for acme.sh .
155 --certhome Specifies the home dir to save all the certs, only valid for '--install' command.
156 --useragent Specifies the user agent string. it will be saved for future use too.
157 --accountemail Specifies the account email for registering, Only valid for the '--install' command.
158 --accountkey Specifies the account key path, Only valid for the '--install' command.
159 --days Specifies the days to renew the cert when using '--issue' command. The max value is 80 days.
165 **Example 1:** Single domain.
168 acme.sh --issue -d aa.com -w /home/wwwroot/aa.com
171 **Example 2:** Multiple domains in the same cert.
174 acme.sh --issue -d aa.com -d www.aa.com -d cp.aa.com -w /home/wwwroot/aa.com
177 The parameter `/home/wwwroot/aa.com` is the web root folder. You **MUST** have `write access` to this folder.
179 Second argument **"aa.com"** is the main domain you want to issue cert for.
180 You must have at least a domain there.
182 You must point and bind all the domains to the same webroot dir: `/home/wwwroot/aa.com`.
184 Generate/issued certs will be placed in `~/.acme.sh/aa.com/`
186 The issued cert will be renewed every 80 days automatically.
188 More examples: https://github.com/Neilpang/acme.sh/wiki/How-to-issue-a-cert
191 # Install issued cert to apache/nginx etc.
193 After you issue a cert, you probably want to install the cert with your nginx/apache or other servers you may be using.
196 acme.sh --installcert -d aa.com \
197 --certpath /path/to/certfile/in/apache/nginx \
198 --keypath /path/to/keyfile/in/apache/nginx \
199 --capath /path/to/ca/certfile/apache/nginx \
200 --fullchainpath path/to/fullchain/certfile/apache/nginx \
201 --reloadcmd "service apache2|nginx reload"
204 Only the domain is required, all the other parameters are optional.
206 Install the issued cert/key to the production apache or nginx path.
208 The cert will be `renewed every 80 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`.
210 # Use Standalone server to issue cert
212 **(requires you be root/sudoer, or you have permission to listen tcp 80 port)**
214 The tcp `80` port **MUST** be free to listen, otherwise you will be prompted to free the `80` port and try again.
217 acme.sh --issue --standalone -d aa.com -d www.aa.com -d cp.aa.com
220 More examples: https://github.com/Neilpang/acme.sh/wiki/How-to-issue-a-cert
224 **(requires you be root/sudoer, since it is required to interact with apache server)**
226 If you are running a web server, apache or nginx, it is recommended to use the `Webroot mode`.
228 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.
230 Just set string "apache" as the second argument, it will force use of apache plugin automatically.
233 acme.sh --issue --apache -d aa.com -d www.aa.com -d user.aa.com
236 More examples: https://github.com/Neilpang/acme.sh/wiki/How-to-issue-a-cert
240 Support the `dns-01` challenge.
243 acme.sh --issue --dns -d aa.com -d www.aa.com -d user.aa.com
246 You should get the output like below:
249 Add the following txt record:
250 Domain:_acme-challenge.aa.com
251 Txt value:9ihDbjYfTExAYeDs4DBUeuTo18KBzwvTEjUnSwd32-c
253 Add the following txt record:
254 Domain:_acme-challenge.www.aa.com
255 Txt value:9ihDbjxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
257 Please add those txt records to the domains. Waiting for the dns to take effect.
261 Then just rerun with `renew` argument:
264 acme.sh --renew -d aa.com
269 # Automatic DNS API integration
271 If your DNS provider supports API access, we can use API to automatically issue the certs.
273 You don't have do anything manually!
275 ### Currently acme.sh supports:
277 1. Cloudflare.com API
280 4. AWS Route 53, see: https://github.com/Neilpang/acme.sh/issues/65
281 5. lexicon dns api: https://github.com/Neilpang/acme.sh/wiki/How-to-use-lexicon-dns-api
282 (DigitalOcean, DNSimple, DnsMadeEasy, DNSPark, EasyDNS, Namesilo, NS1, PointHQ, Rage4 and Vultr etc.)
284 ##### More APIs are coming soon...
286 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.
288 For more details: [How to use dns api](dnsapi)
290 # Issue ECC certificate:
292 `Let's Encrypt` now can issue **ECDSA** certificates.
294 And we also support it.
296 Just set the `length` parameter with a prefix `ec-`.
300 ### Single domain ECC cerfiticate:
303 acme.sh --issue -w /home/wwwroot/aa.com -d aa.com --keylength ec-256
306 SAN multi domain ECC certificate:
309 acme.sh --issue -w /home/wwwroot/aa.com -d aa.com -d www.aa.com --keylength ec-256
312 Please look at the last parameter above.
316 1. **ec-256 (prime256v1, "ECDSA P-256")**
317 2. **ec-384 (secp384r1, "ECDSA P-384")**
318 3. **ec-521 (secp521r1, "ECDSA P-521", which is not supported by Let's Encrypt yet.)**
322 Speak ACME language using shell, directly to "Let's Encrypt".
327 1. Acme-tiny: https://github.com/diafygi/acme-tiny
328 2. ACME protocol: https://github.com/ietf-wg-acme/acme
329 3. Certbot: https://github.com/certbot/certbot
335 Please Star and Fork me.
337 [Issues](https://github.com/Neilpang/acme.sh/issues) and [pull requests](https://github.com/Neilpang/acme.sh/pulls) are welcomed.