Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGreg Wilkins2015-11-11 18:48:04 -0500
committerGreg Wilkins2015-11-11 18:48:04 -0500
commitff0d1b4c140af3febb56aeac682d38b51b46416f (patch)
treedffc59eeab52b270f7ec5ccd9eccad42519d4afb
parenta94e6bf0c076287de88e7c229dff81d14c919969 (diff)
downloadorg.eclipse.jetty.project-ff0d1b4c140af3febb56aeac682d38b51b46416f.tar.gz
org.eclipse.jetty.project-ff0d1b4c140af3febb56aeac682d38b51b46416f.tar.xz
org.eclipse.jetty.project-ff0d1b4c140af3febb56aeac682d38b51b46416f.zip
481903 Module Descriptions
-rw-r--r--apache-jsp/src/main/config/modules/apache-jsp.mod5
-rw-r--r--apache-jstl/src/main/config/modules/apache-jstl.mod5
-rw-r--r--jetty-alpn/jetty-alpn-server/src/main/config/modules/alpn.mod15
-rw-r--r--jetty-annotations/src/main/config/modules/annotations.mod8
-rw-r--r--jetty-cdi/cdi-servlet/src/main/config/modules/cdi.mod5
-rw-r--r--jetty-client/src/main/config/modules/client.mod5
-rw-r--r--jetty-deploy/src/main/config/modules/deploy.mod5
-rw-r--r--jetty-distribution/src/main/resources/modules/hawtio.mod5
-rw-r--r--jetty-distribution/src/main/resources/modules/jamon.mod5
-rw-r--r--jetty-distribution/src/main/resources/modules/jminix.mod5
-rw-r--r--jetty-distribution/src/main/resources/modules/jolokia.mod5
-rw-r--r--jetty-distribution/src/main/resources/modules/jsp.mod5
-rw-r--r--jetty-distribution/src/main/resources/modules/jstl.mod5
-rw-r--r--jetty-distribution/src/main/resources/modules/setuid.mod7
-rw-r--r--jetty-fcgi/fcgi-server/src/main/config/modules/fcgi.mod5
-rw-r--r--jetty-gcloud/gcloud-session-manager/src/main/config/modules/gcloud-sessions.mod5
-rw-r--r--jetty-http2/http2-server/src/main/config/modules/http2.mod6
-rw-r--r--jetty-http2/http2-server/src/main/config/modules/http2c.mod9
-rw-r--r--jetty-infinispan/src/main/config/modules/infinispan.mod6
-rw-r--r--jetty-jaas/src/main/config/modules/jaas.mod5
-rw-r--r--jetty-jaspi/src/main/config/modules/jaspi.mod5
-rw-r--r--jetty-jmx/src/main/config/modules/jmx-remote.mod5
-rw-r--r--jetty-jmx/src/main/config/modules/jmx.mod6
-rw-r--r--jetty-jndi/src/main/config/modules/jndi.mod5
-rw-r--r--jetty-monitor/src/main/config/modules/monitor.mod6
-rw-r--r--jetty-nosql/src/main/config/modules/nosql.mod5
-rw-r--r--jetty-overlay-deployer/src/main/config/modules/overlay.mod6
-rw-r--r--jetty-plus/src/main/config/modules/plus.mod7
-rw-r--r--jetty-proxy/src/main/config/modules/proxy.mod6
-rw-r--r--jetty-quickstart/src/main/config/modules/quickstart.mod6
-rw-r--r--jetty-rewrite/src/main/config/modules/rewrite.mod6
-rw-r--r--jetty-security/src/main/config/modules/security.mod5
-rw-r--r--jetty-server/src/main/config/modules/continuation.mod7
-rw-r--r--jetty-server/src/main/config/modules/debug.mod7
-rw-r--r--jetty-server/src/main/config/modules/debuglog.mod6
-rw-r--r--jetty-server/src/main/config/modules/ext.mod6
-rw-r--r--jetty-server/src/main/config/modules/gzip.mod7
-rw-r--r--jetty-server/src/main/config/modules/home-base-warning.mod6
-rw-r--r--jetty-server/src/main/config/modules/http-forwarded.mod6
-rw-r--r--jetty-server/src/main/config/modules/http.mod7
-rw-r--r--jetty-server/src/main/config/modules/https.mod5
-rw-r--r--jetty-server/src/main/config/modules/ipaccess.mod6
-rw-r--r--jetty-server/src/main/config/modules/jdbc-sessions.mod6
-rw-r--r--jetty-server/src/main/config/modules/jvm.mod3
-rw-r--r--jetty-server/src/main/config/modules/lowresources.mod7
-rw-r--r--jetty-server/src/main/config/modules/proxy-protocol-ssl.mod9
-rw-r--r--jetty-server/src/main/config/modules/proxy-protocol.mod10
-rw-r--r--jetty-server/src/main/config/modules/requestlog.mod5
-rw-r--r--jetty-server/src/main/config/modules/resources.mod7
-rw-r--r--jetty-server/src/main/config/modules/server.mod5
-rw-r--r--jetty-server/src/main/config/modules/ssl.mod7
-rw-r--r--jetty-server/src/main/config/modules/stats.mod6
-rw-r--r--jetty-servlet/src/main/config/modules/servlet.mod5
-rw-r--r--jetty-servlets/src/main/config/modules/servlets.mod9
-rw-r--r--jetty-spring/src/main/config/modules/spring.mod6
-rw-r--r--jetty-unixsocket/src/main/config/modules/unixsocket-forwarded.mod3
-rw-r--r--jetty-unixsocket/src/main/config/modules/unixsocket-http.mod2
-rw-r--r--jetty-unixsocket/src/main/config/modules/unixsocket-proxy-protocol.mod3
-rw-r--r--jetty-unixsocket/src/main/config/modules/unixsocket.mod1
-rw-r--r--jetty-util/src/main/config/modules/logging.mod6
-rw-r--r--jetty-webapp/src/main/config/modules/webapp.mod6
-rw-r--r--jetty-websocket/javax-websocket-server-impl/src/main/config/modules/websocket.mod5
62 files changed, 174 insertions, 189 deletions
diff --git a/apache-jsp/src/main/config/modules/apache-jsp.mod b/apache-jsp/src/main/config/modules/apache-jsp.mod
index 5123670cb0..c816f61c04 100644
--- a/apache-jsp/src/main/config/modules/apache-jsp.mod
+++ b/apache-jsp/src/main/config/modules/apache-jsp.mod
@@ -1,6 +1,5 @@
-#
-# Apache JSP Module
-#
+[description]
+Enables use of the apache implementation of JSP
[name]
apache-jsp
diff --git a/apache-jstl/src/main/config/modules/apache-jstl.mod b/apache-jstl/src/main/config/modules/apache-jstl.mod
index e4a9001a2a..d7c703e7ea 100644
--- a/apache-jstl/src/main/config/modules/apache-jstl.mod
+++ b/apache-jstl/src/main/config/modules/apache-jstl.mod
@@ -1,6 +1,5 @@
-#
-# Apache JSTL
-#
+[description]
+Enables the apache version of JSTL
[name]
apache-jstl
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 7928e64928..10997501ff 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
@@ -1,11 +1,10 @@
-# ALPN is provided via a -Xbootclasspath that modifies the secure connections
-# in java to support the ALPN layer needed for HTTP/2.
-#
-# This modification has a tight dependency on specific recent updates of
-# Java 1.7 and Java 1.8 (Java versions prior to 1.7u40 are not supported).
-#
-# The alpn module will use an appropriate alpn-boot jar for your
-# specific version of Java.
+[description]
+Enables the ALPN extension to TLS(SSL) by adding modified classes to
+the JVM bootpath.
+This modification has a tight dependency on specific recent updates of
+Java 1.7 and Java 1.8 (Java versions prior to 1.7u40 are not supported).
+The alpn module will use an appropriate alpn-boot jar for your
+specific version of Java.
#
# IMPORTANT: Versions of Java that exist after this module was created are
# not guaranteed to work with existing alpn-boot jars, and might
diff --git a/jetty-annotations/src/main/config/modules/annotations.mod b/jetty-annotations/src/main/config/modules/annotations.mod
index 65e4654127..4217be54fb 100644
--- a/jetty-annotations/src/main/config/modules/annotations.mod
+++ b/jetty-annotations/src/main/config/modules/annotations.mod
@@ -1,15 +1,11 @@
-#
-# Jetty Annotation Scanning Module
-#
+[description]
+Enables Annotation scanning for deployed webapplications.
[depend]
-# Annotations needs plus, and jndi features
plus
[lib]
-# Annotations needs jetty annotation jars
lib/jetty-annotations-${jetty.version}.jar
-# Need annotation processing jars too
lib/annotations/*.jar
[xml]
diff --git a/jetty-cdi/cdi-servlet/src/main/config/modules/cdi.mod b/jetty-cdi/cdi-servlet/src/main/config/modules/cdi.mod
index ebffb55aed..68a926d62f 100644
--- a/jetty-cdi/cdi-servlet/src/main/config/modules/cdi.mod
+++ b/jetty-cdi/cdi-servlet/src/main/config/modules/cdi.mod
@@ -1,6 +1,5 @@
-#
-# [EXPERIMENTAL] CDI / Weld Jetty module
-#
+[description]
+Experimental CDI/Weld integration
[depend]
deploy
diff --git a/jetty-client/src/main/config/modules/client.mod b/jetty-client/src/main/config/modules/client.mod
index 39b58d4e69..e9d13c8c68 100644
--- a/jetty-client/src/main/config/modules/client.mod
+++ b/jetty-client/src/main/config/modules/client.mod
@@ -1,6 +1,5 @@
-#
-# Client Feature
-#
+[description]
+Adds the Jetty HTTP client to the server classpath.
[lib]
lib/jetty-client-${jetty.version}.jar
diff --git a/jetty-deploy/src/main/config/modules/deploy.mod b/jetty-deploy/src/main/config/modules/deploy.mod
index f567a2090f..794868bfb4 100644
--- a/jetty-deploy/src/main/config/modules/deploy.mod
+++ b/jetty-deploy/src/main/config/modules/deploy.mod
@@ -1,6 +1,5 @@
-#
-# Deploy Feature
-#
+[description]
+Enables webapplication deployment from the webapps directory.
[depend]
webapp
diff --git a/jetty-distribution/src/main/resources/modules/hawtio.mod b/jetty-distribution/src/main/resources/modules/hawtio.mod
index f6d0d9d511..fcc34d1504 100644
--- a/jetty-distribution/src/main/resources/modules/hawtio.mod
+++ b/jetty-distribution/src/main/resources/modules/hawtio.mod
@@ -1,6 +1,5 @@
-#
-# Hawtio x module
-#
+[description]
+Deploys the Hawtio console as a webapplication.
[depend]
stats
diff --git a/jetty-distribution/src/main/resources/modules/jamon.mod b/jetty-distribution/src/main/resources/modules/jamon.mod
index 2d1f144d1b..77cc3d1e9d 100644
--- a/jetty-distribution/src/main/resources/modules/jamon.mod
+++ b/jetty-distribution/src/main/resources/modules/jamon.mod
@@ -1,6 +1,5 @@
-#
-# JAMon Jetty module
-#
+[description]
+Deploys the JAMon webapplication
[depend]
stats
diff --git a/jetty-distribution/src/main/resources/modules/jminix.mod b/jetty-distribution/src/main/resources/modules/jminix.mod
index 05788f0915..81a75c7350 100644
--- a/jetty-distribution/src/main/resources/modules/jminix.mod
+++ b/jetty-distribution/src/main/resources/modules/jminix.mod
@@ -1,6 +1,5 @@
-#
-# JaMON Jetty module
-#
+[description]
+Deploys the Jminix JMX Console within the server
[depend]
stats
diff --git a/jetty-distribution/src/main/resources/modules/jolokia.mod b/jetty-distribution/src/main/resources/modules/jolokia.mod
index da8ac8f8c2..efe8a59185 100644
--- a/jetty-distribution/src/main/resources/modules/jolokia.mod
+++ b/jetty-distribution/src/main/resources/modules/jolokia.mod
@@ -1,6 +1,5 @@
-#
-# Jolokia Jetty module
-#
+[description]
+Deploys the Jolokia console as a web application.
[depend]
stats
diff --git a/jetty-distribution/src/main/resources/modules/jsp.mod b/jetty-distribution/src/main/resources/modules/jsp.mod
index a16cc93dc9..2bc7ba8522 100644
--- a/jetty-distribution/src/main/resources/modules/jsp.mod
+++ b/jetty-distribution/src/main/resources/modules/jsp.mod
@@ -1,6 +1,5 @@
-#
-# Jetty JSP Module
-#
+[description]
+Enables JSP for all webapplications deployed on the server.
[depend]
servlet
diff --git a/jetty-distribution/src/main/resources/modules/jstl.mod b/jetty-distribution/src/main/resources/modules/jstl.mod
index efc310af6e..dedb2c052c 100644
--- a/jetty-distribution/src/main/resources/modules/jstl.mod
+++ b/jetty-distribution/src/main/resources/modules/jstl.mod
@@ -1,6 +1,5 @@
-#
-# Jetty JSTL Module
-#
+[description]
+Enables JSTL for all webapplications deployed on the server
[depend]
jsp
diff --git a/jetty-distribution/src/main/resources/modules/setuid.mod b/jetty-distribution/src/main/resources/modules/setuid.mod
index 41ef757e82..c1174ccba8 100644
--- a/jetty-distribution/src/main/resources/modules/setuid.mod
+++ b/jetty-distribution/src/main/resources/modules/setuid.mod
@@ -1,6 +1,7 @@
-#
-# Set UID Feature
-#
+[description]
+Enables the unix setUID configuration so that the server
+may be started as root to open privileged ports/files before
+changing to a restricted user (eg jetty).
[depend]
server
diff --git a/jetty-fcgi/fcgi-server/src/main/config/modules/fcgi.mod b/jetty-fcgi/fcgi-server/src/main/config/modules/fcgi.mod
index 14152d5f2b..6a4beaf1ab 100644
--- a/jetty-fcgi/fcgi-server/src/main/config/modules/fcgi.mod
+++ b/jetty-fcgi/fcgi-server/src/main/config/modules/fcgi.mod
@@ -1,6 +1,5 @@
-#
-# FastCGI Module
-#
+[description]
+Adds the FastCGI implementation to the classpath.
[depend]
servlet
diff --git a/jetty-gcloud/gcloud-session-manager/src/main/config/modules/gcloud-sessions.mod b/jetty-gcloud/gcloud-session-manager/src/main/config/modules/gcloud-sessions.mod
index 0780a60ba9..3a6aaef03a 100644
--- a/jetty-gcloud/gcloud-session-manager/src/main/config/modules/gcloud-sessions.mod
+++ b/jetty-gcloud/gcloud-session-manager/src/main/config/modules/gcloud-sessions.mod
@@ -1,6 +1,5 @@
-#
-# Jetty GCloudDatastore Session Manager module
-#
+[description]
+Enables the GCloudDatastore Session Mananger module.
[depend]
annotations
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 585c1fa5ee..ece1e331b5 100644
--- a/jetty-http2/http2-server/src/main/config/modules/http2.mod
+++ b/jetty-http2/http2-server/src/main/config/modules/http2.mod
@@ -1,6 +1,6 @@
-#
-# HTTP2 Support Module
-#
+[description]
+Enables HTTP2 protocol support on the TLS(SSL) Connector,
+using the ALPN extension to select which protocol to use.
[depend]
ssl
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 1c78016598..dfca925ee5 100644
--- a/jetty-http2/http2-server/src/main/config/modules/http2c.mod
+++ b/jetty-http2/http2-server/src/main/config/modules/http2c.mod
@@ -1,9 +1,6 @@
-#
-# HTTP2 Clear Text Support Module
-# This module adds support for HTTP/2 clear text to the
-# HTTP/1 clear text connector (defined in jetty-http.xml).
-# The resulting connector will accept both HTTP/1 and HTTP/2 connections.
-#
+[description]
+Enables the HTTP2C protocol on the HTTP Connector
+The connector will accept both HTTP/1 and HTTP/2 connections.
[depend]
http
diff --git a/jetty-infinispan/src/main/config/modules/infinispan.mod b/jetty-infinispan/src/main/config/modules/infinispan.mod
index afa39fc961..9a1e0b27df 100644
--- a/jetty-infinispan/src/main/config/modules/infinispan.mod
+++ b/jetty-infinispan/src/main/config/modules/infinispan.mod
@@ -1,6 +1,6 @@
-#
-# Jetty Infinispan module
-#
+[description]
+Enables an Infinispan Session Manager for session
+persistance and/or clustering
[depend]
annotations
diff --git a/jetty-jaas/src/main/config/modules/jaas.mod b/jetty-jaas/src/main/config/modules/jaas.mod
index fee3f59d87..26c68fff54 100644
--- a/jetty-jaas/src/main/config/modules/jaas.mod
+++ b/jetty-jaas/src/main/config/modules/jaas.mod
@@ -1,6 +1,5 @@
-#
-# JAAS Module
-#
+[description]
+Enable JAAS for deployed webapplications.
[depend]
server
diff --git a/jetty-jaspi/src/main/config/modules/jaspi.mod b/jetty-jaspi/src/main/config/modules/jaspi.mod
index e7019ae1b6..0d55273034 100644
--- a/jetty-jaspi/src/main/config/modules/jaspi.mod
+++ b/jetty-jaspi/src/main/config/modules/jaspi.mod
@@ -1,6 +1,5 @@
-#
-# Jetty JASPI Module
-#
+[description]
+Enable JASPI authentication for deployed webapplications.
[depend]
security
diff --git a/jetty-jmx/src/main/config/modules/jmx-remote.mod b/jetty-jmx/src/main/config/modules/jmx-remote.mod
index f8a5111d8f..7a10a01814 100644
--- a/jetty-jmx/src/main/config/modules/jmx-remote.mod
+++ b/jetty-jmx/src/main/config/modules/jmx-remote.mod
@@ -1,6 +1,5 @@
-#
-# JMX Remote Module
-#
+[description]
+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 ee091c706a..a59c6dd9c1 100644
--- a/jetty-jmx/src/main/config/modules/jmx.mod
+++ b/jetty-jmx/src/main/config/modules/jmx.mod
@@ -1,6 +1,6 @@
-#
-# JMX Module
-#
+[description]
+Enables JMX instrumentation for server beans and
+enables JMX agent.
[depend]
server
diff --git a/jetty-jndi/src/main/config/modules/jndi.mod b/jetty-jndi/src/main/config/modules/jndi.mod
index 33c077ce68..b0d3fc4449 100644
--- a/jetty-jndi/src/main/config/modules/jndi.mod
+++ b/jetty-jndi/src/main/config/modules/jndi.mod
@@ -1,6 +1,5 @@
-#
-# JNDI Support
-#
+[description]
+Adds the Jetty JNDI implementation to the classpath.
[depend]
server
diff --git a/jetty-monitor/src/main/config/modules/monitor.mod b/jetty-monitor/src/main/config/modules/monitor.mod
index 09132c7b2c..f1fa81f98c 100644
--- a/jetty-monitor/src/main/config/modules/monitor.mod
+++ b/jetty-monitor/src/main/config/modules/monitor.mod
@@ -1,6 +1,6 @@
-#
-# Jetty Monitor module
-#
+[description]
+Enables the Jetty Monitor Module to periodically
+check/publish JMX parameters of the server.
[depend]
server
diff --git a/jetty-nosql/src/main/config/modules/nosql.mod b/jetty-nosql/src/main/config/modules/nosql.mod
index a5b5a9ed75..fb4ed66f69 100644
--- a/jetty-nosql/src/main/config/modules/nosql.mod
+++ b/jetty-nosql/src/main/config/modules/nosql.mod
@@ -1,6 +1,5 @@
-#
-# Jetty NoSql module
-#
+[description]
+Enables NoSql session management with a MongoDB driver.
[depend]
webapp
diff --git a/jetty-overlay-deployer/src/main/config/modules/overlay.mod b/jetty-overlay-deployer/src/main/config/modules/overlay.mod
index 87bf9e1722..1c95193c1d 100644
--- a/jetty-overlay-deployer/src/main/config/modules/overlay.mod
+++ b/jetty-overlay-deployer/src/main/config/modules/overlay.mod
@@ -1,6 +1,6 @@
-#
-# Jetty Overlay module
-#
+[description]
+Enable the jetty overlay deployer that allows
+webapplications to be dynamically composed of layers.
[depend]
deploy
diff --git a/jetty-plus/src/main/config/modules/plus.mod b/jetty-plus/src/main/config/modules/plus.mod
index aac0f8f3ec..a424117b17 100644
--- a/jetty-plus/src/main/config/modules/plus.mod
+++ b/jetty-plus/src/main/config/modules/plus.mod
@@ -1,6 +1,7 @@
-#
-# Jetty Plus module
-#
+[description]
+Enables JNDI and resource injection for webapplications
+and other servlet 3.x features not supported in the core
+jetty webapps module.
[depend]
server
diff --git a/jetty-proxy/src/main/config/modules/proxy.mod b/jetty-proxy/src/main/config/modules/proxy.mod
index 6b91f68914..c14ee0cba7 100644
--- a/jetty-proxy/src/main/config/modules/proxy.mod
+++ b/jetty-proxy/src/main/config/modules/proxy.mod
@@ -1,6 +1,6 @@
-#
-# Jetty Proxy module
-#
+[description]
+Enable the Jetty Proxy, that 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 4e59dd0862..cefa5f1688 100644
--- a/jetty-quickstart/src/main/config/modules/quickstart.mod
+++ b/jetty-quickstart/src/main/config/modules/quickstart.mod
@@ -1,6 +1,6 @@
-#
-# Jetty Quickstart module
-#
+[description]
+Enables the Jetty Quickstart module for rapid
+deployment of preconfigured webapplications.
[depend]
server
diff --git a/jetty-rewrite/src/main/config/modules/rewrite.mod b/jetty-rewrite/src/main/config/modules/rewrite.mod
index c8a1750618..3b741a1a0d 100644
--- a/jetty-rewrite/src/main/config/modules/rewrite.mod
+++ b/jetty-rewrite/src/main/config/modules/rewrite.mod
@@ -1,6 +1,6 @@
-#
-# Jetty Rewrite module
-#
+[description]
+Enables the jetty-rewrite handler. Specific rewrite
+rules must be added to etc/jetty-rewrite.xml
[depend]
server
diff --git a/jetty-security/src/main/config/modules/security.mod b/jetty-security/src/main/config/modules/security.mod
index ba3163275f..3955fcfee8 100644
--- a/jetty-security/src/main/config/modules/security.mod
+++ b/jetty-security/src/main/config/modules/security.mod
@@ -1,6 +1,5 @@
-#
-# Jetty Security Module
-#
+[description]
+Adds servlet standard security handling to the classpath.
[depend]
server
diff --git a/jetty-server/src/main/config/modules/continuation.mod b/jetty-server/src/main/config/modules/continuation.mod
index 231c09d0f3..af03ae41ce 100644
--- a/jetty-server/src/main/config/modules/continuation.mod
+++ b/jetty-server/src/main/config/modules/continuation.mod
@@ -1,6 +1,7 @@
-#
-# Classic Jetty Continuation Support Module
-#
+[description]
+Enables support for Continuation style asynchronous
+Servlets. Now deprecated in favour of Servlet 3.1
+API
[lib]
lib/jetty-continuation-${jetty.version}.jar
diff --git a/jetty-server/src/main/config/modules/debug.mod b/jetty-server/src/main/config/modules/debug.mod
index 0141699461..7b75ecc0e7 100644
--- a/jetty-server/src/main/config/modules/debug.mod
+++ b/jetty-server/src/main/config/modules/debug.mod
@@ -1,6 +1,7 @@
-#
-# Debug module
-#
+[description]
+Enables the DebugListener to generate additional
+logging regarding detailed request handling events.
+Renames threads to include request URI.
[depend]
deploy
diff --git a/jetty-server/src/main/config/modules/debuglog.mod b/jetty-server/src/main/config/modules/debuglog.mod
index ba8b60a727..a76f728a5b 100644
--- a/jetty-server/src/main/config/modules/debuglog.mod
+++ b/jetty-server/src/main/config/modules/debuglog.mod
@@ -1,6 +1,6 @@
-#
-# Debug module
-#
+[description]
+Deprecated Debug Log using the DebugHandle.
+Replaced with the debug module.
[depend]
server
diff --git a/jetty-server/src/main/config/modules/ext.mod b/jetty-server/src/main/config/modules/ext.mod
index 56b10f7ea4..4171f8dfc2 100644
--- a/jetty-server/src/main/config/modules/ext.mod
+++ b/jetty-server/src/main/config/modules/ext.mod
@@ -1,6 +1,6 @@
-#
-# Module to add all lib/ext/**.jar files to classpath
-#
+[description]
+Adds all jar files discovered in $JETTY_HOME/lib/ext
+and $JETTY_BASE/lib/ext to the servers classpath.
[lib]
lib/ext/**.jar
diff --git a/jetty-server/src/main/config/modules/gzip.mod b/jetty-server/src/main/config/modules/gzip.mod
index 1efc834648..65663a1606 100644
--- a/jetty-server/src/main/config/modules/gzip.mod
+++ b/jetty-server/src/main/config/modules/gzip.mod
@@ -1,7 +1,6 @@
-#
-# GZIP module
-# Applies GzipHandler to entire server
-#
+[description]
+Enable GzipHandler for dynamic gzip compression
+for the entire server.
[depend]
server
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 28e5757e81..3e599f0788 100644
--- a/jetty-server/src/main/config/modules/home-base-warning.mod
+++ b/jetty-server/src/main/config/modules/home-base-warning.mod
@@ -1,6 +1,6 @@
-#
-# Home and Base Warning
-#
+[description]
+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 0915eece9e..60f10da736 100644
--- a/jetty-server/src/main/config/modules/http-forwarded.mod
+++ b/jetty-server/src/main/config/modules/http-forwarded.mod
@@ -1,6 +1,6 @@
-#
-# Jetty HTTP Connector
-#
+[description]
+Adds a forwarded request customizer to the HTTP Connector
+to process forwarded-for style headers from a proxy.
[depend]
http
diff --git a/jetty-server/src/main/config/modules/http.mod b/jetty-server/src/main/config/modules/http.mod
index 01e986243e..c59ee4b4d9 100644
--- a/jetty-server/src/main/config/modules/http.mod
+++ b/jetty-server/src/main/config/modules/http.mod
@@ -1,6 +1,7 @@
-#
-# Jetty HTTP Connector
-#
+[description]
+Enables a HTTP connector on the server.
+By default HTTP/1 is support, but HTTP2C can
+be added to the connector with the http2c module.
[depend]
server
diff --git a/jetty-server/src/main/config/modules/https.mod b/jetty-server/src/main/config/modules/https.mod
index a48107982e..6ffbd69d0c 100644
--- a/jetty-server/src/main/config/modules/https.mod
+++ b/jetty-server/src/main/config/modules/https.mod
@@ -1,6 +1,5 @@
-#
-# Jetty HTTPS Connector
-#
+[description]
+Adds HTTPS protocol support to the TLS(SSL) Connector
[depend]
ssl
diff --git a/jetty-server/src/main/config/modules/ipaccess.mod b/jetty-server/src/main/config/modules/ipaccess.mod
index 956ea0f2e3..68f04dfc57 100644
--- a/jetty-server/src/main/config/modules/ipaccess.mod
+++ b/jetty-server/src/main/config/modules/ipaccess.mod
@@ -1,6 +1,6 @@
-#
-# IPAccess module
-#
+[description]
+Enable the ipaccess handler to apply a white/black list
+control of the remote IP of requests.
[depend]
server
diff --git a/jetty-server/src/main/config/modules/jdbc-sessions.mod b/jetty-server/src/main/config/modules/jdbc-sessions.mod
index d77ff043e2..9fe2beba15 100644
--- a/jetty-server/src/main/config/modules/jdbc-sessions.mod
+++ b/jetty-server/src/main/config/modules/jdbc-sessions.mod
@@ -1,6 +1,5 @@
-#
-# Jetty JDBC Session module
-#
+[description]
+Enables JDBC Session management.
[depend]
annotations
@@ -9,7 +8,6 @@ webapp
[xml]
etc/jetty-jdbc-sessions.xml
-
[ini-template]
## JDBC Session config
diff --git a/jetty-server/src/main/config/modules/jvm.mod b/jetty-server/src/main/config/modules/jvm.mod
index 195521c57f..296c1b6a2b 100644
--- a/jetty-server/src/main/config/modules/jvm.mod
+++ b/jetty-server/src/main/config/modules/jvm.mod
@@ -1,3 +1,6 @@
+[description]
+A noop module that creates an ini template useful for
+setting JVM arguments (eg -Xmx )
[ini-template]
## JVM Configuration
## If JVM args are include in an ini file then --exec is needed
diff --git a/jetty-server/src/main/config/modules/lowresources.mod b/jetty-server/src/main/config/modules/lowresources.mod
index 2f765d9af2..257829afd8 100644
--- a/jetty-server/src/main/config/modules/lowresources.mod
+++ b/jetty-server/src/main/config/modules/lowresources.mod
@@ -1,6 +1,7 @@
-#
-# Low Resources module
-#
+[description]
+Enables a low resource monitor on the server
+that can take actions if threads and/or connections
+cross configured threshholds.
[depend]
server
diff --git a/jetty-server/src/main/config/modules/proxy-protocol-ssl.mod b/jetty-server/src/main/config/modules/proxy-protocol-ssl.mod
index 764d24b847..374763d0b5 100644
--- a/jetty-server/src/main/config/modules/proxy-protocol-ssl.mod
+++ b/jetty-server/src/main/config/modules/proxy-protocol-ssl.mod
@@ -1,6 +1,9 @@
-#
-# PROXY Protocol Module - SSL
-#
+[description]
+Enables the Proxy Protocol on the TLS(SSL) Connector.
+http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt
+This allows a Proxy operating in TCP mode to transport
+details of the proxied connection to the server.
+Both V1 and V2 versions of the protocol are supported.
[depend]
ssl
diff --git a/jetty-server/src/main/config/modules/proxy-protocol.mod b/jetty-server/src/main/config/modules/proxy-protocol.mod
index 9df2700f4e..48820e5c14 100644
--- a/jetty-server/src/main/config/modules/proxy-protocol.mod
+++ b/jetty-server/src/main/config/modules/proxy-protocol.mod
@@ -1,6 +1,10 @@
-#
-# PROXY Protocol Module - HTTP
-#
+[description]
+Enables the Proxy Protocol on the HTTP Connector.
+http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt
+This allows a proxy operating in TCP mode to
+transport details of the proxied connection to
+the server.
+Both V1 and V2 versions of the protocol are supported.
[depend]
http
diff --git a/jetty-server/src/main/config/modules/requestlog.mod b/jetty-server/src/main/config/modules/requestlog.mod
index e27b246ea2..c849f65f31 100644
--- a/jetty-server/src/main/config/modules/requestlog.mod
+++ b/jetty-server/src/main/config/modules/requestlog.mod
@@ -1,6 +1,5 @@
-#
-# Request Log module
-#
+[description]
+Enables a NCSA style request log.
[depend]
server
diff --git a/jetty-server/src/main/config/modules/resources.mod b/jetty-server/src/main/config/modules/resources.mod
index 8647d81325..5648948640 100644
--- a/jetty-server/src/main/config/modules/resources.mod
+++ b/jetty-server/src/main/config/modules/resources.mod
@@ -1,6 +1,7 @@
-#
-# Module to add resources directory to classpath
-#
+[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)
[lib]
resources/
diff --git a/jetty-server/src/main/config/modules/server.mod b/jetty-server/src/main/config/modules/server.mod
index 14d6b58e88..19e21c56fe 100644
--- a/jetty-server/src/main/config/modules/server.mod
+++ b/jetty-server/src/main/config/modules/server.mod
@@ -1,6 +1,5 @@
-#
-# Base Server Module
-#
+[description]
+Enables the core Jetty server on the classpath.
[optional]
jvm
diff --git a/jetty-server/src/main/config/modules/ssl.mod b/jetty-server/src/main/config/modules/ssl.mod
index 292780a1cb..acc8d380c9 100644
--- a/jetty-server/src/main/config/modules/ssl.mod
+++ b/jetty-server/src/main/config/modules/ssl.mod
@@ -1,6 +1,7 @@
-#
-# SSL Keystore module
-#
+[description]
+Enables a TLS(SSL) Connector on the server.
+This may be used for HTTPS and/or HTTP2 by enabling
+the associated support modules.
[name]
ssl
diff --git a/jetty-server/src/main/config/modules/stats.mod b/jetty-server/src/main/config/modules/stats.mod
index 0922469cdf..838d54a904 100644
--- a/jetty-server/src/main/config/modules/stats.mod
+++ b/jetty-server/src/main/config/modules/stats.mod
@@ -1,6 +1,6 @@
-#
-# Stats module
-#
+[description]
+Enable detailed statistics collection for the server,
+available via JMX.
[depend]
server
diff --git a/jetty-servlet/src/main/config/modules/servlet.mod b/jetty-servlet/src/main/config/modules/servlet.mod
index fdb65c57a1..f21e18a87e 100644
--- a/jetty-servlet/src/main/config/modules/servlet.mod
+++ b/jetty-servlet/src/main/config/modules/servlet.mod
@@ -1,6 +1,5 @@
-#
-# Jetty Servlet Module
-#
+[description]
+Enables standard Servlet handling.
[depend]
server
diff --git a/jetty-servlets/src/main/config/modules/servlets.mod b/jetty-servlets/src/main/config/modules/servlets.mod
index 2e977c05f1..5e1c84fc27 100644
--- a/jetty-servlets/src/main/config/modules/servlets.mod
+++ b/jetty-servlets/src/main/config/modules/servlets.mod
@@ -1,7 +1,8 @@
-#
-# Jetty Servlets Module
-#
-
+[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.
[depend]
servlet
diff --git a/jetty-spring/src/main/config/modules/spring.mod b/jetty-spring/src/main/config/modules/spring.mod
index 39b9b8d85a..f6419b791b 100644
--- a/jetty-spring/src/main/config/modules/spring.mod
+++ b/jetty-spring/src/main/config/modules/spring.mod
@@ -1,6 +1,6 @@
-#
-# Spring
-#
+[description]
+Enable spring configuration processing so all jetty style
+xml files can optionally be written as spring beans
[name]
spring
diff --git a/jetty-unixsocket/src/main/config/modules/unixsocket-forwarded.mod b/jetty-unixsocket/src/main/config/modules/unixsocket-forwarded.mod
index 3008ac45e5..80d1999588 100644
--- a/jetty-unixsocket/src/main/config/modules/unixsocket-forwarded.mod
+++ b/jetty-unixsocket/src/main/config/modules/unixsocket-forwarded.mod
@@ -1,7 +1,8 @@
[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
+in HTTP mode that adds forwarded-for style HTTP headers. Typically this
+is an alternate to the Proxy Protocol used mostly for TCP mode.
[depend]
unixsocket-http
diff --git a/jetty-unixsocket/src/main/config/modules/unixsocket-http.mod b/jetty-unixsocket/src/main/config/modules/unixsocket-http.mod
index 4929795abb..05c46bee79 100644
--- a/jetty-unixsocket/src/main/config/modules/unixsocket-http.mod
+++ b/jetty-unixsocket/src/main/config/modules/unixsocket-http.mod
@@ -1,5 +1,5 @@
[description]
-Adds a HTTP connection factory to the Unix Domain Socket connector.
+Adds a HTTP protocol support to the Unix Domain Socket connector.
It should be used when a proxy is forwarding either HTTP or decrypted
HTTPS traffic to the connector and may be used with the
unix-socket-http2c modules to upgrade to HTTP/2.
diff --git a/jetty-unixsocket/src/main/config/modules/unixsocket-proxy-protocol.mod b/jetty-unixsocket/src/main/config/modules/unixsocket-proxy-protocol.mod
index 867231af44..11184d3947 100644
--- a/jetty-unixsocket/src/main/config/modules/unixsocket-proxy-protocol.mod
+++ b/jetty-unixsocket/src/main/config/modules/unixsocket-proxy-protocol.mod
@@ -5,7 +5,8 @@ This allows information about the proxied connection to be
efficiently forwarded as the connection is accepted.
Both V1 and V2 versions of the protocol are supported and any
SSL properties may be interpreted by the unixsocket-secure
-module to indicate secure HTTPS traffic.
+module to indicate secure HTTPS traffic. Typically this
+is an alternate to the forwarded module.
[depend]
unixsocket
diff --git a/jetty-unixsocket/src/main/config/modules/unixsocket.mod b/jetty-unixsocket/src/main/config/modules/unixsocket.mod
index bf76c3aa5b..c27ec9d2f4 100644
--- a/jetty-unixsocket/src/main/config/modules/unixsocket.mod
+++ b/jetty-unixsocket/src/main/config/modules/unixsocket.mod
@@ -4,7 +4,6 @@ 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-util/src/main/config/modules/logging.mod b/jetty-util/src/main/config/modules/logging.mod
index 4f30a8862d..8f6f15a5b6 100644
--- a/jetty-util/src/main/config/modules/logging.mod
+++ b/jetty-util/src/main/config/modules/logging.mod
@@ -1,6 +1,6 @@
-#
-# Jetty std err/out logging
-#
+[description]
+Redirects JVMs stderr and stdout to a log file,
+including output from Jetty's default StdErrLog logging.
[xml]
etc/jetty-logging.xml
diff --git a/jetty-webapp/src/main/config/modules/webapp.mod b/jetty-webapp/src/main/config/modules/webapp.mod
index 6bb37ef2ef..c753f8d761 100644
--- a/jetty-webapp/src/main/config/modules/webapp.mod
+++ b/jetty-webapp/src/main/config/modules/webapp.mod
@@ -1,6 +1,6 @@
-#
-# WebApp Support Module
-#
+[description]
+Adds support for servlet specification webapplication to the server
+classpath. Without this, only Jetty specific handlers may be deployed.
[depend]
servlet
diff --git a/jetty-websocket/javax-websocket-server-impl/src/main/config/modules/websocket.mod b/jetty-websocket/javax-websocket-server-impl/src/main/config/modules/websocket.mod
index e866b17989..cdc474a6c9 100644
--- a/jetty-websocket/javax-websocket-server-impl/src/main/config/modules/websocket.mod
+++ b/jetty-websocket/javax-websocket-server-impl/src/main/config/modules/websocket.mod
@@ -1,6 +1,5 @@
-#
-# WebSocket Module
-#
+[description]
+Enable websockets for deployed web applications
[depend]
# javax.websocket needs annotations

Back to the top