prepare for new release

This commit is contained in:
VirtuBox 2018-09-21 14:19:17 +02:00
parent 0e62447ae7
commit 42689af5a4
5 changed files with 102 additions and 67 deletions

View File

@ -1,42 +1,61 @@
# ee-acme-sh
### Bash script to install Let's Encrypt SSL certificates automatically using acme.sh on servers running with EasyEngine
## Bash script to install Let's Encrypt SSL certificates automatically using acme.sh on servers running with EasyEngine
![ee-acme-sh](https://raw.githubusercontent.com/VirtuBox/ee-acme-sh/master/ee-acme.png)
## 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
- ECDSA Certificates with ECC 384 Bits private key
- Automated Certificates Renewal
- 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
- Generate ECDSA Certificates with ECC 384 Bits private key
- Automated Certificates Renewal
- Nginx mainline & stable release support
## Installation
```bash
cd && bash <(wget --no-check-certificate -O - https://raw.githubusercontent.com/VirtuBox/ee-acme-sh/master/install.sh)
bash <(wget -qO - https://raw.githubusercontent.com/VirtuBox/ee-acme-sh/master/install.sh)
# enable acme.sh & ee-acme-sh
source .bashrc
```
## Usage :
## Update script
Just run the installation command again
## Usage
```bash
# Install a SSL certificate on a domain + alias www
ee-acme-www
Usage: ee-acme [type] <domain> [mode]
Types:
-d, --domain <domain_name> ..... for domain.tld + www.domain.tld
-s, --subdomain <subdomain_name> ....... for sub.domain.tld
-w, --wildcard <domain_name> ..... for domain.tld + *.domain.tld
Modes:
--standalone ..... acme challenge in standalone mode
--cf ..... acme challenge in dns mode with Cloudflare
Options:
--cert-only ... do not change nginx configuration, only display it
-h, --help, help ... displays this help information
Examples:
# Install a SSL certificate on a subdomain
ee-acme-subdomain
domain.tld + www.domain.tld in standalone mode :
ee-acme -d domain.tld --standalone
# Install a Wildcard SSL certificate on a domain
ee-acme-wildcard
sub.domain.tld in dns mode with Cloudflare :
ee-acme -s sub.domain.tld --cf
wildcard certificate for domain.tld in dns mode with Cloudflare :
ee-acme -w domain.tld --cf
domain.tld + www.domain.tld in standalone mode without editing Nginx configuration :
ee-acme -d domain.tld --standalone --cert-only
```
## Limitations
- Wildcard certs are only available with Cloudflare DNS API
- Wildcard certs are only available with Cloudflare DNS API

View File

@ -1,42 +1,61 @@
# ee-acme-sh
### Bash script to install Let's Encrypt SSL certificates automatically using acme.sh on servers running with EasyEngine
## Bash script to install Let's Encrypt SSL certificates automatically using acme.sh on servers running with EasyEngine
![ee-acme-sh](https://raw.githubusercontent.com/VirtuBox/ee-acme-sh/master/ee-acme.png)
## 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
- ECDSA Certificates with ECC 384 Bits private key
- Automated Certificates Renewal
- 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
- Generate ECDSA Certificates with ECC 384 Bits private key
- Automated Certificates Renewal
- Nginx mainline & stable release support
## Installation
```bash
cd && bash <(wget --no-check-certificate -O - https://raw.githubusercontent.com/VirtuBox/ee-acme-sh/master/install.sh)
bash <(wget -qO - https://raw.githubusercontent.com/VirtuBox/ee-acme-sh/master/install.sh)
# enable acme.sh & ee-acme-sh
source .bashrc
```
## Usage :
## Update script
Just run the installation command again
## Usage
```bash
# Install a SSL certificate on a domain + alias www
ee-acme-www
Usage: ee-acme [type] <domain> [mode]
Types:
-d, --domain <domain_name> ..... for domain.tld + www.domain.tld
-s, --subdomain <subdomain_name> ....... for sub.domain.tld
-w, --wildcard <domain_name> ..... for domain.tld + *.domain.tld
Modes:
--standalone ..... acme challenge in standalone mode
--cf ..... acme challenge in dns mode with Cloudflare
Options:
--cert-only ... do not change nginx configuration, only display it
-h, --help, help ... displays this help information
Examples:
# Install a SSL certificate on a subdomain
ee-acme-subdomain
domain.tld + www.domain.tld in standalone mode :
ee-acme -d domain.tld --standalone
# Install a Wildcard SSL certificate on a domain
ee-acme-wildcard
sub.domain.tld in dns mode with Cloudflare :
ee-acme -s sub.domain.tld --cf
wildcard certificate for domain.tld in dns mode with Cloudflare :
ee-acme -w domain.tld --cf
domain.tld + www.domain.tld in standalone mode without editing Nginx configuration :
ee-acme -d domain.tld --standalone --cert-only
```
## Limitations
- Wildcard certs are only available with Cloudflare DNS API
- Wildcard certs are only available with Cloudflare DNS API

View File

@ -32,45 +32,28 @@ echo ""
echo "Welcome to the ee-acme-sh installation."
echo ""
# install ee-acme-cf or ee-acme-standalone
mkdir -p ~/.ee-acme
if [ "$acmemode" = "1" ]
then
wget -O ~/.ee-acme/ee-acme https://raw.githubusercontent.com/VirtuBox/ee-acme-sh/master/script/ee-acme-cf
cd || exit
echo '. "/root/.ee-acme/ee-acme"' >> .bashrc
source .bashrc
echo ""
echo "What is your Cloudflare email address ? :"
echo ""
read -r cf_email
echo "What is your Cloudflare API Key ? You API Key is available on https://www.cloudflare.com/a/profile"
read -r cf_api_key
echo "SAVED_CF_Key='$cf_api_key'" >> .acme.sh/account.conf
echo "SAVED_CF_Email='$cf_email'" >> .acme.sh/account.conf
elif [[ "$acmemode" = "2" ]]; then
wget -O ~/.ee-acme/ee-acme https://raw.githubusercontent.com/VirtuBox/ee-acme-sh/master/script/ee-acme-standalone
echo "alias ee-acme="/root/.ee-acme/ee-acme.sh""
echo '. "/root/.ee-acme/ee-acme"' >> .bashrc
source .bashrc
echo ""
if [ -d $HOME/.ee-acme ]; then
rm -rf $HOME/.ee-acme/*
echo 'alias ee-acme="/root/.ee-acme/ee-acme.sh"' >> $HOME/.ee-acme/ee-acme
wget -O $HOME/.ee-acme/ee-acme.sh https://raw.githubusercontent.com/VirtuBox/ee-acme-sh/master/script/ee-acme.sh
chmod +x $HOME/.ee-acme/ee-acme.sh
else
echo "this option doesn't exist"
exit 1
mkdir -p $HOME/.ee-acme
wget -O $HOME/.ee-acme/ee-acme.sh https://raw.githubusercontent.com/VirtuBox/ee-acme-sh/master/script/ee-acme.sh
chmod +x $HOME/.ee-acme/ee-acme.sh
echo 'alias ee-acme="/root/.ee-acme/ee-acme.sh"' >> $HOME/.bashrc
fi
# We're done !
echo ""
echo -e " ${CGREEN}ee-acme-sh was installed successfully !${CEND}"
echo -e " ${CGREEN}ee-acme-sh was installed successfully !${CEND}"
echo ""
echo "You have to run the following command to enable ee-acme-sh"
echo "You need to run the following command to enable ee-acme-sh"
echo ""
echo -e " ${CGREEN}source .bashrc${CEND}"
echo ""
echo ""
echo "Usage: ee-acme [type] <domain> [mode]"
echo " Types:"
echo " -d, --domain <domain_name> ..... for domain.tld + www.domain.tld"
@ -80,18 +63,22 @@ echo " Modes:"
echo " --standalone ..... acme challenge in standalone mode"
echo " --cf ..... acme challenge in dns mode with Cloudflare"
echo " Options:"
echo " --cert-only ... do not change nginx configuration, only display it"
echo " -h, --help, help ... displays this help information"
echo "Examples:"
echo ""
echo "domain.tld + www.domain.tld in standalone mode :"
echo " ee-acme -d domain.tld --standalone"
echo ""
echo "sub.domain.tld in dns mode with Cloudflare"
echo "sub.domain.tld in dns mode with Cloudflare :"
echo " ee-acme -s sub.domain.tld --cf"
echo ""
echo "wildcard certificate for domain.tld in dns mode with Cloudflare :"
echo " ee-acme -w domain.tld --cf"
echo ""
echo "domain.tld + www.domain.tld in standalone mode without editing Nginx configuration :"
echo " ee-acme -d domain.tld --standalone --cert-only"
echo ""

View File

@ -1 +0,0 @@
alias ee-acme="/root/.ee-acme/ee-acme.sh"

View File

@ -1,5 +1,16 @@
#!/bin/bash
# install acme.sh if needed
echo ""
echo "checking if acme.sh is already installed"
echo ""
if [ ! -f ~/.acme.sh/acme.sh ]; then
echo ""
echo "installing acme.sh"
echo ""
wget -O - https://get.acme.sh | sh
fi
_help() {
echo "Issue and install SSL certificates using acme.sh with EasyEngine"
echo "Usage: ee-acme [type] <domain> [mode]"