update documentation
This commit is contained in:
parent
48dfabfe20
commit
64161929cd
42
README.md
42
README.md
|
|
@ -32,29 +32,33 @@ Just run the installation command again
|
|||
|
||||
```bash
|
||||
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:
|
||||
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
|
||||
--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
|
||||
|
|
|
|||
|
|
@ -32,29 +32,33 @@ Just run the installation command again
|
|||
|
||||
```bash
|
||||
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:
|
||||
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
|
||||
--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
|
||||
|
|
|
|||
55
install.sh
55
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] <domain> [mode]"
|
||||
echo " Types:"
|
||||
echo " -d, --domain <domain_name> ..... for domain.tld + www.domain.tld"
|
||||
echo " -s, --subdomain <subdomain_name> ....... for sub.domain.tld"
|
||||
echo " -w, --wildcard <domain_name> ..... 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] <domain> [mode]"
|
||||
echo " Types:"
|
||||
echo " -d, --domain <domain_name> ..... for domain.tld + www.domain.tld"
|
||||
echo " -s, --subdomain <subdomain_name> ....... for sub.domain.tld"
|
||||
echo " -w, --wildcard <domain_name> ..... 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 ""
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue