acme.sh/README.md

87 lines
2.2 KiB
Markdown
Raw Normal View History

2015-12-26 13:44:39 +00:00
# le
Simplest shell script for LetsEncrypt free Certificate client
This is a shell version from https://github.com/diafygi/acme-tiny
Pure written in bash, no dependencies to python , acme-tiny or LetsEncrypt official client (https://github.com/letsencrypt/letsencrypt)
Just one script, to issue, renew your certiricates automatically.
2015-12-26 13:55:26 +00:00
Probably it's the smallest&easiest&smartest shell script to automatically issue&renew the free certificates from LetsEncrypt.
2015-12-26 13:44:39 +00:00
#Supported OS
2015-12-27 05:23:25 +00:00
1. Ubuntu/Debian.
2. CentOS
2015-12-26 13:44:39 +00:00
#How to use
1. Clone this project: https://github.com/Neilpang/le.git
2. Install le:
```
./le.sh install
```
Which does 2 things:
* create and copy le.sh to your home dir: `~/.le`
All the certs will be placed in this folder.
2015-12-26 14:06:11 +00:00
* create symbol link: `/bin/le -> ~/.le/le.sh`
2015-12-26 13:44:39 +00:00
3. Ok, you are ready to issue cert now.
Show help message:
```
root@xvm:~# le
Usage: issue|renew|renewAll|createAccountKey|createDomainKey|createCSR|install|uninstall
root@xvm:~# le issue
Usage: /bin/le webroot a.com [www.a.com,b.com,c.com] [key-length] [cert-file-path] [key-file-path] [reloadCmd]
```
# Just issue a cert:
```
le issue /home/wwwroot/aa.com aa.com www.aa.com,cp.aa.com
```
First argument " /home/wwwroot/aa.com" is the web root folder
Second argument "aa.com" is the domain you want to issue cert for.
Third argument is the additional domain list you want to use. Comma sperated list, Optional.
'You must point and bind all the domains to the same webroot dir:/home/wwwroot/aa.com'
The cert will be placed in `~/.le/aa.com/`
The issued cert will be renewed every 50 days automatically.
2015-12-26 16:35:59 +00:00
# Issue a cert, and install to apache/nginx
2015-12-26 13:44:39 +00:00
```
2015-12-26 16:35:59 +00:00
le issue /home/wwwroot/aa.com aa.com www.aa.com,cp.aa.com 2048 /path/to/certfile/in/apache/nginx /path/to/keyfile/in/apache/nginx "service apache2/nginx reload"
2015-12-26 13:44:39 +00:00
```
This can link the issued cert to the production apache or nginx path.
Once the cert is renewed, the apache/nginx will be automatically reloaded by the command: ` service apache2 reload`
#Under the Hood
2015-12-26 16:33:53 +00:00
Speak ACME language with bash directly to Let's encrypt.
2015-12-26 13:44:39 +00:00
TODO:
#License & Other
License is GPLv3
2015-12-26 13:47:28 +00:00
Please Star and Fork me.
2015-12-26 13:44:39 +00:00
Issues and pullrequests are welcomed.