You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
acme.sh/README.md

129 lines
3.7 KiB

9 years ago
# le
Simplest shell script for LetsEncrypt free Certificate client
Pure written in bash, no dependencies to python , acme-tiny or LetsEncrypt official client (https://github.com/letsencrypt/letsencrypt)
9 years ago
Just one script, to issue, renew your certificates automatically.
9 years ago
9 years ago
Probably it's the smallest&easiest&smartest shell script to automatically issue&renew the free certificates from LetsEncrypt.
9 years ago
#Supported OS
9 years ago
1. Ubuntu/Debian.
2. CentOS
9 years ago
#Supported Mode
1. Webroot mode
2. Standalone mode
3. Apache mode
9 years ago
#How to use
1. Clone this project: https://github.com/Neilpang/le.git
2. Install le:
```
./le.sh install
```
9 years ago
Which does 3 jobs:
* create and copy `le.sh` to your home dir: `~/.le`
9 years ago
All the certs will be placed in this folder.
9 years ago
* create symbol link: `/bin/le -> ~/.le/le.sh`
9 years ago
* create everyday cron job to check and renew the cert if needed.
9 years ago
9 years ago
Ok, you are ready to issue cert now.
9 years ago
Show help message:
```
root@xvm:~# le
Usage: issue|renew|renewAll|createAccountKey|createDomainKey|createCSR|install|uninstall
root@xvm:~# le issue
Usage: le issue webroot|no|apache a.com [www.a.com,b.com,c.com]|no [key-length]|no [cert-file-path]|no [key-file-path]|no [ca-cert-file-path]|no [reloadCmd]|no
9 years ago
```
9 years ago
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/"
9 years ago
# Just issue a cert:
```
le issue /home/wwwroot/aa.com aa.com www.aa.com,cp.aa.com
```
9 years ago
First argument `/home/wwwroot/aa.com` is the web root folder, You must have `write` access to this folder.
9 years ago
9 years ago
Second argument "aa.com" is the main domain you want to issue cert for.
9 years ago
9 years ago
Third argument is the additional domain list you want to use. Comma separated list, which is Optional.
9 years ago
9 years ago
You must point and bind all the domains to the same webroot dir:`/home/wwwroot/aa.com`
9 years ago
The cert will be placed in `~/.le/aa.com/`
The issued cert will be renewed every 50 days automatically.
9 years ago
# Issue a cert, and install to apache/nginx
9 years ago
```
9 years ago
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 /path/to/ca/certfile/apahce/nginx "service apache2/nginx reload"
9 years ago
```
9 years ago
Which issues the cert and then links it to the production apache or nginx path.
The cert will be renewed every 50 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`
9 years ago
# Use Standalone server:
9 years ago
Same usage as all above, just give `no` as the webroot.
The tcp `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
```
# Use Apache mode:
9 years ago
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
```
All the other arguments are the same with previous.
9 years ago
#Under the Hood
9 years ago
Speak ACME language with bash directly to Let's encrypt.
9 years ago
TODO:
9 years ago
#Acknowledgment
1. Acme-tiny: https://github.com/diafygi/acme-tiny
2. ACME protocol: https://github.com/ietf-wg-acme/acme
3. letsencrypt: https://github.com/letsencrypt/letsencrypt
9 years ago
#License & Other
License is GPLv3
9 years ago
Please Star and Fork me.
9 years ago
Issues and pullrequests are welcomed.