Simplest shell script for LetsEncrypt free Certificate client
Simple and Powerful, you only need 3 minutes to learn.
Pure written in bash, no dependencies to python , acme-tiny or LetsEncrypt official client. Just one script, to issue, renew your certificates automatically.
Probably it's the smallest&easiest&smartest shell script to automatically issue&renew the free certificates from LetsEncrypt.
Do NOT require to be
#How to use
Clone this project: https://github.com/Neilpang/le.git
You don't have to be root then, although it is recommended.
Which does 3 jobs:
le.shto your home dir:
~/.leAll the certs will be placed in this folder.
After install, 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:~# le.sh https://github.com/Neilpang/le v1.1.1 Usage: le.sh [command] ...[args].... Available commands: install: Install le.sh to your system. issue: Issue a cert. installcert: Install the issued cert to apache/nginx or any other server. renew: Renew a cert. renewAll: Renew all the certs. uninstall: Uninstall le.sh, and uninstall the cron job. version: Show version info. installcronjob: Install the cron job to renew certs, you don't need to call this. The 'install' command can automatically install the cron job. uninstallcronjob: Uninstall the cron job. The 'uninstall' command can do this automatically. createAccountKey: Create an account private key, professional use. createDomainKey: Create an domain private key, professional use. createCSR: Create CSR , professional use. root@v1:~/le# le issue Usage: le issue webroot|no|apache|dns a.com [www.a.com,b.com,c.com]|no [key-length]|no
Set the param value to "no" means you want to ignore it.
For example, if you give "no" to "key-length", it will use default length 2048.
And if you give 'no' to 'cert-file-path', it will not copy the issued cert to the "cert-file-path".
In all the cases, the issued cert will be placed in "~/.le/domain.com/"
Example 1: Only one domain:
le issue /home/wwwroot/aa.com aa.com
Example 2: Multiple domains in the same cert:
le issue /home/wwwroot/aa.com aa.com www.aa.com,cp.aa.com
/home/wwwroot/aa.com is the web root folder, You must have
write access to this folder.
Second argument "aa.com" is the main domain you want to issue cert for.
Third argument is the additional domain list you want to use. Comma separated list, which is Optional.
You must point and bind all the domains to the same webroot dir:
The cert will be placed in
The issued cert will be renewed every 80 days automatically.
le installcert aa.com /path/to/certfile/in/apache/nginx /path/to/keyfile/in/apache/nginx /path/to/ca/certfile/apache/nginx "service apache2|nginx reload"
Install the issued cert/key to the production apache or nginx path.
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
Same usage as all above, just give
no as the webroot.
80 port must be free to listen, otherwise you will be prompted to free the
80 port and try again.
le issue no aa.com www.aa.com,cp.aa.com
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 can use apache mode instead. Which doesn't write any file to your web root folder.
Just set string "apache" to the first argument, it will use apache plugin automatically.
le issue apache aa.com www.aa.com,user.aa.com
All the other arguments are the same with previous.
Support the latest dns-01 challenge.
le issue dns aa.com www.aa.com,user.aa.com
You will get the output like bellow:
Add the following txt record: Domain:_acme-challenge.aa.com Txt value:9ihDbjYfTExAYeDs4DBUeuTo18KBzwvTEjUnSwd32-c Add the following txt record: Domain:_acme-challenge.www.aa.com Txt value:9ihDbjxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Please add those txt records to the domains. Waiting for the dns to take effect.
Then just retry with 'renew' command:
le renew aa.com
Ok, it's finished.
#Automatic dns api integeration
If your dns provider supports api access, we can use api to automatically issue certs. You don't have do anything manually.
###Currently we support:
More apis are comming soon....
If your dns provider is not in the supported list above, you can write your own script api easily.
For more details: How to use dns api
LetsEncrypt now can issue ECDSA certificate. And we also support it.
Just set the
length parameter with a prefix
le issue /home/wwwroot/aa.com aa.com www.aa.com ec-256
Please look at the last parameter above.
Valid values are:
#Under the Hood
Speak ACME language with bash directly to Let's encrypt.
#License & Other
License is GPLv3
Please Star and Fork me.
Issues and pull requests are welcomed.