From 780e1207c7d8f9bdb07f6849ab202c89da3adb9c Mon Sep 17 00:00:00 2001 From: Greg Wilkins Date: Mon, 14 Sep 2020 18:07:16 +0200 Subject: [PATCH] Issue #5254 List/Show modules (#5257) * Issue #5254 List/Show modules * simplified --list-modules output * added --show-module Signed-off-by: Greg Wilkins * improve module descriptions Signed-off-by: Greg Wilkins --- .../src/main/config/modules/apache-jsp.mod | 2 +- .../src/main/config/modules/apache-jstl.mod | 2 +- .../src/main/config/modules/alpn.mod | 5 + .../src/main/config/modules/cdi-decorate.mod | 5 +- jetty-cdi/src/main/config/modules/cdi-spi.mod | 4 +- jetty-cdi/src/main/config/modules/cdi.mod | 4 +- .../config/modules/global-webapp-common.mod | 2 +- .../modules/gcloud-datastore.mod | 2 +- .../main/config-template/modules/gcloud.mod | 2 +- .../session-store-hazelcast-embedded.mod | 2 +- .../session-store-hazelcast-remote.mod | 2 +- .../src/main/resources/modules/conscrypt.mod | 2 +- .../src/main/resources/modules/jamon.mod | 2 +- .../src/main/resources/modules/jminix.mod | 2 +- .../src/main/resources/modules/jstl.mod | 2 +- .../resources/modules/logging-jcl-capture.mod | 2 +- .../main/resources/modules/logging-jetty.mod | 2 +- .../resources/modules/logging-jul-capture.mod | 2 +- .../main/resources/modules/logging-jul.mod | 2 +- .../modules/logging-log4j1-capture.mod | 2 +- .../main/resources/modules/logging-log4j1.mod | 4 +- .../main/resources/modules/logging-log4j2.mod | 2 +- .../main/resources/modules/logging-noop.mod | 2 +- .../main/resources/modules/logging/slf4j.mod | 5 +- .../src/main/resources/modules/setuid.mod | 4 +- .../src/main/resources/modules/stop.mod | 3 +- .../src/main/config/modules/http2.mod | 4 +- .../src/main/config/modules/http2c.mod | 2 +- .../sessions/infinispan/infinispan-common.mod | 3 +- .../modules/infinispan-embedded-query.mod | 2 +- .../infinispan-embedded-query-libs.mod | 2 +- .../modules/infinispan-embedded.mod | 2 +- .../session-store-infinispan-embedded.mod | 2 +- .../embedded/infinispan-embedded-libs.mod | 3 +- .../infinispan-embedded-serverclasses.mod | 1 + .../modules/infinispan-remote-query.mod | 2 +- .../remote/infinispan-remote-query-libs.mod | 3 +- .../modules/infinispan-remote.mod | 2 +- .../session-store-infinispan-remote.mod | 2 +- .../remote/infinispan-remote-libs.mod | 3 +- .../src/main/config/modules/jmx-remote.mod | 2 +- jetty-jmx/src/main/config/modules/jmx.mod | 3 +- .../src/main/resources/maven.mod | 2 +- .../session-data-cache/xmemcached.mod | 2 +- .../config/modules/sessions/mongo/address.mod | 2 +- .../config/modules/sessions/mongo/uri.mod | 2 +- .../src/main/config/modules/openid.mod | 2 +- jetty-plus/src/main/config/modules/plus.mod | 3 +- jetty-proxy/src/main/config/modules/proxy.mod | 4 +- .../src/main/config/modules/quickstart.mod | 3 +- .../config/modules/rewrite-compactpath.mod | 4 +- .../config/modules/rewrite-customizer.mod | 4 +- .../src/main/config/modules/rewrite.mod | 7 +- .../main/config/modules/acceptratelimit.mod | 2 +- .../main/config/modules/connectionlimit.mod | 2 +- .../main/config/modules/customrequestlog.mod | 3 +- .../src/main/config/modules/debug.mod | 5 +- .../src/main/config/modules/debuglog.mod | 2 + jetty-server/src/main/config/modules/ext.mod | 3 +- .../main/config/modules/flight-recorder.mod | 3 +- jetty-server/src/main/config/modules/gzip.mod | 1 + .../main/config/modules/home-base-warning.mod | 3 +- .../main/config/modules/http-forwarded.mod | 4 +- .../src/main/config/modules/https.mod | 2 +- .../src/main/config/modules/inetaccess.mod | 6 +- jetty-server/src/main/config/modules/jdbc.mod | 6 + jetty-server/src/main/config/modules/jvm.mod | 3 +- .../src/main/config/modules/lowresources.mod | 4 +- .../src/main/config/modules/requestlog.mod | 2 +- .../src/main/config/modules/resources.mod | 5 +- .../config/modules/session-cache-hash.mod | 3 +- .../config/modules/session-cache-null.mod | 4 +- .../src/main/config/modules/sessions.mod | 9 +- .../modules/sessions/jdbc/datasource.mod | 2 +- .../config/modules/sessions/jdbc/driver.mod | 2 +- .../src/main/config/modules/ssl-reload.mod | 2 +- jetty-server/src/main/config/modules/ssl.mod | 1 + .../src/main/config/modules/stats.mod | 5 +- .../src/main/config/modules/test-keystore.mod | 1 + .../src/main/config/modules/threadlimit.mod | 5 +- .../src/main/config/modules/threadpool.mod | 2 +- .../src/main/config/modules/servlets.mod | 7 +- .../src/main/config/modules/spring.mod | 4 +- .../java/org/eclipse/jetty/start/Main.java | 33 +-- .../java/org/eclipse/jetty/start/Module.java | 2 +- .../java/org/eclipse/jetty/start/Modules.java | 196 ++++++++++-------- .../org/eclipse/jetty/start/StartArgs.java | 26 ++- .../org/eclipse/jetty/start/usage.txt | 19 +- .../config/modules/unixsocket-forwarded.mod | 7 +- .../main/config/modules/unixsocket-http2c.mod | 2 +- .../modules/unixsocket-proxy-protocol.mod | 2 +- .../main/config/modules/unixsocket-secure.mod | 4 +- .../src/main/config/modules/unixsocket.mod | 9 +- .../src/main/config/modules/unixsocket.mod | 4 +- .../main/config/modules/console-capture.mod | 4 +- .../src/main/config/modules/webapp.mod | 4 +- .../src/main/config/modules/demo.mod | 5 + 97 files changed, 320 insertions(+), 243 deletions(-) diff --git a/apache-jsp/src/main/config/modules/apache-jsp.mod b/apache-jsp/src/main/config/modules/apache-jsp.mod index 7db151afa38..00e801cd81f 100644 --- a/apache-jsp/src/main/config/modules/apache-jsp.mod +++ b/apache-jsp/src/main/config/modules/apache-jsp.mod @@ -1,7 +1,7 @@ # DO NOT EDIT - See: https://www.eclipse.org/jetty/documentation/current/startup-modules.html [description] -Enables use of the apache implementation of JSP +Enables use of the apache implementation of JSP. [lib] lib/apache-jsp/*.jar diff --git a/apache-jstl/src/main/config/modules/apache-jstl.mod b/apache-jstl/src/main/config/modules/apache-jstl.mod index 7e20f56af21..de94202bebe 100644 --- a/apache-jstl/src/main/config/modules/apache-jstl.mod +++ b/apache-jstl/src/main/config/modules/apache-jstl.mod @@ -1,7 +1,7 @@ # DO NOT EDIT - See: https://www.eclipse.org/jetty/documentation/current/startup-modules.html [description] -Enables the apache version of JSTL +Enables the apache version of JSTL for all webapps. [lib] lib/apache-jstl/*.jar diff --git a/jetty-alpn/jetty-alpn-server/src/main/config/modules/alpn.mod b/jetty-alpn/jetty-alpn-server/src/main/config/modules/alpn.mod index 2c0dc5d1ccf..9fe36cb54b7 100644 --- a/jetty-alpn/jetty-alpn-server/src/main/config/modules/alpn.mod +++ b/jetty-alpn/jetty-alpn-server/src/main/config/modules/alpn.mod @@ -3,6 +3,11 @@ [description] Enables the ALPN (Application Layer Protocol Negotiation) TLS extension. +[tag] +connector +ssl +internal + [depend] ssl alpn-impl/alpn-${java.version.platform} diff --git a/jetty-cdi/src/main/config/modules/cdi-decorate.mod b/jetty-cdi/src/main/config/modules/cdi-decorate.mod index 0468a6a08a4..f222fa0fbaf 100644 --- a/jetty-cdi/src/main/config/modules/cdi-decorate.mod +++ b/jetty-cdi/src/main/config/modules/cdi-decorate.mod @@ -1,9 +1,8 @@ # DO NOT EDIT - See: https://www.eclipse.org/jetty/documentation/current/startup-modules.html [description] -Configures Jetty to use the "CdiDecoratingListener" as the default -CDI integration mode that allows a webapp to register it's own CDI -decorator. +Configures Jetty to use the "CdiDecoratingListener" as the default CDI mode. +This mode that allows a webapp to register it's own CDI decorator. [tag] cdi diff --git a/jetty-cdi/src/main/config/modules/cdi-spi.mod b/jetty-cdi/src/main/config/modules/cdi-spi.mod index 5002bf967db..c608e93e653 100644 --- a/jetty-cdi/src/main/config/modules/cdi-spi.mod +++ b/jetty-cdi/src/main/config/modules/cdi-spi.mod @@ -1,8 +1,8 @@ # DO NOT EDIT - See: https://www.eclipse.org/jetty/documentation/current/startup-modules.html [description] -Configures Jetty to use the "CdiSpiDecorator" that calls the CDI SPI -as the default CDI integration mode. +Configures Jetty to use the "CdiSpiDecorator" as the default CDI mode. +This mode uses the CDI SPI to integrate an arbitrary CDI implementation. [tag] cdi diff --git a/jetty-cdi/src/main/config/modules/cdi.mod b/jetty-cdi/src/main/config/modules/cdi.mod index 4388a4d42bf..235bc335e85 100644 --- a/jetty-cdi/src/main/config/modules/cdi.mod +++ b/jetty-cdi/src/main/config/modules/cdi.mod @@ -1,7 +1,7 @@ # DO NOT EDIT - See: https://www.eclipse.org/jetty/documentation/current/startup-modules.html [description] -Support for CDI inside the webapp. +Integration of CDI within webapp to Jetty container object lifecycles. This module does not provide CDI, but configures jetty to support various integration modes with a CDI implementation on the webapp classpath. CDI integration modes can be selected per webapp with the "org.eclipse.jetty.cdi" @@ -26,4 +26,4 @@ deploy etc/cdi/jetty-cdi.xml [lib] -lib/jetty-cdi-${jetty.version}.jar \ No newline at end of file +lib/jetty-cdi-${jetty.version}.jar diff --git a/jetty-deploy/src/main/config/modules/global-webapp-common.mod b/jetty-deploy/src/main/config/modules/global-webapp-common.mod index a4bc484f94d..d28cd1194ad 100644 --- a/jetty-deploy/src/main/config/modules/global-webapp-common.mod +++ b/jetty-deploy/src/main/config/modules/global-webapp-common.mod @@ -1,7 +1,7 @@ # DO NOT EDIT - See: https://www.eclipse.org/jetty/documentation/current/startup-modules.html [description] -Enables Deployer to apply common configuration to all webapp deployments +Enables Deployer to apply common configuration to all webapp deployments. [depend] deploy diff --git a/jetty-gcloud/jetty-gcloud-session-manager/src/main/config-template/modules/gcloud-datastore.mod b/jetty-gcloud/jetty-gcloud-session-manager/src/main/config-template/modules/gcloud-datastore.mod index 93f6d0d8e92..3e07c80cff1 100644 --- a/jetty-gcloud/jetty-gcloud-session-manager/src/main/config-template/modules/gcloud-datastore.mod +++ b/jetty-gcloud/jetty-gcloud-session-manager/src/main/config-template/modules/gcloud-datastore.mod @@ -1,7 +1,7 @@ # DO NOT EDIT - See: https://www.eclipse.org/jetty/documentation/current/startup-modules.html [description] -Enables GCloud Datastore API and implementation +Enables GCloud Datastore API and implementation. [tags] 3rdparty diff --git a/jetty-gcloud/jetty-gcloud-session-manager/src/main/config-template/modules/gcloud.mod b/jetty-gcloud/jetty-gcloud-session-manager/src/main/config-template/modules/gcloud.mod index 81dca523f8d..d9331b61310 100644 --- a/jetty-gcloud/jetty-gcloud-session-manager/src/main/config-template/modules/gcloud.mod +++ b/jetty-gcloud/jetty-gcloud-session-manager/src/main/config-template/modules/gcloud.mod @@ -1,7 +1,7 @@ # DO NOT EDIT - See: https://www.eclipse.org/jetty/documentation/current/startup-modules.html [description] -Control GCloud API classpath +Control GCloud API classpath. [tags] 3rdparty diff --git a/jetty-hazelcast/src/main/config/modules/session-store-hazelcast-embedded.mod b/jetty-hazelcast/src/main/config/modules/session-store-hazelcast-embedded.mod index d205f114a24..a7e4b4e9da3 100644 --- a/jetty-hazelcast/src/main/config/modules/session-store-hazelcast-embedded.mod +++ b/jetty-hazelcast/src/main/config/modules/session-store-hazelcast-embedded.mod @@ -1,7 +1,7 @@ # DO NOT EDIT - See: https://www.eclipse.org/jetty/documentation/current/startup-modules.html [description] -Enables session data store in an embedded Hazelcast Map +Enables session data store in an embedded Hazelcast Map. [tags] session diff --git a/jetty-hazelcast/src/main/config/modules/session-store-hazelcast-remote.mod b/jetty-hazelcast/src/main/config/modules/session-store-hazelcast-remote.mod index a398acf0d18..2d0f5ae1d82 100644 --- a/jetty-hazelcast/src/main/config/modules/session-store-hazelcast-remote.mod +++ b/jetty-hazelcast/src/main/config/modules/session-store-hazelcast-remote.mod @@ -1,7 +1,7 @@ # DO NOT EDIT - See: https://www.eclipse.org/jetty/documentation/current/startup-modules.html [description] -Enables session data store in a remote Hazelcast Map +Enables session data store in a remote Hazelcast Map. [tags] session diff --git a/jetty-home/src/main/resources/modules/conscrypt.mod b/jetty-home/src/main/resources/modules/conscrypt.mod index 2e1e7f50f1a..d39fe002efb 100644 --- a/jetty-home/src/main/resources/modules/conscrypt.mod +++ b/jetty-home/src/main/resources/modules/conscrypt.mod @@ -1,7 +1,7 @@ # DO NOT EDIT - See: https://www.eclipse.org/jetty/documentation/current/startup-modules.html [description] -Installs the Conscrypt JSSE provider +Installs the Conscrypt JSSE provider. [tags] 3rdparty diff --git a/jetty-home/src/main/resources/modules/jamon.mod b/jetty-home/src/main/resources/modules/jamon.mod index 21bac47de96..683cf60e716 100644 --- a/jetty-home/src/main/resources/modules/jamon.mod +++ b/jetty-home/src/main/resources/modules/jamon.mod @@ -1,7 +1,7 @@ # DO NOT EDIT - See: https://www.eclipse.org/jetty/documentation/current/startup-modules.html [description] -Deploys the JAMon webapplication +Deploys the JAMon webapplication. [tags] 3rdparty diff --git a/jetty-home/src/main/resources/modules/jminix.mod b/jetty-home/src/main/resources/modules/jminix.mod index fcf1c122709..7f9101f5fa8 100644 --- a/jetty-home/src/main/resources/modules/jminix.mod +++ b/jetty-home/src/main/resources/modules/jminix.mod @@ -1,7 +1,7 @@ # DO NOT EDIT - See: https://www.eclipse.org/jetty/documentation/current/startup-modules.html [description] -Deploys the Jminix JMX Console within the server +Deploys the Jminix JMX Console within the server. [tags] 3rdparty diff --git a/jetty-home/src/main/resources/modules/jstl.mod b/jetty-home/src/main/resources/modules/jstl.mod index 67c88f7d91f..df046c78d37 100644 --- a/jetty-home/src/main/resources/modules/jstl.mod +++ b/jetty-home/src/main/resources/modules/jstl.mod @@ -1,7 +1,7 @@ # DO NOT EDIT - See: https://www.eclipse.org/jetty/documentation/current/startup-modules.html [description] -Enables JSTL for all webapplications deployed on the server +Enables JSTL for all webapplications deployed on the server. [depend] jsp diff --git a/jetty-home/src/main/resources/modules/logging-jcl-capture.mod b/jetty-home/src/main/resources/modules/logging-jcl-capture.mod index 78f59c7fb1b..286f22033ec 100644 --- a/jetty-home/src/main/resources/modules/logging-jcl-capture.mod +++ b/jetty-home/src/main/resources/modules/logging-jcl-capture.mod @@ -1,7 +1,7 @@ # DO NOT EDIT - See: https://www.eclipse.org/jetty/documentation/current/startup-modules.html [description] -Capture jakarta-commons-logging events and bridge them to org.slf4j +Capture jakarta-commons-logging events and bridge them to SLF4J. [tags] logging diff --git a/jetty-home/src/main/resources/modules/logging-jetty.mod b/jetty-home/src/main/resources/modules/logging-jetty.mod index 71da0e34905..7b0d5e00bbf 100644 --- a/jetty-home/src/main/resources/modules/logging-jetty.mod +++ b/jetty-home/src/main/resources/modules/logging-jetty.mod @@ -1,7 +1,7 @@ # DO NOT EDIT - See: https://www.eclipse.org/jetty/documentation/current/startup-modules.html [description] -Configure jetty logging mechanism. +Base configuration for the jetty logging mechanism. Provides a ${jetty.base}/resources/jetty-logging.properties. [tags] diff --git a/jetty-home/src/main/resources/modules/logging-jul-capture.mod b/jetty-home/src/main/resources/modules/logging-jul-capture.mod index 5401a052c17..ba270d0f0a1 100644 --- a/jetty-home/src/main/resources/modules/logging-jul-capture.mod +++ b/jetty-home/src/main/resources/modules/logging-jul-capture.mod @@ -1,7 +1,7 @@ # DO NOT EDIT - See: https://www.eclipse.org/jetty/documentation/current/startup-modules.html [description] -Capture java.util.logging events and bridge them to org.slf4j +Capture java.util.logging events and bridge them to slf4j. [tags] logging diff --git a/jetty-home/src/main/resources/modules/logging-jul.mod b/jetty-home/src/main/resources/modules/logging-jul.mod index 4bf63a0924b..64409e4de52 100644 --- a/jetty-home/src/main/resources/modules/logging-jul.mod +++ b/jetty-home/src/main/resources/modules/logging-jul.mod @@ -1,7 +1,7 @@ # DO NOT EDIT - See: https://www.eclipse.org/jetty/documentation/current/startup-modules.html [description] -Configure jetty logging to use Java Util Logging (jul) +Configure jetty logging to use Java Util Logging (jul). SLF4J is used as the core logging mechanism. [tags] diff --git a/jetty-home/src/main/resources/modules/logging-log4j1-capture.mod b/jetty-home/src/main/resources/modules/logging-log4j1-capture.mod index 41dca46cf85..6e86163cae7 100644 --- a/jetty-home/src/main/resources/modules/logging-log4j1-capture.mod +++ b/jetty-home/src/main/resources/modules/logging-log4j1-capture.mod @@ -1,7 +1,7 @@ # DO NOT EDIT - See: https://www.eclipse.org/jetty/documentation/current/startup-modules.html [description] -Capture Apache log4j events and bridge them to org.slf4j +Capture Apache log4j events and bridge them to SLF4J. [tags] logging diff --git a/jetty-home/src/main/resources/modules/logging-log4j1.mod b/jetty-home/src/main/resources/modules/logging-log4j1.mod index ef7332070e7..0eb5b52f54a 100644 --- a/jetty-home/src/main/resources/modules/logging-log4j1.mod +++ b/jetty-home/src/main/resources/modules/logging-log4j1.mod @@ -1,7 +1,7 @@ # DO NOT EDIT - See: https://www.eclipse.org/jetty/documentation/current/startup-modules.html [description] -Configure jetty logging to use Log4j Logging +Configure jetty logging to use Log4j. SLF4J is used as the core logging mechanism. [tags] @@ -55,4 +55,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION -WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/jetty-home/src/main/resources/modules/logging-log4j2.mod b/jetty-home/src/main/resources/modules/logging-log4j2.mod index 784320b33ab..13f5e16d216 100644 --- a/jetty-home/src/main/resources/modules/logging-log4j2.mod +++ b/jetty-home/src/main/resources/modules/logging-log4j2.mod @@ -1,7 +1,7 @@ # DO NOT EDIT - See: https://www.eclipse.org/jetty/documentation/current/startup-modules.html [description] -Configure jetty logging to use log4j version 2 +Configure jetty logging to use log4j version 2. SLF4J is used as the core logging mechanism. [tags] diff --git a/jetty-home/src/main/resources/modules/logging-noop.mod b/jetty-home/src/main/resources/modules/logging-noop.mod index 2a8c3743c47..b064473f8b5 100644 --- a/jetty-home/src/main/resources/modules/logging-noop.mod +++ b/jetty-home/src/main/resources/modules/logging-noop.mod @@ -1,7 +1,7 @@ # DO NOT EDIT - See: https://www.eclipse.org/jetty/documentation/current/startup-modules.html [description] -Configure logging to use SLF4J No-Op Implementation +Configure logging to use SLF4J No-Op Implementation. [tags] logging diff --git a/jetty-home/src/main/resources/modules/logging/slf4j.mod b/jetty-home/src/main/resources/modules/logging/slf4j.mod index 67387a2c1f5..e1c64c86624 100644 --- a/jetty-home/src/main/resources/modules/logging/slf4j.mod +++ b/jetty-home/src/main/resources/modules/logging/slf4j.mod @@ -1,8 +1,9 @@ # DO NOT EDIT - See: https://www.eclipse.org/jetty/documentation/current/startup-modules.html [description] -Configure logging to use slf4j with no impl -(If you don't select an impl, then NOP will be used by slf4j) +Configure logging to use SLF4J. +A specific implementation of SLF4J is not enabled. +If one is not selected then NOP implementation will be used. [tags] logging diff --git a/jetty-home/src/main/resources/modules/setuid.mod b/jetty-home/src/main/resources/modules/setuid.mod index a50ed698b9f..1c5b98d6f2b 100644 --- a/jetty-home/src/main/resources/modules/setuid.mod +++ b/jetty-home/src/main/resources/modules/setuid.mod @@ -1,8 +1,8 @@ # DO NOT EDIT - See: https://www.eclipse.org/jetty/documentation/current/startup-modules.html [description] -Enables the unix setUID configuration so that the server -may be started as root to open privileged ports/files before +Enables the unix setUID configuration. +The server may be started as root to open privileged ports/files before changing to a restricted user (eg jetty). [depend] diff --git a/jetty-home/src/main/resources/modules/stop.mod b/jetty-home/src/main/resources/modules/stop.mod index 1352cc95463..11479d1dfb9 100644 --- a/jetty-home/src/main/resources/modules/stop.mod +++ b/jetty-home/src/main/resources/modules/stop.mod @@ -1,7 +1,8 @@ # DO NOT EDIT - See: https://www.eclipse.org/jetty/documentation/current/startup-modules.html [description] -This module causes jetty to stop immediately after starting. This is good for testing configuration and/or precompiling quickstart webapps +This module causes jetty to stop immediately after starting. +This is good for testing configuration and/or precompiling quickstart webapps [xml] etc/jetty-stop.xml diff --git a/jetty-http2/http2-server/src/main/config/modules/http2.mod b/jetty-http2/http2-server/src/main/config/modules/http2.mod index 46cb5961385..9a871e39139 100644 --- a/jetty-http2/http2-server/src/main/config/modules/http2.mod +++ b/jetty-http2/http2-server/src/main/config/modules/http2.mod @@ -1,8 +1,8 @@ # DO NOT EDIT - See: https://www.eclipse.org/jetty/documentation/current/startup-modules.html [description] -Enables HTTP2 protocol support on the TLS(SSL) Connector, -using the ALPN extension to select which protocol to use. +Enables HTTP2 protocol support on the TLS(SSL) Connector with ALPN. +Uses the ALPN extension to select which protocol to use. [tags] connector diff --git a/jetty-http2/http2-server/src/main/config/modules/http2c.mod b/jetty-http2/http2-server/src/main/config/modules/http2c.mod index aae7e6d342a..be9674850da 100644 --- a/jetty-http2/http2-server/src/main/config/modules/http2c.mod +++ b/jetty-http2/http2-server/src/main/config/modules/http2c.mod @@ -1,7 +1,7 @@ # DO NOT EDIT - See: https://www.eclipse.org/jetty/documentation/current/startup-modules.html [description] -Enables the HTTP2C protocol on the HTTP Connector +Enables the HTTP2C protocol on the HTTP Connector. The connector will accept both HTTP/1 and HTTP/2 connections. [tags] diff --git a/jetty-infinispan/infinispan-common/src/main/config/modules/sessions/infinispan/infinispan-common.mod b/jetty-infinispan/infinispan-common/src/main/config/modules/sessions/infinispan/infinispan-common.mod index 3c588cc1b5c..02a77867610 100644 --- a/jetty-infinispan/infinispan-common/src/main/config/modules/sessions/infinispan/infinispan-common.mod +++ b/jetty-infinispan/infinispan-common/src/main/config/modules/sessions/infinispan/infinispan-common.mod @@ -1,8 +1,9 @@ [description] -Common to all infinispan modules +Common to all infinispan modules. [tags] session +internal [depend] sessions diff --git a/jetty-infinispan/infinispan-embedded-query/src/main/config-template/modules/infinispan-embedded-query.mod b/jetty-infinispan/infinispan-embedded-query/src/main/config-template/modules/infinispan-embedded-query.mod index 60607ab4f5f..cfe27d68dc5 100644 --- a/jetty-infinispan/infinispan-embedded-query/src/main/config-template/modules/infinispan-embedded-query.mod +++ b/jetty-infinispan/infinispan-embedded-query/src/main/config-template/modules/infinispan-embedded-query.mod @@ -1,5 +1,5 @@ [description] -Enables querying with the Infinispan cache +Enables querying with the Infinispan session cache. [tags] session diff --git a/jetty-infinispan/infinispan-embedded-query/src/main/config-template/modules/sessions/infinispan/embedded/infinispan-embedded-query-libs.mod b/jetty-infinispan/infinispan-embedded-query/src/main/config-template/modules/sessions/infinispan/embedded/infinispan-embedded-query-libs.mod index 05f4038a0d2..73006897afb 100644 --- a/jetty-infinispan/infinispan-embedded-query/src/main/config-template/modules/sessions/infinispan/embedded/infinispan-embedded-query-libs.mod +++ b/jetty-infinispan/infinispan-embedded-query/src/main/config-template/modules/sessions/infinispan/embedded/infinispan-embedded-query-libs.mod @@ -1,5 +1,5 @@ [description] -The Infinispan query libraries +The Infinispan query libraries. [tags] 3rdparty diff --git a/jetty-infinispan/infinispan-embedded/src/main/config-templates/modules/infinispan-embedded.mod b/jetty-infinispan/infinispan-embedded/src/main/config-templates/modules/infinispan-embedded.mod index 8d5d0cfa25c..c6dcbfeadbd 100644 --- a/jetty-infinispan/infinispan-embedded/src/main/config-templates/modules/infinispan-embedded.mod +++ b/jetty-infinispan/infinispan-embedded/src/main/config-templates/modules/infinispan-embedded.mod @@ -1,5 +1,5 @@ [description] -Setup infinispan embedded without querying +Setup infinispan embedded without querying. [tags] session diff --git a/jetty-infinispan/infinispan-embedded/src/main/config-templates/modules/session-store-infinispan-embedded.mod b/jetty-infinispan/infinispan-embedded/src/main/config-templates/modules/session-store-infinispan-embedded.mod index 1d2e9da7b87..8466ac5f200 100644 --- a/jetty-infinispan/infinispan-embedded/src/main/config-templates/modules/session-store-infinispan-embedded.mod +++ b/jetty-infinispan/infinispan-embedded/src/main/config-templates/modules/session-store-infinispan-embedded.mod @@ -1,5 +1,5 @@ [description] -Enables session data store in a local Infinispan cache +Enables session data store in a local Infinispan cache. [tags] session diff --git a/jetty-infinispan/infinispan-embedded/src/main/config-templates/modules/sessions/infinispan/embedded/infinispan-embedded-libs.mod b/jetty-infinispan/infinispan-embedded/src/main/config-templates/modules/sessions/infinispan/embedded/infinispan-embedded-libs.mod index c8c02f8cae2..e5989bd02a1 100644 --- a/jetty-infinispan/infinispan-embedded/src/main/config-templates/modules/sessions/infinispan/embedded/infinispan-embedded-libs.mod +++ b/jetty-infinispan/infinispan-embedded/src/main/config-templates/modules/sessions/infinispan/embedded/infinispan-embedded-libs.mod @@ -1,9 +1,10 @@ [description] -The Infinispan embedded libraries +The Infinispan embedded libraries. [tags] 3rdparty infinispan +internal [depends] sessions/infinispan/embedded/infinispan-embedded-serverclasses diff --git a/jetty-infinispan/infinispan-embedded/src/main/config-templates/modules/sessions/infinispan/embedded/infinispan-embedded-serverclasses.mod b/jetty-infinispan/infinispan-embedded/src/main/config-templates/modules/sessions/infinispan/embedded/infinispan-embedded-serverclasses.mod index b36937e1c6c..6c369eb73e9 100644 --- a/jetty-infinispan/infinispan-embedded/src/main/config-templates/modules/sessions/infinispan/embedded/infinispan-embedded-serverclasses.mod +++ b/jetty-infinispan/infinispan-embedded/src/main/config-templates/modules/sessions/infinispan/embedded/infinispan-embedded-serverclasses.mod @@ -5,6 +5,7 @@ Hides Infinispan classes from webapp. session 3rdparty infinispan +internal [ini] diff --git a/jetty-infinispan/infinispan-remote-query/src/main/config-template/modules/infinispan-remote-query.mod b/jetty-infinispan/infinispan-remote-query/src/main/config-template/modules/infinispan-remote-query.mod index 7cb7c40ec30..a3bf8912052 100644 --- a/jetty-infinispan/infinispan-remote-query/src/main/config-template/modules/infinispan-remote-query.mod +++ b/jetty-infinispan/infinispan-remote-query/src/main/config-template/modules/infinispan-remote-query.mod @@ -1,5 +1,5 @@ [description] -Enables querying with a remote Infinispan cache +Enables querying with a remote Infinispan cache. [tags] session diff --git a/jetty-infinispan/infinispan-remote-query/src/main/config-template/modules/sessions/infinispan/remote/infinispan-remote-query-libs.mod b/jetty-infinispan/infinispan-remote-query/src/main/config-template/modules/sessions/infinispan/remote/infinispan-remote-query-libs.mod index 50cb76896f8..0f6d8704d32 100644 --- a/jetty-infinispan/infinispan-remote-query/src/main/config-template/modules/sessions/infinispan/remote/infinispan-remote-query-libs.mod +++ b/jetty-infinispan/infinispan-remote-query/src/main/config-template/modules/sessions/infinispan/remote/infinispan-remote-query-libs.mod @@ -1,9 +1,10 @@ [description] -The Infinispan remote query libraries +The Infinispan remote query libraries. [tags] 3rdparty infinispan +internal [license] Infinispan is an open source project hosted on Github and released under the Apache 2.0 license. diff --git a/jetty-infinispan/infinispan-remote/src/main/config-template/modules/infinispan-remote.mod b/jetty-infinispan/infinispan-remote/src/main/config-template/modules/infinispan-remote.mod index d55aa9c760a..75dd782734b 100644 --- a/jetty-infinispan/infinispan-remote/src/main/config-template/modules/infinispan-remote.mod +++ b/jetty-infinispan/infinispan-remote/src/main/config-template/modules/infinispan-remote.mod @@ -1,5 +1,5 @@ [description] -Default setup for the remote infinispan cache without queries +Default setup for the remote infinispan cache without queries. [tags] session diff --git a/jetty-infinispan/infinispan-remote/src/main/config-template/modules/session-store-infinispan-remote.mod b/jetty-infinispan/infinispan-remote/src/main/config-template/modules/session-store-infinispan-remote.mod index 95e033d10c6..e627553096a 100644 --- a/jetty-infinispan/infinispan-remote/src/main/config-template/modules/session-store-infinispan-remote.mod +++ b/jetty-infinispan/infinispan-remote/src/main/config-template/modules/session-store-infinispan-remote.mod @@ -1,5 +1,5 @@ [description] -Enables session data store in a remote Infinispan cache +Enables session data store in a remote Infinispan cache. [tags] session diff --git a/jetty-infinispan/infinispan-remote/src/main/config-template/modules/sessions/infinispan/remote/infinispan-remote-libs.mod b/jetty-infinispan/infinispan-remote/src/main/config-template/modules/sessions/infinispan/remote/infinispan-remote-libs.mod index 28820b94fd4..db097712eb4 100644 --- a/jetty-infinispan/infinispan-remote/src/main/config-template/modules/sessions/infinispan/remote/infinispan-remote-libs.mod +++ b/jetty-infinispan/infinispan-remote/src/main/config-template/modules/sessions/infinispan/remote/infinispan-remote-libs.mod @@ -1,9 +1,10 @@ [description] -The Infinispan remote libs +The Infinispan remote libs. [tags] 3rdparty infinispan +internal [depends] sessions/infinispan/remote/infinispan-remote-serverclasses diff --git a/jetty-jmx/src/main/config/modules/jmx-remote.mod b/jetty-jmx/src/main/config/modules/jmx-remote.mod index c3b64af94dc..ae3239f9f10 100644 --- a/jetty-jmx/src/main/config/modules/jmx-remote.mod +++ b/jetty-jmx/src/main/config/modules/jmx-remote.mod @@ -1,7 +1,7 @@ # DO NOT EDIT - See: https://www.eclipse.org/jetty/documentation/current/startup-modules.html [description] -Enables remote RMI access to JMX +Enables remote RMI access to JMX. [depend] jmx diff --git a/jetty-jmx/src/main/config/modules/jmx.mod b/jetty-jmx/src/main/config/modules/jmx.mod index 183e29c7778..f54ada52d34 100644 --- a/jetty-jmx/src/main/config/modules/jmx.mod +++ b/jetty-jmx/src/main/config/modules/jmx.mod @@ -1,8 +1,7 @@ # DO NOT EDIT - See: https://www.eclipse.org/jetty/documentation/current/startup-modules.html [description] -Enables JMX instrumentation for server beans and -enables JMX agent. +Enables JMX instrumentation for server beans and enables JMX agent. [depend] server diff --git a/jetty-maven-plugin/src/main/resources/maven.mod b/jetty-maven-plugin/src/main/resources/maven.mod index be5322b055e..9bdfe2f8ebb 100644 --- a/jetty-maven-plugin/src/main/resources/maven.mod +++ b/jetty-maven-plugin/src/main/resources/maven.mod @@ -1,7 +1,7 @@ # DO NOT EDIT - See: https://www.eclipse.org/jetty/documentation/current/startup-modules.html [description] -Enables an unassembled maven webapp to run in a jetty distro +Enables an unassembled maven webapp to run in a jetty distro. [depends] server diff --git a/jetty-memcached/jetty-memcached-sessions/src/main/config/modules/sessions/session-data-cache/xmemcached.mod b/jetty-memcached/jetty-memcached-sessions/src/main/config/modules/sessions/session-data-cache/xmemcached.mod index 8fc766168e6..e4498f3d94f 100644 --- a/jetty-memcached/jetty-memcached-sessions/src/main/config/modules/sessions/session-data-cache/xmemcached.mod +++ b/jetty-memcached/jetty-memcached-sessions/src/main/config/modules/sessions/session-data-cache/xmemcached.mod @@ -1,7 +1,7 @@ # DO NOT EDIT - See: https://www.eclipse.org/jetty/documentation/current/startup-modules.html [description] -Memcache cache for SessionData +Memcache cache for SessionData. [tags] session diff --git a/jetty-nosql/src/main/config/modules/sessions/mongo/address.mod b/jetty-nosql/src/main/config/modules/sessions/mongo/address.mod index 299c0898bee..4ba49715eaf 100644 --- a/jetty-nosql/src/main/config/modules/sessions/mongo/address.mod +++ b/jetty-nosql/src/main/config/modules/sessions/mongo/address.mod @@ -1,7 +1,7 @@ # DO NOT EDIT - See: https://www.eclipse.org/jetty/documentation/current/startup-modules.html [description] -Server/port address connections for session storage +Server/port connections for Mongo session storage. [xml] etc/sessions/mongo/session-store-by-address.xml diff --git a/jetty-nosql/src/main/config/modules/sessions/mongo/uri.mod b/jetty-nosql/src/main/config/modules/sessions/mongo/uri.mod index 8dd37d23086..220d33c4a8b 100644 --- a/jetty-nosql/src/main/config/modules/sessions/mongo/uri.mod +++ b/jetty-nosql/src/main/config/modules/sessions/mongo/uri.mod @@ -1,7 +1,7 @@ # DO NOT EDIT - See: https://www.eclipse.org/jetty/documentation/current/startup-modules.html [description] -MongoURI connections for session storage +MongoURI connections for Mongo session storage [xml] etc/sessions/mongo/session-store-by-uri.xml diff --git a/jetty-openid/src/main/config/modules/openid.mod b/jetty-openid/src/main/config/modules/openid.mod index fde0b9882e1..3929ebbdafa 100644 --- a/jetty-openid/src/main/config/modules/openid.mod +++ b/jetty-openid/src/main/config/modules/openid.mod @@ -41,4 +41,4 @@ etc/jetty-openid.xml # jetty.openid.authenticateNewUsers=false ## True if all certificates should be trusted by the default SslContextFactory -# jetty.openid.sslContextFactory.trustAll=false \ No newline at end of file +# jetty.openid.sslContextFactory.trustAll=false diff --git a/jetty-plus/src/main/config/modules/plus.mod b/jetty-plus/src/main/config/modules/plus.mod index 72d55f79a6e..e3d01582c51 100644 --- a/jetty-plus/src/main/config/modules/plus.mod +++ b/jetty-plus/src/main/config/modules/plus.mod @@ -1,6 +1,5 @@ [description] -Enables resource injection and other servlet 3.x -features not supported in the core jetty webapps module. +Enables Servlet 3.1 resource injection. [depend] server diff --git a/jetty-proxy/src/main/config/modules/proxy.mod b/jetty-proxy/src/main/config/modules/proxy.mod index 2518a83a30b..de54d3492c6 100644 --- a/jetty-proxy/src/main/config/modules/proxy.mod +++ b/jetty-proxy/src/main/config/modules/proxy.mod @@ -1,8 +1,8 @@ # DO NOT EDIT - See: https://www.eclipse.org/jetty/documentation/current/startup-modules.html [description] -Enable the Jetty Proxy, that allows the server to act -as a non-transparent proxy for browsers. +Enable the Jetty Proxy. +Allows the server to act as a non-transparent proxy for browsers. [depend] servlet diff --git a/jetty-quickstart/src/main/config/modules/quickstart.mod b/jetty-quickstart/src/main/config/modules/quickstart.mod index a7f12e84f02..6ebbfb87b08 100644 --- a/jetty-quickstart/src/main/config/modules/quickstart.mod +++ b/jetty-quickstart/src/main/config/modules/quickstart.mod @@ -1,8 +1,7 @@ # DO NOT EDIT - See: https://www.eclipse.org/jetty/documentation/current/startup-modules.html [description] -Enables the Jetty Quickstart module for rapid -deployment of preconfigured webapplications. +Enables the Jetty Quickstart module for rapid deployment of preconfigured webapplications. [depend] server diff --git a/jetty-rewrite/src/main/config/modules/rewrite-compactpath.mod b/jetty-rewrite/src/main/config/modules/rewrite-compactpath.mod index 57b25d19a34..d5423a042bd 100644 --- a/jetty-rewrite/src/main/config/modules/rewrite-compactpath.mod +++ b/jetty-rewrite/src/main/config/modules/rewrite-compactpath.mod @@ -1,8 +1,8 @@ # DO NOT EDIT - See: https://www.eclipse.org/jetty/documentation/current/startup-modules.html [description] -Add a rule to the rewrite module to compact paths so that double slashes -in the path are treated as a single slash. +Add a rule to the rewrite module to compact paths. +Double slashes in the path are treated as a single slash. [depends] rewrite diff --git a/jetty-rewrite/src/main/config/modules/rewrite-customizer.mod b/jetty-rewrite/src/main/config/modules/rewrite-customizer.mod index a1231ca8def..0c2226b909e 100644 --- a/jetty-rewrite/src/main/config/modules/rewrite-customizer.mod +++ b/jetty-rewrite/src/main/config/modules/rewrite-customizer.mod @@ -1,8 +1,8 @@ # DO NOT EDIT - See: https://www.eclipse.org/jetty/documentation/current/startup-modules.html [description] -Enables a rewrite Rules container as a request customizer on -the servers default HttpConfiguration instance +Enables a rewrite Rules container as a request customizer. +Enabled on the servers default HttpConfiguration instance [provides] rewrite diff --git a/jetty-rewrite/src/main/config/modules/rewrite.mod b/jetty-rewrite/src/main/config/modules/rewrite.mod index 3d9bb91b074..2d7c7a7f6ba 100644 --- a/jetty-rewrite/src/main/config/modules/rewrite.mod +++ b/jetty-rewrite/src/main/config/modules/rewrite.mod @@ -1,8 +1,11 @@ # DO NOT EDIT - See: https://www.eclipse.org/jetty/documentation/current/startup-modules.html [description] -Enables the jetty-rewrite handler. Specific rewrite -rules must be added to either to etc/jetty-rewrite.xml or a custom xml/module +Enables the jetty-rewrite handler. +Specific rewrite rules must be added to either to etc/jetty-rewrite.xml or a custom xml/module + +[tags] +server [provides] rewrite|default diff --git a/jetty-server/src/main/config/modules/acceptratelimit.mod b/jetty-server/src/main/config/modules/acceptratelimit.mod index dae63e51812..2e47e2e5a29 100644 --- a/jetty-server/src/main/config/modules/acceptratelimit.mod +++ b/jetty-server/src/main/config/modules/acceptratelimit.mod @@ -1,7 +1,7 @@ # DO NOT EDIT - See: https://www.eclipse.org/jetty/documentation/current/startup-modules.html [description] -Enable a server wide accept rate limit +Enable a server wide accept rate limit. [tags] connector diff --git a/jetty-server/src/main/config/modules/connectionlimit.mod b/jetty-server/src/main/config/modules/connectionlimit.mod index a0113a62fb4..37070b47b07 100644 --- a/jetty-server/src/main/config/modules/connectionlimit.mod +++ b/jetty-server/src/main/config/modules/connectionlimit.mod @@ -1,7 +1,7 @@ # DO NOT EDIT - See: https://www.eclipse.org/jetty/documentation/current/startup-modules.html [description] -Enable a server wide connection limit +Enable a server wide connection limit. [tags] connector diff --git a/jetty-server/src/main/config/modules/customrequestlog.mod b/jetty-server/src/main/config/modules/customrequestlog.mod index b1c3288de9c..7305c6f4e2c 100644 --- a/jetty-server/src/main/config/modules/customrequestlog.mod +++ b/jetty-server/src/main/config/modules/customrequestlog.mod @@ -1,10 +1,11 @@ # DO NOT EDIT - See: https://www.eclipse.org/jetty/documentation/current/startup-modules.html [description] -Deprecated name for requestlog using custom request logger +Deprecated name for requestlog using custom request logger. [tags] requestlog +internal [depends] requestlog diff --git a/jetty-server/src/main/config/modules/debug.mod b/jetty-server/src/main/config/modules/debug.mod index 177da05126e..c92e9fbd42e 100644 --- a/jetty-server/src/main/config/modules/debug.mod +++ b/jetty-server/src/main/config/modules/debug.mod @@ -1,11 +1,12 @@ # DO NOT EDIT - See: https://www.eclipse.org/jetty/documentation/current/startup-modules.html [description] -Enables the DebugListener to generate additional -logging regarding detailed request handling events. +Enables the DebugListener. +Generates additional logging regarding detailed request handling events. Renames threads to include request URI. [tags] +server debug [depend] diff --git a/jetty-server/src/main/config/modules/debuglog.mod b/jetty-server/src/main/config/modules/debuglog.mod index 91a2d61c61d..b75a9db7189 100644 --- a/jetty-server/src/main/config/modules/debuglog.mod +++ b/jetty-server/src/main/config/modules/debuglog.mod @@ -5,7 +5,9 @@ Deprecated Debug Log using the DebugHandle. Replaced with the debug module. [tags] +server debug +internal [depend] server diff --git a/jetty-server/src/main/config/modules/ext.mod b/jetty-server/src/main/config/modules/ext.mod index 6808de49f82..f0ec6d1db13 100644 --- a/jetty-server/src/main/config/modules/ext.mod +++ b/jetty-server/src/main/config/modules/ext.mod @@ -1,8 +1,7 @@ # DO NOT EDIT - See: https://www.eclipse.org/jetty/documentation/current/startup-modules.html [description] -Adds all jar files discovered in $JETTY_HOME/lib/ext -and $JETTY_BASE/lib/ext to the servers classpath. +Adds jar from $JETTY_HOME/lib/ext and $JETTY_BASE/lib/ext to the servers classpath. [tags] classpath diff --git a/jetty-server/src/main/config/modules/flight-recorder.mod b/jetty-server/src/main/config/modules/flight-recorder.mod index 219173de27e..02facb05367 100644 --- a/jetty-server/src/main/config/modules/flight-recorder.mod +++ b/jetty-server/src/main/config/modules/flight-recorder.mod @@ -1,4 +1,5 @@ -# Enables Java Mission Control's Flight Recorder for low overhead profiling. +[description] +Enables Java Mission Control's Flight Recorder for low overhead profiling. [depend] server diff --git a/jetty-server/src/main/config/modules/gzip.mod b/jetty-server/src/main/config/modules/gzip.mod index 50fa8302865..5eb4beef87f 100644 --- a/jetty-server/src/main/config/modules/gzip.mod +++ b/jetty-server/src/main/config/modules/gzip.mod @@ -5,6 +5,7 @@ Enable GzipHandler for dynamic gzip compression for the entire server. If MSIE prior to version 7 are to be handled, also enable the msie module. [tags] +server handler [depend] diff --git a/jetty-server/src/main/config/modules/home-base-warning.mod b/jetty-server/src/main/config/modules/home-base-warning.mod index 84300662d5c..0e848406d52 100644 --- a/jetty-server/src/main/config/modules/home-base-warning.mod +++ b/jetty-server/src/main/config/modules/home-base-warning.mod @@ -1,8 +1,7 @@ # DO NOT EDIT - See: https://www.eclipse.org/jetty/documentation/current/startup-modules.html [description] -Generates a warning that server has been run from $JETTY_HOME -rather than from a $JETTY_BASE. +Generates a warning that server has been run from $JETTY_HOME rather than from a $JETTY_BASE. [xml] etc/home-base-warning.xml diff --git a/jetty-server/src/main/config/modules/http-forwarded.mod b/jetty-server/src/main/config/modules/http-forwarded.mod index 8591df5ed5d..0dea28ce753 100644 --- a/jetty-server/src/main/config/modules/http-forwarded.mod +++ b/jetty-server/src/main/config/modules/http-forwarded.mod @@ -1,8 +1,8 @@ # DO NOT EDIT - See: https://www.eclipse.org/jetty/documentation/current/startup-modules.html [description] -Adds a forwarded request customizer to the HTTP Connector -to process forwarded-for style headers from a proxy. +Adds a forwarded request customizer to the HTTP Connector. +Processes forwarded-for style headers from a proxy. [tags] connector diff --git a/jetty-server/src/main/config/modules/https.mod b/jetty-server/src/main/config/modules/https.mod index b316a2edd41..53b4d6330d5 100644 --- a/jetty-server/src/main/config/modules/https.mod +++ b/jetty-server/src/main/config/modules/https.mod @@ -1,7 +1,7 @@ # DO NOT EDIT - See: https://www.eclipse.org/jetty/documentation/current/startup-modules.html [description] -Adds HTTPS protocol support to the TLS(SSL) Connector +Adds HTTPS protocol support to the TLS(SSL) Connector. [tags] connector diff --git a/jetty-server/src/main/config/modules/inetaccess.mod b/jetty-server/src/main/config/modules/inetaccess.mod index 509be53d672..51e1e045218 100644 --- a/jetty-server/src/main/config/modules/inetaccess.mod +++ b/jetty-server/src/main/config/modules/inetaccess.mod @@ -1,11 +1,11 @@ # DO NOT EDIT - See: https://www.eclipse.org/jetty/documentation/current/startup-modules.html [description] -Enable the InetAccessHandler to apply a include/exclude -control of the remote IP of requests. +Enable the InetAccessHandler. +Applies a include/exclude control of the remote IP of requests. [tags] -handler +connector [depend] server diff --git a/jetty-server/src/main/config/modules/jdbc.mod b/jetty-server/src/main/config/modules/jdbc.mod index 98e57541408..529037e7661 100644 --- a/jetty-server/src/main/config/modules/jdbc.mod +++ b/jetty-server/src/main/config/modules/jdbc.mod @@ -1,4 +1,10 @@ # DO NOT EDIT - See: https://www.eclipse.org/jetty/documentation/current/startup-modules.html +[description] +Enable java.sql JPMS module. + +[tags] +jpms + [jpms] add-modules: java.sql diff --git a/jetty-server/src/main/config/modules/jvm.mod b/jetty-server/src/main/config/modules/jvm.mod index 04a528535d7..959ab24e8f7 100644 --- a/jetty-server/src/main/config/modules/jvm.mod +++ b/jetty-server/src/main/config/modules/jvm.mod @@ -1,8 +1,7 @@ # DO NOT EDIT - See: https://www.eclipse.org/jetty/documentation/current/startup-modules.html [description] -A noop module that creates an ini template useful for -setting JVM arguments (eg -Xmx ) +A module that creates an ini template for setting JVM arguments (eg -Xmx ). [ini-template] ## JVM Configuration diff --git a/jetty-server/src/main/config/modules/lowresources.mod b/jetty-server/src/main/config/modules/lowresources.mod index 576776078dc..0ef32e3be8b 100644 --- a/jetty-server/src/main/config/modules/lowresources.mod +++ b/jetty-server/src/main/config/modules/lowresources.mod @@ -1,8 +1,8 @@ # DO NOT EDIT - See: https://www.eclipse.org/jetty/documentation/current/startup-modules.html [description] -Enables a low resource monitor on the server -that can take actions if threads and/or connections +Enables a low resource monitor on the server. +Can take actions if threads and/or connections cross configured threshholds. [depend] diff --git a/jetty-server/src/main/config/modules/requestlog.mod b/jetty-server/src/main/config/modules/requestlog.mod index eb77754539e..45591f01485 100644 --- a/jetty-server/src/main/config/modules/requestlog.mod +++ b/jetty-server/src/main/config/modules/requestlog.mod @@ -1,7 +1,7 @@ # DO NOT EDIT - See: https://www.eclipse.org/jetty/documentation/current/startup-modules.html [description] -Log requests using CustomRequestLog and AsyncRequestLogWriter +Log requests using CustomRequestLog and AsyncRequestLogWriter. [tags] requestlog diff --git a/jetty-server/src/main/config/modules/resources.mod b/jetty-server/src/main/config/modules/resources.mod index 0a762a1db81..ae04265ffc5 100644 --- a/jetty-server/src/main/config/modules/resources.mod +++ b/jetty-server/src/main/config/modules/resources.mod @@ -1,9 +1,8 @@ # DO NOT EDIT - See: https://www.eclipse.org/jetty/documentation/current/startup-modules.html [description] -Adds the $JETTY_HOME/resources and/or $JETTY_BASE/resources -directory to the server classpath. Useful for configuration -property files (eg jetty-logging.properties) +Adds the $JETTY_HOME/resources and/or $JETTY_BASE/resources directory to the server classpath. +Useful for configuration property files (eg jetty-logging.properties) [tags] classpath diff --git a/jetty-server/src/main/config/modules/session-cache-hash.mod b/jetty-server/src/main/config/modules/session-cache-hash.mod index a420d692229..8a06cfa241d 100644 --- a/jetty-server/src/main/config/modules/session-cache-hash.mod +++ b/jetty-server/src/main/config/modules/session-cache-hash.mod @@ -1,7 +1,8 @@ # DO NOT EDIT - See: https://www.eclipse.org/jetty/documentation/current/startup-modules.html [description] -Enable first level session cache. If this module is not enabled, sessions will +Enable first level session cache. +If this module is not enabled, sessions will use the DefaultSessionCache by default, so enabling via this module is only needed if the configuration properties need to be changed from their defaults. diff --git a/jetty-server/src/main/config/modules/session-cache-null.mod b/jetty-server/src/main/config/modules/session-cache-null.mod index c556dbf980e..a851d17e73b 100644 --- a/jetty-server/src/main/config/modules/session-cache-null.mod +++ b/jetty-server/src/main/config/modules/session-cache-null.mod @@ -1,7 +1,7 @@ # DO NOT EDIT - See: https://www.eclipse.org/jetty/documentation/current/startup-modules.html [description] -A trivial SessionCache that does not actually cache sessions. +A SessionCache that does not actually cache sessions. [tags] session @@ -18,4 +18,4 @@ etc/sessions/session-cache-null.xml [ini-template] #jetty.session.saveOnCreate=false #jetty.session.removeUnloadableSessions=false -#jetty.session.flushOnResponseCommit=false \ No newline at end of file +#jetty.session.flushOnResponseCommit=false diff --git a/jetty-server/src/main/config/modules/sessions.mod b/jetty-server/src/main/config/modules/sessions.mod index ef7b38df18c..41063eb1b71 100644 --- a/jetty-server/src/main/config/modules/sessions.mod +++ b/jetty-server/src/main/config/modules/sessions.mod @@ -1,11 +1,10 @@ # DO NOT EDIT - See: https://www.eclipse.org/jetty/documentation/current/startup-modules.html [description] -The session management. By enabling this module, it allows -session management to be configured via the ini templates -created or by enabling other session-cache or session-store -modules. Without this module enabled, the server may still -use sessions, but their management cannot be configured. +Enable session management. +By enabling this module, it allows session management to be configured via the ini templates +created or by enabling other session-cache or session-store modules. Without this module enabled, +the server may still use sessions, but their management cannot be configured. [tags] session diff --git a/jetty-server/src/main/config/modules/sessions/jdbc/datasource.mod b/jetty-server/src/main/config/modules/sessions/jdbc/datasource.mod index c5edc432e39..0ae4d1e9868 100644 --- a/jetty-server/src/main/config/modules/sessions/jdbc/datasource.mod +++ b/jetty-server/src/main/config/modules/sessions/jdbc/datasource.mod @@ -1,7 +1,7 @@ # DO NOT EDIT - See: https://www.eclipse.org/jetty/documentation/current/startup-modules.html [description] -JDBC Datasource connections for session storage +JDBC Datasource connections for session storage. [depends] jdbc diff --git a/jetty-server/src/main/config/modules/sessions/jdbc/driver.mod b/jetty-server/src/main/config/modules/sessions/jdbc/driver.mod index 6c42abfe6bd..89f361c09c5 100644 --- a/jetty-server/src/main/config/modules/sessions/jdbc/driver.mod +++ b/jetty-server/src/main/config/modules/sessions/jdbc/driver.mod @@ -1,7 +1,7 @@ # DO NOT EDIT - See: https://www.eclipse.org/jetty/documentation/current/startup-modules.html [description] -JDBC Driver connections for session storage +JDBC Driver connections for session storage. [depend] jdbc diff --git a/jetty-server/src/main/config/modules/ssl-reload.mod b/jetty-server/src/main/config/modules/ssl-reload.mod index acddb16a4c7..03f641e8a9f 100644 --- a/jetty-server/src/main/config/modules/ssl-reload.mod +++ b/jetty-server/src/main/config/modules/ssl-reload.mod @@ -15,4 +15,4 @@ etc/jetty-ssl-context-reload.xml [ini-template] # Monitored directory scan period (seconds) -# jetty.sslContext.reload.scanInterval=1 \ No newline at end of file +# jetty.sslContext.reload.scanInterval=1 diff --git a/jetty-server/src/main/config/modules/ssl.mod b/jetty-server/src/main/config/modules/ssl.mod index c0eaa0a1481..6ef55a216e6 100644 --- a/jetty-server/src/main/config/modules/ssl.mod +++ b/jetty-server/src/main/config/modules/ssl.mod @@ -8,6 +8,7 @@ the associated support modules. [tags] connector ssl +internal [depend] server diff --git a/jetty-server/src/main/config/modules/stats.mod b/jetty-server/src/main/config/modules/stats.mod index a6289c4174b..410c498f890 100644 --- a/jetty-server/src/main/config/modules/stats.mod +++ b/jetty-server/src/main/config/modules/stats.mod @@ -1,11 +1,10 @@ # DO NOT EDIT - See: https://www.eclipse.org/jetty/documentation/current/startup-modules.html [description] -Enable detailed statistics collection for the server, -available via JMX. +Enable detailed statistics collection for the server. [tags] -handler +server [depend] server diff --git a/jetty-server/src/main/config/modules/test-keystore.mod b/jetty-server/src/main/config/modules/test-keystore.mod index 42dd6a0a90c..b74c0e0e30e 100644 --- a/jetty-server/src/main/config/modules/test-keystore.mod +++ b/jetty-server/src/main/config/modules/test-keystore.mod @@ -3,6 +3,7 @@ Test keystore with test SSL Certificate. DO NOT USE IN PRODUCTION!!! [tags] +demo ssl [depend] diff --git a/jetty-server/src/main/config/modules/threadlimit.mod b/jetty-server/src/main/config/modules/threadlimit.mod index 247d8348f93..44d33a45d48 100644 --- a/jetty-server/src/main/config/modules/threadlimit.mod +++ b/jetty-server/src/main/config/modules/threadlimit.mod @@ -4,7 +4,10 @@ # [tags] -handler +server + +[description] +Limit the threads per IP address for DOS protection. [depend] server diff --git a/jetty-server/src/main/config/modules/threadpool.mod b/jetty-server/src/main/config/modules/threadpool.mod index 20d24a76ad6..360e523296c 100644 --- a/jetty-server/src/main/config/modules/threadpool.mod +++ b/jetty-server/src/main/config/modules/threadpool.mod @@ -1,7 +1,7 @@ # DO NOT EDIT - See: https://www.eclipse.org/jetty/documentation/current/startup-modules.html [description] -Enables the Server thread pool. +Enables and configures the Server thread pool. [depends] logging diff --git a/jetty-servlets/src/main/config/modules/servlets.mod b/jetty-servlets/src/main/config/modules/servlets.mod index c79b5b01751..d7b8fa66b38 100644 --- a/jetty-servlets/src/main/config/modules/servlets.mod +++ b/jetty-servlets/src/main/config/modules/servlets.mod @@ -1,10 +1,9 @@ # DO NOT EDIT - See: https://www.eclipse.org/jetty/documentation/current/startup-modules.html [description] -Puts a collection of jetty utility servlets and filters -on the server classpath (CGI, CrossOriginFilter, DosFilter, -MultiPartFilter, PushCacheFilter, QoSFilter, etc.) for -use by all webapplications. +Jetty utility servlets and filters available to a webapp. +Puts org.eclipse.jetty.servlets on the server classpath (CGI, CrossOriginFilter, DosFilter, +MultiPartFilter, PushCacheFilter, QoSFilter, etc.) for use by all webapplications. [depend] servlet diff --git a/jetty-spring/src/main/config/modules/spring.mod b/jetty-spring/src/main/config/modules/spring.mod index 17ea36269f5..b09939c125c 100644 --- a/jetty-spring/src/main/config/modules/spring.mod +++ b/jetty-spring/src/main/config/modules/spring.mod @@ -1,8 +1,8 @@ # DO NOT EDIT - See: https://www.eclipse.org/jetty/documentation/current/startup-modules.html [description] -Enable spring configuration processing so all jetty style -xml files can optionally be written as spring beans +Enable spring configuration processing of jetty XML files. +All jetty style xml files can optionally be written as spring beans [depend] server diff --git a/jetty-start/src/main/java/org/eclipse/jetty/start/Main.java b/jetty-start/src/main/java/org/eclipse/jetty/start/Main.java index aadecdff5bc..8df5d68e329 100644 --- a/jetty-start/src/main/java/org/eclipse/jetty/start/Main.java +++ b/jetty-start/src/main/java/org/eclipse/jetty/start/Main.java @@ -221,6 +221,10 @@ public class Main public void listConfig(StartArgs args) { StartLog.endStartLog(); + Modules modules = args.getAllModules(); + + // Dump Enabled Modules + modules.listEnabled(); // Dump Jetty Home / Base args.dumpEnvironment(); @@ -244,20 +248,17 @@ public class Main public void listModules(StartArgs args) { final List tags = args.getListModules(); - StartLog.endStartLog(); - System.out.println(); - System.out.println("Available Modules:"); - System.out.println("=================="); - System.out.println("tags: " + tags); - args.getAllModules().dump(tags); + String t = tags.toString(); + System.out.printf("%nModules %s:%n", t); + System.out.printf("=========%s%n", "=".repeat(t.length())); + args.getAllModules().listModules(tags); + } - // Dump Enabled Modules - System.out.println(); - System.out.println("Enabled Modules:"); - System.out.println("================"); - Modules modules = args.getAllModules(); - modules.dumpEnabled(); + public void showModules(StartArgs args) + { + StartLog.endStartLog(); + args.getAllModules().showModules(args.getShowModules()); } /** @@ -388,12 +389,18 @@ public class Main listConfig(args); } - // Show modules + // List modules if (args.getListModules() != null) { listModules(args); } + // Show modules + if (args.getShowModules() != null) + { + showModules(args); + } + // Generate Module Graph File if (args.getModuleGraphFilename() != null) { diff --git a/jetty-start/src/main/java/org/eclipse/jetty/start/Module.java b/jetty-start/src/main/java/org/eclipse/jetty/start/Module.java index 2d215c2ec57..6e4d9ceb68d 100644 --- a/jetty-start/src/main/java/org/eclipse/jetty/start/Module.java +++ b/jetty-start/src/main/java/org/eclipse/jetty/start/Module.java @@ -529,7 +529,7 @@ public class Module implements Comparable public String getPrimaryTag() { - return _tags.isEmpty() ? "*" : _tags.get(0); + return _tags.isEmpty() ? "untagged" : _tags.get(0); } public boolean isEnabled() diff --git a/jetty-start/src/main/java/org/eclipse/jetty/start/Modules.java b/jetty-start/src/main/java/org/eclipse/jetty/start/Modules.java index 3e3c200beda..95e011d7e90 100644 --- a/jetty-start/src/main/java/org/eclipse/jetty/start/Modules.java +++ b/jetty-start/src/main/java/org/eclipse/jetty/start/Modules.java @@ -24,6 +24,7 @@ import java.nio.file.Files; import java.nio.file.Path; import java.util.ArrayList; import java.util.Collections; +import java.util.Comparator; import java.util.HashMap; import java.util.HashSet; import java.util.Iterator; @@ -35,6 +36,7 @@ import java.util.Set; import java.util.concurrent.atomic.AtomicBoolean; import java.util.concurrent.atomic.AtomicReference; import java.util.function.Consumer; +import java.util.function.Predicate; import java.util.stream.Collectors; import java.util.stream.Stream; @@ -82,104 +84,130 @@ public class Modules implements Iterable } } - public void dump(List tags) + public void showModules(List modules) { - Set exclude = tags.stream().filter(t -> t.startsWith("-")).map(t -> t.substring(1)).collect(Collectors.toSet()); - Set include = tags.stream().filter(t -> !t.startsWith("-")).collect(Collectors.toSet()); - boolean all = include.contains("*") || include.isEmpty(); - AtomicReference tag = new AtomicReference<>(); + Stream stream = (modules.contains("*") || modules.isEmpty()) + ? _modules.stream().sorted() + : modules.stream().map(this::get); - _modules.stream() - .filter(m -> - { - boolean included = all || m.getTags().stream().anyMatch(include::contains); - boolean excluded = m.getTags().stream().anyMatch(exclude::contains); - return included && !excluded; - }) - .sorted() - .forEach(module -> - { - if (!module.getPrimaryTag().equals(tag.get())) - { - tag.set(module.getPrimaryTag()); - System.out.printf("%nModules for tag '%s':%n", module.getPrimaryTag()); - System.out.print("-------------------"); - for (int i = module.getPrimaryTag().length(); i-- > 0; ) - { - System.out.print("-"); - } - System.out.println(); - } + stream.forEach(module -> + { + if (module == null) + return; - String label; - Set provides = module.getProvides(); - provides.remove(module.getName()); - System.out.printf("%n Module: %s %s%n", module.getName(), provides.size() > 0 ? provides : ""); - for (String description : module.getDescription()) + String label; + Set provides = module.getProvides(); + provides.remove(module.getName()); + System.out.printf("%n Module: %s %s%n", module.getName(), provides.size() > 0 ? provides : ""); + for (String description : module.getDescription()) + { + System.out.printf(" : %s%n", description); + } + if (!module.getTags().isEmpty()) + { + label = " Tags: %s"; + for (String t : module.getTags()) { - System.out.printf(" : %s%n", description); + System.out.printf(label, t); + label = ", %s"; } - if (!module.getTags().isEmpty()) + System.out.println(); + } + if (!module.getDepends().isEmpty()) + { + label = " Depend: %s"; + for (String parent : module.getDepends()) { - label = " Tags: %s"; - for (String t : module.getTags()) - { - System.out.printf(label, t); - label = ", %s"; - } - System.out.println(); + parent = Module.normalizeModuleName(parent); + System.out.printf(label, parent); + if (Module.isConditionalDependency(parent)) + System.out.print(" [conditional]"); + label = ", %s"; } - if (!module.getDepends().isEmpty()) + System.out.println(); + } + if (!module.getOptional().isEmpty()) + { + label = " Optional: %s"; + for (String parent : module.getOptional()) { - label = " Depend: %s"; - for (String parent : module.getDepends()) - { - parent = Module.normalizeModuleName(parent); - System.out.printf(label, parent); - if (Module.isConditionalDependency(parent)) - System.out.print(" [conditional]"); - label = ", %s"; - } - System.out.println(); + System.out.printf(label, parent); + label = ", %s"; } - if (!module.getOptional().isEmpty()) + System.out.println(); + } + for (String lib : module.getLibs()) + { + System.out.printf(" LIB: %s%n", lib); + } + for (String xml : module.getXmls()) + { + System.out.printf(" XML: %s%n", xml); + } + for (String jpms : module.getJPMS()) + { + System.out.printf(" JPMS: %s%n", jpms); + } + for (String jvm : module.getJvmArgs()) + { + System.out.printf(" JVM: %s%n", jvm); + } + if (module.isEnabled()) + { + for (String selection : module.getEnableSources()) { - label = " Optional: %s"; - for (String parent : module.getOptional()) - { - System.out.printf(label, parent); - label = ", %s"; - } - System.out.println(); + System.out.printf(" Enabled: %s%n", selection); } - for (String lib : module.getLibs()) - { - System.out.printf(" LIB: %s%n", lib); - } - for (String xml : module.getXmls()) - { - System.out.printf(" XML: %s%n", xml); - } - for (String jpms : module.getJPMS()) - { - System.out.printf(" JPMS: %s%n", jpms); - } - for (String jvm : module.getJvmArgs()) - { - System.out.printf(" JVM: %s%n", jvm); - } - if (module.isEnabled()) - { - for (String selection : module.getEnableSources()) - { - System.out.printf(" Enabled: %s%n", selection); - } - } - }); + } + }); } - public void dumpEnabled() + public void listModules(List tags) { + if (tags.contains("-*")) + return; + + boolean wild = tags.contains("*"); + Set included = new HashSet<>(); + if (wild) + tags.remove("*"); + else + tags.stream().filter(t -> !t.startsWith("-")).forEach(included::add); + Set excluded = new HashSet<>(); + tags.stream().filter(t -> t.startsWith("-")).map(t -> t.substring(1)).forEach(excluded::add); + if (!included.contains("internal")) + excluded.add("internal"); + + Predicate filter = m -> (included.isEmpty() || m.getTags().stream().anyMatch(included::contains)) && + !m.getTags().stream().anyMatch(excluded::contains); + + Optional max = _modules.stream().filter(filter).map(Module::getName).map(String::length).max(Integer::compareTo); + if (max.isEmpty()) + return; + String format = "%" + max.get() + "s - %s%n"; + + Comparator comparator = wild ? Comparator.comparing(Module::getName) : Module::compareTo; + AtomicReference tag = new AtomicReference<>(); + _modules.stream().filter(filter).sorted(comparator).forEach(module -> + { + if (!wild && !module.getPrimaryTag().equals(tag.get())) + { + tag.set(module.getPrimaryTag()); + System.out.printf("%n%s modules:", module.getPrimaryTag()); + System.out.printf("%n%s---------%n", "-".repeat(module.getPrimaryTag().length())); + } + + List description = module.getDescription(); + System.out.printf(format, module.getName(), description != null && description.size() > 0 ? description.get(0) : ""); + }); + } + + public void listEnabled() + { + System.out.println(); + System.out.println("Enabled Modules:"); + System.out.println("----------------"); + int i = 0; List enabled = getEnabled(); for (Module module : enabled) diff --git a/jetty-start/src/main/java/org/eclipse/jetty/start/StartArgs.java b/jetty-start/src/main/java/org/eclipse/jetty/start/StartArgs.java index 16ac7fce248..53f369bbd02 100644 --- a/jetty-start/src/main/java/org/eclipse/jetty/start/StartArgs.java +++ b/jetty-start/src/main/java/org/eclipse/jetty/start/StartArgs.java @@ -223,6 +223,7 @@ public class StartArgs private boolean help = false; private boolean stopCommand = false; private List listModules = null; + private List showModules = null; private boolean listClasspath = false; private boolean listConfig = false; private boolean version = false; @@ -346,7 +347,6 @@ public class StartArgs System.out.println(); } - // Jetty Se System.out.println(); } @@ -999,6 +999,11 @@ public class StartArgs return listModules; } + public List getShowModules() + { + return showModules; + } + public boolean isRun() { return run; @@ -1245,20 +1250,35 @@ public class StartArgs } // Module Management - if ("--list-modules".equals(arg)) + if ("--list-module".equals(arg) || "--list-modules".equals(arg)) { listModules = Collections.singletonList("-internal"); run = false; return; } - if (arg.startsWith("--list-modules=")) + if (arg.startsWith("--list-module=") || arg.startsWith("--list-modules=")) { listModules = Props.getValues(arg); run = false; return; } + // Module Management + if ("--show-module".equals(arg) || "--show-modules".equals(arg)) + { + showModules = Collections.emptyList(); + run = false; + return; + } + + if (arg.startsWith("--show-module=") || arg.startsWith("--show-modules=")) + { + showModules = Props.getValues(arg); + run = false; + return; + } + // jetty.base build-out : add to ${jetty.base}/start.ini if ("--create-startd".equals(arg)) { diff --git a/jetty-start/src/main/resources/org/eclipse/jetty/start/usage.txt b/jetty-start/src/main/resources/org/eclipse/jetty/start/usage.txt index 4bd9fa87be5..29d1b90f805 100644 --- a/jetty-start/src/main/resources/org/eclipse/jetty/start/usage.txt +++ b/jetty-start/src/main/resources/org/eclipse/jetty/start/usage.txt @@ -82,18 +82,12 @@ Debug and Start Logging: issues where the jetty specific logger has not yet kicked in due to startup configuration errors. -Module Management: ------------------- +Jetty Module Management: +------------------------ - --list-modules List non verbose modules defined by the system. - Looking for module files in ${jetty.base}/modules/*.mod and + --list-modules List Jetty modules defined in ${jetty.base}/modules/*.mod and then ${jetty.home}/modules/*.mod - Will also list enabled state based on information - present on .. - o The command line - o The ${jetty.base}/start.ini - o The ${jetty.base}/start.d/*.ini files - + --list-modules=(,)* List modules by tag. Use '*' for all tags. Prefix a tag with '-' to exclude the tag. The special tag "internal" @@ -102,6 +96,10 @@ Module Management: --list-all-modules List all modules. + --show-modules=(,)* + Show the detail of the listed modules, including + dependencies, tags, libraries and XMLs + --module=(,)* Temporarily enable a module from the command line. Note: this can also be used in the ${jetty.base}/start.ini @@ -191,7 +189,6 @@ Advanced Commands: Default is https://repo1.maven.org/maven2/. - Properties: ----------- Properties are used to parameterize: diff --git a/jetty-unixsocket/jetty-unixsocket-server/src/main/config/modules/unixsocket-forwarded.mod b/jetty-unixsocket/jetty-unixsocket-server/src/main/config/modules/unixsocket-forwarded.mod index e7699a2fa1d..582f7924a58 100644 --- a/jetty-unixsocket/jetty-unixsocket-server/src/main/config/modules/unixsocket-forwarded.mod +++ b/jetty-unixsocket/jetty-unixsocket-server/src/main/config/modules/unixsocket-forwarded.mod @@ -1,10 +1,9 @@ # DO NOT EDIT - See: https://www.eclipse.org/jetty/documentation/current/startup-modules.html [description] -Adds a forwarded request customizer to the HTTP configuration used -by the Unix Domain Socket connector, for use when behind a proxy operating -in HTTP mode that adds forwarded-for style HTTP headers. Typically this -is an alternate to the Proxy Protocol used mostly for TCP mode. +Adds a forwarded request customizer for the Unix Domain Socket connector. +For use when behind a proxy operating in HTTP mode that adds forwarded-for style HTTP headers. +Typically this is an alternate to the Proxy Protocol used mostly for TCP mode. [tags] connector diff --git a/jetty-unixsocket/jetty-unixsocket-server/src/main/config/modules/unixsocket-http2c.mod b/jetty-unixsocket/jetty-unixsocket-server/src/main/config/modules/unixsocket-http2c.mod index bbc809ac302..72d24571106 100644 --- a/jetty-unixsocket/jetty-unixsocket-server/src/main/config/modules/unixsocket-http2c.mod +++ b/jetty-unixsocket/jetty-unixsocket-server/src/main/config/modules/unixsocket-http2c.mod @@ -1,7 +1,7 @@ # DO NOT EDIT - See: https://www.eclipse.org/jetty/documentation/current/startup-modules.html [description] -Adds an HTTP2C connetion factory to the Unix Domain Socket Connector +Adds an HTTP2C connetion factory to the Unix Domain Socket Connector. It can be used when either the proxy forwards direct HTTP/2C (unecrypted) or decrypted HTTP/2 traffic. diff --git a/jetty-unixsocket/jetty-unixsocket-server/src/main/config/modules/unixsocket-proxy-protocol.mod b/jetty-unixsocket/jetty-unixsocket-server/src/main/config/modules/unixsocket-proxy-protocol.mod index 517d1c59883..10285ad307e 100644 --- a/jetty-unixsocket/jetty-unixsocket-server/src/main/config/modules/unixsocket-proxy-protocol.mod +++ b/jetty-unixsocket/jetty-unixsocket-server/src/main/config/modules/unixsocket-proxy-protocol.mod @@ -1,7 +1,7 @@ # DO NOT EDIT - See: https://www.eclipse.org/jetty/documentation/current/startup-modules.html [description] -Enables the proxy protocol on the Unix Domain Socket Connector +Enables the proxy protocol on the Unix Domain Socket Connector. http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt This allows information about the proxied connection to be efficiently forwarded as the connection is accepted. diff --git a/jetty-unixsocket/jetty-unixsocket-server/src/main/config/modules/unixsocket-secure.mod b/jetty-unixsocket/jetty-unixsocket-server/src/main/config/modules/unixsocket-secure.mod index 6f947dd7d70..566bfc61bd5 100644 --- a/jetty-unixsocket/jetty-unixsocket-server/src/main/config/modules/unixsocket-secure.mod +++ b/jetty-unixsocket/jetty-unixsocket-server/src/main/config/modules/unixsocket-secure.mod @@ -1,8 +1,8 @@ # DO NOT EDIT - See: https://www.eclipse.org/jetty/documentation/current/startup-modules.html [description] -Enable a secure request customizer on the HTTP Configuration -used by the Unix Domain Socket Connector. +Enable a secure request customizer on the HTTP Configuration. +Used by the Unix Domain Socket Connector. This looks for a secure scheme transported either by the unixsocket-forwarded, unixsocket-proxy-protocol or in a HTTP2 request. diff --git a/jetty-unixsocket/jetty-unixsocket-server/src/main/config/modules/unixsocket.mod b/jetty-unixsocket/jetty-unixsocket-server/src/main/config/modules/unixsocket.mod index b5c96b32c3c..a1f8673749e 100644 --- a/jetty-unixsocket/jetty-unixsocket-server/src/main/config/modules/unixsocket.mod +++ b/jetty-unixsocket/jetty-unixsocket-server/src/main/config/modules/unixsocket.mod @@ -1,11 +1,10 @@ # DO NOT EDIT - See: https://www.eclipse.org/jetty/documentation/current/startup-modules.html [description] -Enables a Unix Domain Socket Connector that can receive -requests from a local proxy and/or SSL offloader (eg haproxy) in either -HTTP or TCP mode. Unix Domain Sockets are more efficient than -localhost TCP/IP connections as they reduce data copies, avoid -needless fragmentation and have better dispatch behaviours. +Enables a Unix Domain Socket Connector. +The connector can receive requests from a local proxy and/or SSL offloader (eg haproxy) in either +HTTP or TCP mode. Unix Domain Sockets are more efficient than localhost TCP/IP connections +as they reduce data copies, avoid needless fragmentation and have better dispatch behaviours. When enabled with corresponding support modules, the connector can accept HTTP, HTTPS or HTTP2C traffic. diff --git a/jetty-unixsocket/src/main/config/modules/unixsocket.mod b/jetty-unixsocket/src/main/config/modules/unixsocket.mod index 5c573d624f0..a8f5e160a72 100644 --- a/jetty-unixsocket/src/main/config/modules/unixsocket.mod +++ b/jetty-unixsocket/src/main/config/modules/unixsocket.mod @@ -1,8 +1,8 @@ # DO NOT EDIT - See: https://www.eclipse.org/jetty/documentation/current/startup-modules.html [description] -Enables a Unix Domain Socket Connector that can receive -requests from a local proxy and/or SSL offloader (eg haproxy) in either +Enables a Unix Domain Socket Connector. +The connector can receive requests from a local proxy and/or SSL offloader (eg haproxy) in either HTTP or TCP mode. Unix Domain Sockets are more efficient than localhost TCP/IP connections as they reduce data copies, avoid needless fragmentation and have better dispatch behaviours. diff --git a/jetty-util/src/main/config/modules/console-capture.mod b/jetty-util/src/main/config/modules/console-capture.mod index cb8391073f7..e1d17631c53 100644 --- a/jetty-util/src/main/config/modules/console-capture.mod +++ b/jetty-util/src/main/config/modules/console-capture.mod @@ -1,8 +1,8 @@ # DO NOT EDIT - See: https://www.eclipse.org/jetty/documentation/current/startup-modules.html [description] -Redirects JVMs console stderr and stdout to a log file, -including output from Jetty's default StdErrLog logging. +Redirects JVMs console stderr and stdout to a log file. +includes output from Jetty's default StdErrLog logging. [tags] logging diff --git a/jetty-webapp/src/main/config/modules/webapp.mod b/jetty-webapp/src/main/config/modules/webapp.mod index d4f5d517c4b..c62f5f55705 100644 --- a/jetty-webapp/src/main/config/modules/webapp.mod +++ b/jetty-webapp/src/main/config/modules/webapp.mod @@ -1,8 +1,8 @@ # DO NOT EDIT - See: https://www.eclipse.org/jetty/documentation/current/startup-modules.html [description] -Adds support for servlet specification webapplication to the server -classpath. Without this, only Jetty specific handlers may be deployed. +Adds support for servlet specification webapplication to the server classpath. +Without this, only Jetty specific handlers may be deployed. [depend] servlet diff --git a/tests/test-webapps/test-jetty-webapp/src/main/config/modules/demo.mod b/tests/test-webapps/test-jetty-webapp/src/main/config/modules/demo.mod index 96301d9b07d..d5fcd0b7ee2 100644 --- a/tests/test-webapps/test-jetty-webapp/src/main/config/modules/demo.mod +++ b/tests/test-webapps/test-jetty-webapp/src/main/config/modules/demo.mod @@ -4,11 +4,16 @@ # Additional ini files are in demo-base/start.d # +[description] +Configure the Jetty Demo base. + [depends] rewrite jaas test-keystore +[tags] +demo [xml] # Enable rewrite examples