g3/g3proxy/doc/configuration/servers/plain_tls_port.rst
Zhang Jingqiang 0d9016a799
g3proxy: support proxy protocol v1 for incoming connections (#128)
* g3proxy: support proxy protocol v1 for incoming connections

* g3proxy: add example conf for proxy protocol
2023-10-26 10:31:49 +08:00

60 lines
1.6 KiB
ReStructuredText

.. _configuration_server_plain_tls_port:
plain_tls_port
==============
This server provides plain tls port, which can be placed in front of other servers.
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>`
* :ref:`tls_server <conf_server_common_tls_server>`
This is required for this server.
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.
server
------
**required**, **type**: str
Set name of the next server to send the accepted connections to.
The next server should be able to accept tls connections.
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.
The TLS handshake with the client will happen after we receive the PROXY Protocol message.
.. 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.19
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.19