diff --git a/readme.md b/readme.md index 16f1353e72b97a1149a044074df925ef89ff87e0..4b7ef2b9aa542c0498dd8b441fc9a029179d20e7 100644 --- a/readme.md +++ b/readme.md @@ -67,7 +67,7 @@ DEBUG: You can test and mess around. Do not use certs in production. HELP The basic syntax is -cm.sh ACTION [FQDN] [ALIAS_1 [.. ALIAS_N]] +cm.sh [--trace] ACTION [FQDN] [ALIAS_1 [.. ALIAS_N]] The ACTIONs for SINGLE certificate handlings are: @@ -121,6 +121,10 @@ other ACTIONs check of health with current setup and requirements. This command is helpful for initial setups. +OPTIONS + --trace (it must be the 1st parameter) + the output additionally will be written into a tracelog file + below ./log. DEBUG: Using Let's Encrypt STAGE environment ... DEBUG: You can test and mess around. Do not use certs in production. @@ -131,8 +135,8 @@ DEBUG: You can test and mess around. Do not use certs in production. A certificate is created for a host and can have additional DNS names (optional). For integration into a system deployment with Ansible & co the `ensure` prameter -is the best choice because it detects what action is required. -The command +is the best choice because it detects what action is required. +The command `[APPPATH]/cm.sh ensure www.example.com mail.example.com` @@ -145,10 +149,9 @@ The "manual way" with atomic actions is: * Modify hostnames with add command `[APPPATH]/cm.sh add www.example.com mail.example.com newhost.example.com` what creates a new certificate. Optionally you can/ should revoke the existing certificate with the former host list before (see next command). The impact is: Your SSL certificate on the website is invalid up to the moment you create and deploy the new certificate what can take a few minutes. If you maintain many certificates with the same domain and the request limit is reached your application can be broken broken for an even longer time. * Deletin the certificates includes a revoke `[APPPATH]/cm.sh delete www.example.com` - ### Show certificate data -Use the listing `[APPPATH]/cm.sh list` or maybe filter it `[APPPATH]/cm.sh list | grep "mail."` +Use the listing `[APPPATH]/cm.sh list` or maybe filter it `[APPPATH]/cm.sh list | grep "mail."` to get a list of existing certs an then use the hostname in the 1st column to show details: