From 328f8cdc5b65f4fe43082faee8e34fe4cba2d98d Mon Sep 17 00:00:00 2001 From: Peter Eckersley Date: Mon, 30 Nov 2015 18:24:40 -0800 Subject: [PATCH] Document --webroot-path --- letsencrypt/cli.py | 5 ++++- letsencrypt/plugins/webroot.py | 2 ++ 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/letsencrypt/cli.py b/letsencrypt/cli.py index cc458d7fe..cbdd5465a 100644 --- a/letsencrypt/cli.py +++ b/letsencrypt/cli.py @@ -1035,7 +1035,10 @@ def _plugins_parsing(helpful, plugins): # legibiility. helpful.add_plugin_ags must be called first to add the # "webroot" topic helpful.add("webroot", "-w", "--webroot-path", action=WebrootPathProcessor, - help="public_html / webroot path") + help="public_html / webroot path. This can be specified multiple times to " + "handle different domains; each domain will have the webroot path that" + " precededed it. For instance: `-w /var/www/example -d example.com -d " + "www.example.com -w /var/www/thing -d thing.net -d m.thing.net`") parse_dict = lambda s: dict(json.loads(s)) # --webroot-map still has some awkward properties, so it is undocumented helpful.add("webroot", "--webroot-map", default={}, type=parse_dict, diff --git a/letsencrypt/plugins/webroot.py b/letsencrypt/plugins/webroot.py index 4e18f5ca2..8be5d80cd 100644 --- a/letsencrypt/plugins/webroot.py +++ b/letsencrypt/plugins/webroot.py @@ -73,6 +73,8 @@ to serve all files under specified web root ({0}).""" @classmethod def add_parser_arguments(cls, add): + # --webroot-path and --webroot-map are added in cli.py because they + # are parsed in conjunction with --domains pass def get_chall_pref(self, domain): # pragma: no cover