docs: give webroot and standalone better descriptions (#9536)

This commit is contained in:
alexzorin
2023-01-12 08:03:51 -08:00
committed by GitHub
parent 8149e255c8
commit e7fcd0e08d
3 changed files with 8 additions and 3 deletions
@@ -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)
+4 -1
View File
@@ -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
+1 -1
View File
@@ -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")