From 64161929cd032a53cd9aeda751d3db5898736838 Mon Sep 17 00:00:00 2001 From: VirtuBox Date: Thu, 27 Sep 2018 16:27:26 +0200 Subject: [PATCH] update documentation --- README.md | 42 +++++++++++++++++++++----------------- docs/README.md | 42 +++++++++++++++++++++----------------- install.sh | 55 ++++++++++++++++++++++++++------------------------ 3 files changed, 75 insertions(+), 64 deletions(-) diff --git a/README.md b/README.md index 0d0866b..3792d59 100644 --- a/README.md +++ b/README.md @@ -32,29 +32,33 @@ Just run the installation command again ```bash Usage: ee-acme [type] [mode] - Types: - -d, --domain ..... for domain.tld + www.domain.tld - -s, --subdomain ....... for sub.domain.tld - -w, --wildcard ..... 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: + Types: + -d, --domain ..... for domain.tld + www.domain.tld + -s, --subdomain ....... for sub.domain.tld + -w, --wildcard ..... 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 + --admin ... secure easyengine backend with the certificate + -h, --help, help ... displays this help information +Examples: - domain.tld + www.domain.tld in standalone mode : - ee-acme -d domain.tld --standalone +domain.tld + www.domain.tld in standalone mode : + ee-acme -d domain.tld --standalone - sub.domain.tld in dns mode with Cloudflare : - ee-acme -s sub.domain.tld --cf +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 +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 +domain.tld + www.domain.tld in standalone mode without editing Nginx configuration : + ee-acme -d domain.tld --standalone --cert-only + +sub.domain.tld in standalone mode to secure easyengine backend on port 22222 : + ee-acme -s sub.domain.tld --standalone --admin ``` ## Limitations diff --git a/docs/README.md b/docs/README.md index 0d0866b..3792d59 100644 --- a/docs/README.md +++ b/docs/README.md @@ -32,29 +32,33 @@ Just run the installation command again ```bash Usage: ee-acme [type] [mode] - Types: - -d, --domain ..... for domain.tld + www.domain.tld - -s, --subdomain ....... for sub.domain.tld - -w, --wildcard ..... 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: + Types: + -d, --domain ..... for domain.tld + www.domain.tld + -s, --subdomain ....... for sub.domain.tld + -w, --wildcard ..... 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 + --admin ... secure easyengine backend with the certificate + -h, --help, help ... displays this help information +Examples: - domain.tld + www.domain.tld in standalone mode : - ee-acme -d domain.tld --standalone +domain.tld + www.domain.tld in standalone mode : + ee-acme -d domain.tld --standalone - sub.domain.tld in dns mode with Cloudflare : - ee-acme -s sub.domain.tld --cf +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 +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 +domain.tld + www.domain.tld in standalone mode without editing Nginx configuration : + ee-acme -d domain.tld --standalone --cert-only + +sub.domain.tld in standalone mode to secure easyengine backend on port 22222 : + ee-acme -s sub.domain.tld --standalone --admin ``` ## Limitations diff --git a/install.sh b/install.sh index f4bf484..d276c01 100644 --- a/install.sh +++ b/install.sh @@ -62,32 +62,35 @@ echo "You need to run the following command to enable ee-acme-sh" echo "" echo -e " ${CGREEN}source .bashrc${CEND}" echo "" -echo "Usage: ee-acme [type] [mode]" -echo " Types:" -echo " -d, --domain ..... for domain.tld + www.domain.tld" -echo " -s, --subdomain ....... for sub.domain.tld" -echo " -w, --wildcard ..... for domain.tld + *.domain.tld" -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 " 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 "" - + echo "Usage: ee-acme [type] [mode]" + echo " Types:" + echo " -d, --domain ..... for domain.tld + www.domain.tld" + echo " -s, --subdomain ....... for sub.domain.tld" + echo " -w, --wildcard ..... for domain.tld + *.domain.tld" + 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 " --admin ... secure easyengine backend with the certificate" + 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 " 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 "" + echo "sub.domain.tld in standalone mode to secure easyengine backend on port 22222 :" + echo " ee-acme -s sub.domain.tld --standalone --admin" + echo ""