diff options
Diffstat (limited to 'jetty-server/src/main/config')
20 files changed, 69 insertions, 59 deletions
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 |