From 1c91fbe9b96216a78867616cbb04da0e01b18363 Mon Sep 17 00:00:00 2001 From: Lachlan Roberts Date: Mon, 25 Oct 2021 10:54:30 +1100 Subject: [PATCH] Issue #1087 - improvements to the documentation Signed-off-by: Lachlan Roberts --- .../modules/module-well-known.adoc | 14 ++++++++------ .../src/main/config/modules/well-known.mod | 2 ++ 2 files changed, 10 insertions(+), 6 deletions(-) diff --git a/documentation/jetty-documentation/src/main/asciidoc/operations-guide/modules/module-well-known.adoc b/documentation/jetty-documentation/src/main/asciidoc/operations-guide/modules/module-well-known.adoc index ba1dcdc59b8..87a497f8d0d 100644 --- a/documentation/jetty-documentation/src/main/asciidoc/operations-guide/modules/module-well-known.adoc +++ b/documentation/jetty-documentation/src/main/asciidoc/operations-guide/modules/module-well-known.adoc @@ -14,14 +14,16 @@ [[og-module-well-known]] ===== Module `well-known` -The `well-known` creates a `ResourceHandler` deployed at the `/.well-known` context path. -This `Handler` serves files from a directory created at `${jetty.base}/.well-known`, note that this may be seen as a hidden directory by the filesystem. +The `well-known` creates a `ResourceHandler` deployed at the `/.well-known` context path which serves files from a directory. +By default, the directory created at `$JETTY_BASE/.well-known` is used, but it can be configured from `well-known.ini` to anywhere in the filesystem. +Note that the `.well-known` directory may be seen as a hidden directory by the filesystem. -The concept of well-known URIs has been defined in RFC5785. -It may be used for things like automation of the renewal for Let's Encrypt certificates. +The concept of well-known URIs has been defined in link:https://datatracker.ietf.org/doc/html/rfc5785[RFC5785]. +This module can be used for things like the automatic renewal of link:https://letsencrypt.org/[Let's Encrypt] certificates. +See link:https://www.iana.org/assignments/well-known-uris/well-known-uris.xhtml[IANA Well-Known URIs] for more possible examples of how this can be used. -The module file is `$JETTY_HOME/modules/well-known.mod`: +The module properties are: ---- -include::{JETTY_HOME}/modules/well-known.mod[] +include::{JETTY_HOME}/modules/well-known.mod[tags=documentation] ---- diff --git a/jetty-server/src/main/config/modules/well-known.mod b/jetty-server/src/main/config/modules/well-known.mod index 567792e777d..58668d721bc 100644 --- a/jetty-server/src/main/config/modules/well-known.mod +++ b/jetty-server/src/main/config/modules/well-known.mod @@ -16,5 +16,7 @@ etc/well-known.xml .well-known/ [ini-template] +# tag::documentation[] ## Well Known Directory (relative to $jetty.base) # jetty.wellknown.dir=.well-known +# end::documentation[]