# An ACME Shell script: acme.sh [](https://travis-ci.org/Neilpang/acme.sh)
[](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)
|4|[](https://github.com/Neilpang/letest#here-are-the-latest-status)|Windows (cygwin with curl, openssl and crontab included)
|8|[](https://github.com/Neilpang/letest#here-are-the-latest-status)|Alpine Linux (with curl)
|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
|19|[](https://github.com/Neilpang/letest#here-are-the-latest-status)|Gentoo Linux
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.
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.
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.
**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.**
# An ACME Shell script: acme.sh [](https://travis-ci.org/Neilpang/acme.sh)
More examples: https://github.com/Neilpang/acme.sh/wiki/How-to-issue-a-cert
2
# 6. Use Nginx mode
**(requires you to be root/sudoer, since it is required to interact with Nginx server)**
3
If you are running a web server, Apache or Nginx, it is recommended to use the `Webroot mode`.
<ahref="https://opencollective.com/acmesh"alt="Financial Contributors on Open Collective"><imgsrc="https://opencollective.com/acmesh/all/badge.svg?label=financial+contributors"/></a> [](https://gitter.im/acme-sh/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
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.
4
Just set string "nginx" as the second argument.
- An ACME protocol client written purely in Shell (Unix shell) language.
It will configure nginx server automatically to verify the domain and then restore the nginx config to the original version.
- Simplest shell script for Let's Encrypt free certificate client.
11
**More APIs coming soon...**
- Purely written in Shell with no dependencies on python or the official Let's Encrypt client.
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.
12
For more details: [How to use DNS API](dnsapi)
- Just one script to issue, renew and install your certificates automatically.
Please add those txt records to the domains. Waiting for the dns to take effect.
```
- Cron job notifications for renewal or error etc.
Then just rerun with `renew` argument:
17
```bash
acme.sh --renew -d example.com
```
Ok, it's done.
18
**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.**
It's probably the `easiest & smartest` shell script to automatically issue & renew the free certificates from Let's Encrypt.
**Please use dns api mode instead.**
19
# 9. Issue ECC certificates
`Let's Encrypt` can now issue **ECDSA** certificates.
20
And we support them too!
Wiki: https://github.com/Neilpang/acme.sh/wiki
Just set the `keylength` parameter with a prefix `ec-`.
stilez
5 years ago
committed by
GitHub