prepare github page

This commit is contained in:
VirtuBox 2018-05-02 23:29:31 +02:00
parent c800bdc264
commit e30488cc99
1 changed files with 40 additions and 0 deletions

40
docs/README.md Normal file
View File

@ -0,0 +1,40 @@
# ee-acme-sh
### Bash script to install Let's Encrypt SSL certificates automatically using acme.sh on servers running with EasyEngine
## Features
- Automated Installation of Let's Encrypt SSL certificates using [acme.sh](http://acme.sh)
- Acme validation with standalone mode or Cloudflare DNS API
- Domain, Subdomain & Wildcard SSL Certificates support
- IPv6 Support
- Automated Certificates Renewal
![ee-acme-sh](https://raw.githubusercontent.com/VirtuBox/ee-acme-sh/master/ee-acme.png)
## Installation
```bash
cd && bash <(wget --no-check-certificate -O - https://raw.githubusercontent.com/VirtuBox/ee-acme-sh/master/install.sh)
# enable acme.sh & ee-acme-sh
source .bashrc
```
## Usage :
```bash
# Install a SSL certificate on a domain + alias www
1. ee-acme-www
# Install a SSL certificate on a subdomain
ee-acme-subdomain
# Install a Wildcard SSL certificate on a domain
ee-acme-wildcard
```
## Limitations
- Wildcard certs are only available with Cloudflare DNS API