Merge pull request #1109 from rabbitmq/proxy-protocol-configuration

Add proxy protocol to configuration

2 files changed, 63 insertions, 3 deletions

diff --git a/docs/rabbitmq.conf.example b/docs/rabbitmq.conf.example
index de59985471..0e8d1e0596 100644
--- a/docs/rabbitmq.conf.example
+++ b/docs/rabbitmq.conf.example
@@ -395,6 +395,16 @@
 ##
 # background_gc_target_interval = 60000
 
+## Whether or not to enable proxy protocol support.
+## Once enabled, clients cannot directly connect to the broker
+## anymore. They must connect through a load balancer that sends the
+## proxy protocol header to the broker at connection time.
+## This setting applies only to AMQP clients, other protocols
+## like MQTT or STOMP have their own setting to enable proxy protocol.
+## See the plugins documentation for more information.
+##
+# proxy_protocol = false
+
 ## ----------------------------------------------------------------------------
 ## Advanced Erlang Networking/Clustering Options.
 ##
@@ -515,6 +525,16 @@
 ##
 # stomp.implicit_connect = true
 
+## Whether or not to enable proxy protocol support.
+## Once enabled, clients cannot directly connect to the broker
+## anymore. They must connect through a load balancer that sends the
+## proxy protocol header to the broker at connection time.
+## This setting applies only to STOMP clients, other protocols
+## like MQTT or AMQP have their own setting to enable proxy protocol.
+## See the plugins or broker documentation for more information.
+##
+# stomp.proxy_protocol = false
+
 ## ----------------------------------------------------------------------------
 ## RabbitMQ MQTT Adapter
 ##
@@ -578,6 +598,16 @@
 # mqtt.tcp_listen_options.backlog = 128
 # mqtt.tcp_listen_options.nodelay = true
 
+## Whether or not to enable proxy protocol support.
+## Once enabled, clients cannot directly connect to the broker
+## anymore. They must connect through a load balancer that sends the
+## proxy protocol header to the broker at connection time.
+## This setting applies only to STOMP clients, other protocols
+## like STOMP or AMQP have their own setting to enable proxy protocol.
+## See the plugins or broker documentation for more information.
+##
+# mqtt.proxy_protocol = false
+
 ## ----------------------------------------------------------------------------
 ## RabbitMQ AMQP 1.0 Support
 ##
diff --git a/docs/rabbitmq.config.example b/docs/rabbitmq.config.example
index aaffcab2d8..50e97cd3bb 100644
--- a/docs/rabbitmq.config.example
+++ b/docs/rabbitmq.config.example
@@ -346,7 +346,17 @@
    %% the operation (can be higher than this interval). Values less than
    %% 30000 milliseconds are not recommended.
    %%
-   %% {background_gc_target_interval, 60000}
+   %% {background_gc_target_interval, 60000},
+
+   %% Whether or not to enable proxy protocol support.
+   %% Once enabled, clients cannot directly connect to the broker
+   %% anymore. They must connect through a load balancer that sends the
+   %% proxy protocol header to the broker at connection time.
+   %% This setting applies only to AMQP clients, other protocols
+   %% like MQTT or STOMP have their own setting to enable proxy protocol.
+   %% See the plugins documentation for more information.
+   %%
+   %% {proxy_protocol, false}
 
   ]},
 
@@ -517,7 +527,17 @@
    %% SSL certificate whenever the first frame sent on a session is not a
    %% CONNECT frame.
    %%
-   %% {implicit_connect, true}
+   %% {implicit_connect, true},
+
+   %% Whether or not to enable proxy protocol support.
+   %% Once enabled, clients cannot directly connect to the broker
+   %% anymore. They must connect through a load balancer that sends the
+   %% proxy protocol header to the broker at connection time.
+   %% This setting applies only to STOMP clients, other protocols
+   %% like MQTT or AMQP have their own setting to enable proxy protocol.
+   %% See the plugins or broker documentation for more information.
+   %%
+   %% {proxy_protocol, false}
   ]},
 
  %% ----------------------------------------------------------------------------
@@ -575,7 +595,17 @@
    %% TCP/Socket options (as per the broker configuration).
    %%
    %% {tcp_listen_options, [{backlog,   128},
-   %%                       {nodelay,   true}]}
+   %%                       {nodelay,   true}]},
+
+   %% Whether or not to enable proxy protocol support.
+   %% Once enabled, clients cannot directly connect to the broker
+   %% anymore. They must connect through a load balancer that sends the
+   %% proxy protocol header to the broker at connection time.
+   %% This setting applies only to MQTT clients, other protocols
+   %% like STOMP or AMQP have their own setting to enable proxy protocol.
+   %% See the plugins or broker documentation for more information.
+   %%
+   %% {proxy_protocol, false}
   ]},
 
  %% ----------------------------------------------------------------------------