๐ Wiki โข ๐ณ Docker Guide โข ๐ฆ Twitter
--- ## ๐ [ไธญๆ่ฏดๆ](https://github.com/acmesh-official/acme.sh/wiki/%E8%AF%B4%E6%98%8E) --- ## ๐ Who Uses acme.sh? - [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/Certificate_Management) - [pfsense](https://github.com/pfsense/FreeBSD-ports/pull/89) - [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) - [opnsense.org](https://github.com/opnsense/plugins/tree/master/security/acme-client/src/opnsense/scripts/OPNsense/AcmeClient) - [CentOS Web Panel](https://control-webpanel.com) - [lnmp.org](https://lnmp.org/) - [more...](https://github.com/acmesh-official/acme.sh/wiki/Blogs-and-tutorials) --- ## ๐ฅ๏ธ Tested OS | NO | Status| Platform| |----|-------|---------| |1|[](https://github.com/acmesh-official/acme.sh/actions/workflows/MacOS.yml)|Mac OSX |2|[](https://github.com/acmesh-official/acme.sh/actions/workflows/Windows.yml)|Windows (cygwin with curl, openssl and crontab included) |3|[](https://github.com/acmesh-official/acme.sh/actions/workflows/FreeBSD.yml)|FreeBSD |4|[](https://github.com/acmesh-official/acme.sh/actions/workflows/Solaris.yml)|Solaris |5|[](https://github.com/acmesh-official/acme.sh/actions/workflows/Ubuntu.yml)| Ubuntu |6|NA|pfsense |7|[](https://github.com/acmesh-official/acme.sh/actions/workflows/OpenBSD.yml)|OpenBSD |8|[](https://github.com/acmesh-official/acme.sh/actions/workflows/NetBSD.yml)|NetBSD |9|[](https://github.com/acmesh-official/acme.sh/actions/workflows/DragonFlyBSD.yml)|DragonFlyBSD |10|[](https://github.com/acmesh-official/acme.sh/actions/workflows/Omnios.yml)|Omnios |11|[](https://github.com/acmesh-official/acme.sh/actions/workflows/OpenIndiana.yml)|OpenIndiana |12|[](https://github.com/acmesh-official/acme.sh/actions/workflows/Linux.yml)| Debian |13|[](https://github.com/acmesh-official/acme.sh/actions/workflows/Linux.yml)|openSUSE |14|[](https://github.com/acmesh-official/acme.sh/actions/workflows/Linux.yml)|Alpine Linux (with curl) |15|[](https://github.com/acmesh-official/acme.sh/actions/workflows/Linux.yml)|Archlinux |16|[](https://github.com/acmesh-official/acme.sh/actions/workflows/Linux.yml)|fedora |17|[](https://github.com/acmesh-official/acme.sh/actions/workflows/Linux.yml)|Kali Linux |18|[](https://github.com/acmesh-official/acme.sh/actions/workflows/Linux.yml)|Oracle Linux |19|[](https://github.com/acmesh-official/acme.sh/actions/workflows/Linux.yml)|Mageia |20|[](https://github.com/acmesh-official/acme.sh/actions/workflows/Linux.yml)|Gentoo Linux |21|-----| Cloud Linux https://github.com/acmesh-official/acme.sh/issues/111 |22|-----| OpenWRT: Tested and working. See [wiki page](https://github.com/acmesh-official/acme.sh/wiki/How-to-run-on-OpenWRT) |23|[](https://github.com/acmesh-official/letest#here-are-the-latest-status)| Proxmox: See Proxmox VE Wiki. Version [4.x, 5.0, 5.1](https://pve.proxmox.com/wiki/HTTPS_Certificate_Configuration_(Version_4.x,_5.0_and_5.1)#Let.27s_Encrypt_using_acme.sh), version [5.2 and up](https://pve.proxmox.com/wiki/Certificate_Management) > ๐งช Check our [testing project](https://github.com/acmesh-official/acmetest) > > ๐ฅ๏ธ The testing VMs are supported by [vmactions.org](https://vmactions.org) --- ## ๐๏ธ Supported CA | CA | Status | |---|---| | [ZeroSSL.com CA](https://github.com/acmesh-official/acme.sh/wiki/ZeroSSL.com-CA) | โญ **Default** | | Letsencrypt.org CA | โ Supported | | [SSL.com CA](https://github.com/acmesh-official/acme.sh/wiki/SSL.com-CA) | โ Supported | | [Google.com Public CA](https://github.com/acmesh-official/acme.sh/wiki/Google-Public-CA) | โ Supported | | [Actalis.com CA](https://github.com/acmesh-official/acme.sh/wiki/Actalis.com-CA) | โ Supported | | [Pebble strict Mode](https://github.com/letsencrypt/pebble) | โ Supported | | Any [RFC8555](https://tools.ietf.org/html/rfc8555)-compliant CA | โ Supported | --- ## โ๏ธ Supported Modes | Mode | Description | |------|-------------| | ๐ Webroot mode | Use existing webroot directory | | ๐ฅ๏ธ Standalone mode | Built-in webserver on port 80 | | ๐ Standalone tls-alpn mode | Built-in webserver on port 443 | | ๐ชถ Apache mode | Use Apache for verification | | โก Nginx mode | Use Nginx for verification | | ๐ DNS mode | Use DNS TXT records | | ๐ [DNS alias mode](https://github.com/acmesh-official/acme.sh/wiki/DNS-alias-mode) | Use DNS alias for verification | | ๐ก [Stateless mode](https://github.com/acmesh-official/acme.sh/wiki/Stateless-Mode) | Stateless verification | --- ## ๐ Usage Guide ### 1๏ธโฃ How to Install #### ๐ฅ Install Online > Check this project: https://github.com/acmesh-official/get.acme.sh ```bash curl https://get.acme.sh | sh -s email=my@example.com ``` **Or:** ```bash wget -O - https://get.acme.sh | sh -s email=my@example.com ``` #### ๐ฆ Install from Git Clone this project and launch installation: ```bash git clone https://github.com/acmesh-official/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:** 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. โ **You are ready to issue certs now!** **Show help message:** ```sh acme.sh -h ``` --- ### 2๏ธโฃ Issue a Certificate **Example 1:** Single domain. ```bash acme.sh --issue -d example.com -w /home/wwwroot/example.com ``` or: ```bash acme.sh --issue -d example.com -w /home/username/public_html ``` 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 **30** days. > ๐ The certs will default to **ECC** certificates. ๐ **More examples:** https://github.com/acmesh-official/acme.sh/wiki/How-to-issue-a-cert --- ### 3๏ธโฃ Install the Certificate to Apache/Nginx After the cert is generated, you probably want to install/copy the cert to your Apache/Nginx or other servers. > โ ๏ธ **IMPORTANT:** 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 **30** days by default (configurable). Once renewed, the Apache/Nginx service will be reloaded automatically. > โ ๏ธ **IMPORTANT:** 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 the renewed cert. --- ### 4๏ธโฃ Use Standalone Server to Issue Certificate > ๐ Requires root/sudoer or 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/acmesh-official/acme.sh/wiki/How-to-issue-a-cert --- ### 5๏ธโฃ Use Standalone TLS Server to Issue Certificate > ๐ Requires root/sudoer or 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. ```bash 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 --- ### 6๏ธโฃ Use Apache Mode > ๐ Requires root/sudoer to interact with Apache server If you are running a web server, 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. ```sh acme.sh --issue --apache -d example.com -d www.example.com -d cp.example.com ``` > ๐ก **Note:** 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 with your Apache server, don't worry! ๐ **More examples:** https://github.com/acmesh-official/acme.sh/wiki/How-to-issue-a-cert --- ### 7๏ธโฃ Use Nginx Mode > ๐ Requires root/sudoer to interact with Nginx server If you are running a web server, it is recommended to use the `Webroot mode`. 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. It will configure Nginx server automatically to verify the domain and then restore the Nginx config to the original version. So, the config is not changed. ```sh acme.sh --issue --nginx -d example.com -d www.example.com -d cp.example.com ``` > ๐ก **Note:** 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 with your Nginx server, don't worry! ๐ **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 DNS providers:** https://github.com/acmesh-official/acme.sh/wiki/dnsapi --- ### 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. ```bash acme.sh --issue --dns -d example.com -d www.example.com -d cp.example.com ``` You should get an output like below: ```sh 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: ```bash acme.sh --renew -d example.com ``` โ **Done!** > โ ๏ธ **WARNING:** This is DNS manual mode โ it **cannot** be renewed automatically. You will have to add a new TXT record to your domain manually when you renew your cert. **Please use DNS API mode instead.** --- ### ๐ Issue Certificates of Different Key Types (ECC or RSA) Just set the `keylength` to a valid, supported value. **Valid values for the `keylength` parameter:** | Key Length | Description | |------------|-------------| | `ec-256` | prime256v1, "ECDSA P-256" โญ **Default** | | `ec-384` | secp384r1, "ECDSA P-384" | | `ec-521` | secp521r1, "ECDSA P-521" โ ๏ธ Not supported by Let's Encrypt yet | | `2048` | RSA 2048-bit | | `3072` | RSA 3072-bit | | `4096` | RSA 4096-bit | **Examples:** #### Single domain with ECDSA P-384 certificate ```bash acme.sh --issue -w /home/wwwroot/example.com -d example.com --keylength ec-384 ``` #### SAN multi domain with RSA4096 certificate ```bash acme.sh --issue -w /home/wwwroot/example.com -d example.com -d www.example.com --keylength 4096 ``` --- ### 1๏ธโฃ1๏ธโฃ Issue Wildcard Certificates 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 ``` --- ### 1๏ธโฃ2๏ธโฃ How to Renew Certificates > ๐ No need to renew manually! All certs will be renewed automatically every **30** days. However, you can force a renewal: ```sh acme.sh --renew -d example.com --force ``` **For ECC cert:** ```sh acme.sh --renew -d example.com --force --ecc ``` --- ### 1๏ธโฃ3๏ธโฃ How to Stop Certificate Renewal To stop renewal of a cert, you can execute the following to remove the cert from the renewal list: ```sh 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`) manually. --- ### 1๏ธโฃ4๏ธโฃ How to Upgrade acme.sh > ๐ acme.sh is in constant development โ it's strongly recommended to use the latest code. **Update to latest:** ```sh acme.sh --upgrade ``` **Enable auto upgrade:** ```sh acme.sh --upgrade --auto-upgrade ``` **Disable auto upgrade:** ```sh acme.sh --upgrade --auto-upgrade 0 ``` --- ### 1๏ธโฃ5๏ธโฃ Issue a Certificate from an Existing CSR ๐ https://github.com/acmesh-official/acme.sh/wiki/Issue-a-cert-from-existing-CSR --- ### 1๏ธโฃ6๏ธโฃ Send Notifications in Cronjob ๐ https://github.com/acmesh-official/acme.sh/wiki/notify --- ### 1๏ธโฃ7๏ธโฃ Under the Hood > ๐ง Speak ACME language using shell, directly to "Let's Encrypt". --- ### 1๏ธโฃ8๏ธโฃ Acknowledgments | Project | Link | |---------|------| | ๐ Acme-tiny | https://github.com/diafygi/acme-tiny | | ๐ ACME protocol | https://github.com/ietf-wg-acme/acme | --- ## ๐ฅ Contributors ### ๐ป Code Contributors This project exists thanks to all the people who contribute.
### ๐ฐ Financial Contributors
Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/acmesh/contribute)]
#### ๐ค Individuals
#### ๐ข Organizations
Support this project with your organization. Your logo will show up here with a link to your website. [[Contribute](https://opencollective.com/acmesh/contribute)]
---
### 1๏ธโฃ9๏ธโฃ License & Others
๐ **License:** GPLv3
โญ Please **Star** and **Fork** this project!
๐ [Issues](https://github.com/acmesh-official/acme.sh/issues) and ๐ [Pull Requests](https://github.com/acmesh-official/acme.sh/pulls) are welcome.
---
### 2๏ธโฃ0๏ธโฃ Donate
> ๐ Your donation makes **acme.sh** better!
| Method | Link |
|--------|------|
| PayPal / Alipay(ๆฏไปๅฎ) / Wechat(ๅพฎไฟก) | [https://donate.acme.sh/](https://donate.acme.sh/) |
๐ [Donate List](https://github.com/acmesh-official/acme.sh/wiki/Donate-list)
---
### 2๏ธโฃ1๏ธโฃ About This Repository
> [!NOTE]
> This repository is officially maintained by ZeroSSL as part of our commitment to providing secure and reliable SSL/TLS solutions. We welcome contributions and feedback from the community!
> For more information about our services, including free and paid SSL/TLS certificates, visit https://zerossl.com.
>
> All donations made through this repository go directly to the original independent maintainer (Neil Pang), not to ZeroSSL.
