From 687df1469f7f4eb21a58dcaeb9bf040870060e9b Mon Sep 17 00:00:00 2001 From: Luca Toscano Date: Fri, 30 Dec 2016 18:20:04 +0000 Subject: [PATCH] Documentation rebuild for mod_remoteip git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@1776616 13f79535-47bb-0310-9956-ffa450edef68 --- docs/manual/mod/mod_remoteip.html.en | 71 +++++++++++++++++++++++++++ docs/manual/mod/mod_remoteip.xml.fr | 2 +- docs/manual/mod/mod_remoteip.xml.meta | 2 +- 3 files changed, 73 insertions(+), 2 deletions(-) diff --git a/docs/manual/mod/mod_remoteip.html.en b/docs/manual/mod/mod_remoteip.html.en index 43388ccc83..7da43c0090 100644 --- a/docs/manual/mod/mod_remoteip.html.en +++ b/docs/manual/mod/mod_remoteip.html.en @@ -47,6 +47,12 @@ via the request headers. with the useragent IP address reported in the request header configured with the RemoteIPHeader directive.

+

Additionally, this module implements the server side of + HAProxy's + Proxy Protocol when + using the RemoteIPProxyProtocolEnable + directive.

+

Once replaced as instructed, this overridden useragent IP address is then used for the mod_authz_host Require ip @@ -69,6 +75,7 @@ via the request headers.

  • RemoteIPInternalProxy
  • RemoteIPInternalProxyList
  • RemoteIPProxiesHeader
    • +
  • RemoteIPProxyProtocol
  • RemoteIPTrustedProxy
  • RemoteIPTrustedProxyList
    • @@ -77,6 +84,7 @@ via the request headers.
  • mod_authz_host
  • mod_status
  • mod_log_config
    • +
  • Proxy Protocol Spec
  • Comments
    • top
    @@ -217,6 +225,69 @@ gateway.localdomain #The front end balancer
    RemoteIPProxiesHeader X-Forwarded-By + +
    top
    +

    RemoteIPProxyProtocol Directive

    + + + + + + +
    Description:Enable, optionally enable or disable the proxy protocol handling
    Syntax:ProxyProtocol On|Optional|Off
    Context:server config, virtual host
    Status:Base
    Module:mod_remoteip
    +

    The RemoteIPProxyProtocolEnable enables or + disables the reading and handling of the proxy protocol connection header. + If enabled with the On flag, the upstream client must + send the header every time it opens a connection or the connection will + be aborted. If enabled with the Optional flag, the upstream + client may send the header.

    + +

    While this directive may be specified in any virtual host, it is + important to understand that because the proxy protocol is connection + based and protocol agnostic, the enabling and disabling is actually based + on ip-address and port. This means that if you have multiple name-based + virtual hosts for the same host and port, and you enable it any one of + them, then it is enabled for all them (with that host and port). It also + means that if you attempt to enable the proxy protocol in one and disable + in the other, that won't work; in such a case the last one wins and a + notice will be logged indicating which setting was being overridden.

    + +
    When multiple virtual hosts on the same IP and port are + configured with a combination of On and Optional + flags, connections will not be aborted if the header is not sent. + Instead, enforcement will happen after the request is read so virtual + hosts configured with On will return a 400 Bad Request. + Virtual hosts configured with Optional will continue as + usual but without replacing the client IP information
    + + 
    Listen 80
+<VirtualHost *:80>
+    ServerName www.example.com
+    RemoteIPProxyProtocolEnable Optional
+
+    #Requests to this virtual host may optionally not have
+    # a proxy protocol header provided
+</VirtualHost>
+
+<VirtualHost *:80>
+    ServerName www.example.com
+    RemoteIPProxyProtocolEnable On
+
+    #Requests to this virtual host must have a proxy protocol
+    # header provided. If it is missing, a 400 will result
+</VirtualHost>
+
+Listen 8080
+<VirtualHost *:8080>
+    ServerName www.example.com
+    RemoteIPProxyProtocolEnable On
+
+    #Requests to this virtual host must have a proxy protocol
+    # header provided. If it is missing, the connection will
+    # be aborted
+</VirtualHost>
    + +
    top

    RemoteIPTrustedProxy Directive

    diff --git a/docs/manual/mod/mod_remoteip.xml.fr b/docs/manual/mod/mod_remoteip.xml.fr index 91ec2990f3..6655e17feb 100644 --- a/docs/manual/mod/mod_remoteip.xml.fr +++ b/docs/manual/mod/mod_remoteip.xml.fr @@ -1,7 +1,7 @@ - + diff --git a/docs/manual/mod/mod_remoteip.xml.meta b/docs/manual/mod/mod_remoteip.xml.meta index 1a7c78a9f1..771852e80c 100644 --- a/docs/manual/mod/mod_remoteip.xml.meta +++ b/docs/manual/mod/mod_remoteip.xml.meta @@ -8,6 +8,6 @@ en - fr + fr -- 2.50.1