g3/g3proxy/doc/configuration/servers/intelli_proxy.rst
2023-11-17 18:32:24 +08:00

71 lines
1.8 KiB
ReStructuredText

.. _configuration_server_intelli_proxy:
intelli_proxy
=============
Intelligent Proxy port, it will do protocol detection and then send to other servers if detected.
The following common keys are supported:
* :ref:`listen_in_worker <conf_server_common_listen_in_worker>`
* :ref:`ingress_network_filter <conf_server_common_ingress_network_filter>`
listen
------
**required**, **type**: :ref:`tcp listen <conf_value_tcp_listen>`
Set the listen config for this server.
The instance count setting will be ignored if *listen_in_worker* is correctly enabled.
http_server
-----------
**required**, **type**: str
Set name of the next http_proxy server to send the accepted connections to.
socks_server
------------
**required**, **type**: str
Set name of the next socks_proxy server to send the accepted connections to.
protocol_detection_timeout
--------------------------
**optional**, **type**: :ref:`humanize duration <conf_value_humanize_duration>`
Set the timeout duration that we wait to check the protocol of each connection.
If timeout, the connection will be closed silently.
**default**: 4s
proxy_protocol
--------------
**optional**, **type**: :ref:`proxy protocol version <conf_value_proxy_protocol_version>`
Set the version of PROXY protocol we use for incoming tcp connections.
If set, connections with no matched PROXY Protocol message will be dropped.
.. note:: The *ingress_network_filter* config option of this server will always applies to the real socket client address.
**default**: not set, which means PROXY protocol won't be used
.. versionadded:: 1.7.28
proxy_protocol_read_timeout
---------------------------
**optional**, **type**: :ref:`humanize duration <conf_value_humanize_duration>`
Set the timeout value before we read a complete PROXY Protocol message.
**default**: 5s
.. versionadded:: 1.7.28