From e7fcd0e08d177d22f92f690e8fe1c47877fb3e77 Mon Sep 17 00:00:00 2001 From: alexzorin Date: Fri, 13 Jan 2023 03:03:51 +1100 Subject: [PATCH] docs: give webroot and standalone better descriptions (#9536) --- certbot/certbot/_internal/plugins/standalone.py | 4 +++- certbot/certbot/_internal/plugins/webroot.py | 5 ++++- certbot/tests/plugins/disco_test.py | 2 +- 3 files changed, 8 insertions(+), 3 deletions(-) diff --git a/certbot/certbot/_internal/plugins/standalone.py b/certbot/certbot/_internal/plugins/standalone.py index 826acb2b1..2186e89da 100644 --- a/certbot/certbot/_internal/plugins/standalone.py +++ b/certbot/certbot/_internal/plugins/standalone.py @@ -124,7 +124,9 @@ class Authenticator(common.Plugin, interfaces.Authenticator): rely on any existing server program. """ - description = "Spin up a temporary webserver" + description = """Runs an HTTP server locally which serves the necessary validation files \ +under the /.well-known/acme-challenge/ request path. Suitable if there is no HTTP server already \ +running. HTTP challenge only (wildcards not supported).""" def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) diff --git a/certbot/certbot/_internal/plugins/webroot.py b/certbot/certbot/_internal/plugins/webroot.py index e98cb77c8..7315ee427 100644 --- a/certbot/certbot/_internal/plugins/webroot.py +++ b/certbot/certbot/_internal/plugins/webroot.py @@ -56,7 +56,10 @@ _WEB_CONFIG_SHA256SUMS = [ class Authenticator(common.Plugin, interfaces.Authenticator): """Webroot Authenticator.""" - description = "Place files in webroot directory" + description = """\ +Saves the necessary validation files to a .well-known/acme-challenge/ directory within the \ +nominated webroot path. A seperate HTTP server must be running and serving files from the \ +webroot path. HTTP challenge only (wildcards not supported).""" MORE_INFO = """\ Authenticator plugin that performs http-01 challenge by saving diff --git a/certbot/tests/plugins/disco_test.py b/certbot/tests/plugins/disco_test.py index 673a8d04b..cb6e4b53e 100644 --- a/certbot/tests/plugins/disco_test.py +++ b/certbot/tests/plugins/disco_test.py @@ -58,7 +58,7 @@ class PluginEntryPointTest(unittest.TestCase): name, PluginEntryPoint.entry_point_to_plugin_name(entry_point)) def test_description(self): - self.assertIn("temporary webserver", self.plugin_ep.description) + self.assertIn("server locally", self.plugin_ep.description) def test_description_with_name(self): self.plugin_ep.plugin_cls = mock.MagicMock(description="Desc")