Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGreg Wilkins2015-11-11 05:22:17 +0000
committerGreg Wilkins2015-11-11 05:22:17 +0000
commit194aabb57be126ee96d37badb49b8e5484f9e665 (patch)
tree86770e97afb153d2c3153ee1df84105125452bab
parent279e56d3366498c23a497656658d9e330a1aa866 (diff)
downloadorg.eclipse.jetty.project-194aabb57be126ee96d37badb49b8e5484f9e665.tar.gz
org.eclipse.jetty.project-194aabb57be126ee96d37badb49b8e5484f9e665.tar.xz
org.eclipse.jetty.project-194aabb57be126ee96d37badb49b8e5484f9e665.zip
480827 Implemented Unix Domain Socket Connector
Improved comments
-rw-r--r--jetty-unixsocket/src/main/config/modules/unixsocket-forwarded.mod8
-rw-r--r--jetty-unixsocket/src/main/config/modules/unixsocket-http.mod13
-rw-r--r--jetty-unixsocket/src/main/config/modules/unixsocket-http2c.mod9
-rw-r--r--jetty-unixsocket/src/main/config/modules/unixsocket-proxy-protocol.mod8
-rw-r--r--jetty-unixsocket/src/main/config/modules/unixsocket-secure.mod11
-rw-r--r--jetty-unixsocket/src/main/config/modules/unixsocket.mod10
6 files changed, 57 insertions, 2 deletions
diff --git a/jetty-unixsocket/src/main/config/modules/unixsocket-forwarded.mod b/jetty-unixsocket/src/main/config/modules/unixsocket-forwarded.mod
index 57bd612bad..a1c73914c1 100644
--- a/jetty-unixsocket/src/main/config/modules/unixsocket-forwarded.mod
+++ b/jetty-unixsocket/src/main/config/modules/unixsocket-forwarded.mod
@@ -1,3 +1,11 @@
+#
+# Unix Socket forwarded module
+#
+# This module adds the jetty-unixsocket-forwarded.xml to the configuration
+# and is for use with the unixsocket-http module when the proxy is operating
+# in HTTP mode and adding forwarded-for style headers
+#
+
[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 3af1f1c50c..06906476ed 100644
--- a/jetty-unixsocket/src/main/config/modules/unixsocket-http.mod
+++ b/jetty-unixsocket/src/main/config/modules/unixsocket-http.mod
@@ -1,3 +1,16 @@
+#
+# Unix Socket HTTP Module
+#
+# This module adds a HTTP connection factory to the Unix Socket connector.
+# It should be used when the proxy is forwarding either HTTP or decrypted
+# HTTPS traffic.
+#
+# If the proxy is decrypting SSL/TLS, then either the unixsocket-forwarded
+# (for HTTP mode) or unixsocket-proxy-connection (for TCP mode) should be
+# used to set the scheme and certificate information correctly.
+#
+#
+
[depend]
unixsocket
diff --git a/jetty-unixsocket/src/main/config/modules/unixsocket-http2c.mod b/jetty-unixsocket/src/main/config/modules/unixsocket-http2c.mod
index 93a08db0a6..69a6c94beb 100644
--- a/jetty-unixsocket/src/main/config/modules/unixsocket-http2c.mod
+++ b/jetty-unixsocket/src/main/config/modules/unixsocket-http2c.mod
@@ -1,3 +1,12 @@
+#
+# Unix Socket HTTP2C Module
+#
+# This module adds a HTTP2C connetion factory to the Unix Socket
+# Connector. It can be used when either the proxy received direct
+# HTTP/2C (unecrypted) traffic; or the proxy is decrypting HTTP/2
+# traffic before forwarding it.
+#
+
[depend]
unixsocket-http
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 386000443a..fbdce1ff32 100644
--- a/jetty-unixsocket/src/main/config/modules/unixsocket-proxy-protocol.mod
+++ b/jetty-unixsocket/src/main/config/modules/unixsocket-proxy-protocol.mod
@@ -1,6 +1,12 @@
#
-# PROXY Protocol Module - UnixSocket
+# Unix Socket PROXY Protocol Module
#
+# This module adds the proxy protocol connection factory to the
+# unixsocket connector:
+# http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt
+# Both V1 and V2 versions of the protocol are supported and any
+# SSL properties transported can be interpreted by the
+# unixsocket-secure module to indicate secure HTTPS traffic.
[depend]
unixsocket
diff --git a/jetty-unixsocket/src/main/config/modules/unixsocket-secure.mod b/jetty-unixsocket/src/main/config/modules/unixsocket-secure.mod
index 054f31747c..3dd5ee7398 100644
--- a/jetty-unixsocket/src/main/config/modules/unixsocket-secure.mod
+++ b/jetty-unixsocket/src/main/config/modules/unixsocket-secure.mod
@@ -1,3 +1,14 @@
+#
+# Unix Socket Secure Module
+#
+# This module adds a secure request customizer to the
+# Unix Socket Connector. This looks for SSL properties
+# that may be transported by the unixsocket-proxy-protocol
+# module, to indicate a HTTPS request. This is not required
+# for HTTP/2 (which carries scheme) or if the unixsocket-forwarded
+# module is used with a forwarded scheme
+#
+
[depend]
unixsocket-http
diff --git a/jetty-unixsocket/src/main/config/modules/unixsocket.mod b/jetty-unixsocket/src/main/config/modules/unixsocket.mod
index 51377b7de2..78a39aeb7f 100644
--- a/jetty-unixsocket/src/main/config/modules/unixsocket.mod
+++ b/jetty-unixsocket/src/main/config/modules/unixsocket.mod
@@ -1,6 +1,14 @@
#
# Jetty UnixSocket Connector
#
+# This module 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.
+#
+# When enabled with corresponding support modules, the connector can
+# accept HTTP, HTTPS or HTTP2C traffic with the
[depend]
server
@@ -34,7 +42,7 @@ https://github.com/jnr/jnr-unixsocket
http://www.apache.org/licenses/LICENSE-2.0.html
[ini-template]
-### HTTP Connector Configuration
+### Unix SocketHTTP Connector Configuration
## Connector host/address to bind to
# jetty.unixsocket=/tmp/jetty.sock

Back to the top