From 1c06144e18b379b4aa1fff67cdc2242419e9092f Mon Sep 17 00:00:00 2001 From: Alex Dehnert Date: Wed, 28 Sep 2016 02:59:21 -0400 Subject: Mention that the domain is used to choose filename The cert filename is chosen based on the first domain listed. With certs with overlapping domains or where some domains are less canonical, it's therefore useful to put the most canonical/unique domain first. This updates the help text to inform users of this fact. --- docs/cli-help.txt | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/cli-help.txt b/docs/cli-help.txt index 4265056ce..f0c86f85c 100644 --- a/docs/cli-help.txt +++ b/docs/cli-help.txt @@ -50,7 +50,9 @@ optional arguments: -d DOMAIN, --domains DOMAIN, --domain DOMAIN Domain names to apply. For multiple domains you can use multiple -d flags or enter a comma separated list - of domains as a parameter. (default: Ask) + of domains as a parameter. The first domain in the list + will be used to decide where to store the new certificate, + unless otherwise specified. (default: []) --cert-name CERTNAME Certificate name to apply. Only one certificate name can be used per Certbot run. To see certificate names, run 'certbot certificates'. When creating a new -- cgit v1.2.3 From 595745e04469ba3faea152a21186745e17f04cde Mon Sep 17 00:00:00 2001 From: Peter Eckersley Date: Mon, 30 Jan 2017 19:25:03 -0800 Subject: Clarify domain name <-> cert name docs --- certbot/cli.py | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/certbot/cli.py b/certbot/cli.py index 14874e63e..d70a28242 100644 --- a/certbot/cli.py +++ b/certbot/cli.py @@ -867,14 +867,19 @@ def prepare_and_parse_args(plugins, args, detect_defaults=False): # pylint: dis metavar="DOMAIN", action=_DomainsAction, default=[], help="Domain names to apply. For multiple domains you can use " "multiple -d flags or enter a comma separated list of domains " - "as a parameter. (default: Ask)") + "as a parameter. (default: Ask) Note: the first provided domain " + "will be most prominent in filenames and some software user " + "interfaces") helpful.add( [None, "run", "certonly", "manage", "delete", "certificates"], "--cert-name", dest="certname", metavar="CERTNAME", default=None, - help="Certificate name to apply. Only one certificate name can be used " - "per Certbot run. To see certificate names, run 'certbot certificates'. " - "When creating a new certificate, specifies the new certificate's name.") + help="Certificate name to apply. This name is used by Certbot for housekeeping " + "and in file paths; it doesn't affect the content of the certificate itself. " + "To see certificate names, run 'certbot certificates'. " + "When creating a new certificate, specifies the new certificate's name. " + " (default: use the first of the domain names provided with -d or entered " + "interactively)") helpful.add( [None, "testing", "renew", "certonly"], "--dry-run", action="store_true", dest="dry_run", -- cgit v1.2.3 From c314ec047436220529b083b316cabe167a4b3aab Mon Sep 17 00:00:00 2001 From: Brad Warren Date: Fri, 30 Jun 2017 13:58:45 -0400 Subject: Correct --cert-name and --domains usage. * Revert "Mention that the domain is used to choose filename" This reverts commit 1c06144e18b379b4aa1fff67cdc2242419e9092f. * Correct --cert-name and --domains usage. * Clarify which paths --domains affects --- certbot/cli.py | 12 +++++++----- docs/cli-help.txt | 4 +--- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/certbot/cli.py b/certbot/cli.py index d70a28242..4c5505506 100644 --- a/certbot/cli.py +++ b/certbot/cli.py @@ -867,9 +867,11 @@ def prepare_and_parse_args(plugins, args, detect_defaults=False): # pylint: dis metavar="DOMAIN", action=_DomainsAction, default=[], help="Domain names to apply. For multiple domains you can use " "multiple -d flags or enter a comma separated list of domains " - "as a parameter. (default: Ask) Note: the first provided domain " - "will be most prominent in filenames and some software user " - "interfaces") + "as a parameter. The first provided domain will be used in " + "some software user interfaces and file paths for the " + "certificate and related material unless otherwise " + "specified or you already have a certificate for the same " + "domains. (default: Ask)") helpful.add( [None, "run", "certonly", "manage", "delete", "certificates"], "--cert-name", dest="certname", @@ -878,8 +880,8 @@ def prepare_and_parse_args(plugins, args, detect_defaults=False): # pylint: dis "and in file paths; it doesn't affect the content of the certificate itself. " "To see certificate names, run 'certbot certificates'. " "When creating a new certificate, specifies the new certificate's name. " - " (default: use the first of the domain names provided with -d or entered " - "interactively)") + "(default: the first provided domain or the name of an existing " + "certificate on your system for the same domains)") helpful.add( [None, "testing", "renew", "certonly"], "--dry-run", action="store_true", dest="dry_run", diff --git a/docs/cli-help.txt b/docs/cli-help.txt index f0c86f85c..4265056ce 100644 --- a/docs/cli-help.txt +++ b/docs/cli-help.txt @@ -50,9 +50,7 @@ optional arguments: -d DOMAIN, --domains DOMAIN, --domain DOMAIN Domain names to apply. For multiple domains you can use multiple -d flags or enter a comma separated list - of domains as a parameter. The first domain in the list - will be used to decide where to store the new certificate, - unless otherwise specified. (default: []) + of domains as a parameter. (default: Ask) --cert-name CERTNAME Certificate name to apply. Only one certificate name can be used per Certbot run. To see certificate names, run 'certbot certificates'. When creating a new -- cgit v1.2.3