Issue #1087 - improvements to the documentation
Signed-off-by: Lachlan Roberts <lachlan@webtide.com>
This commit is contained in:
parent
dcc6cc435f
commit
1c91fbe9b9
|
@ -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]
|
||||
----
|
||||
|
|
|
@ -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[]
|
||||
|
|
Loading…
Reference in New Issue