g3/g3tiles/doc/configuration/servers/plain_tcp_port.rst
Zhang Jingqiang d65301ee67
add sphinx doc for g3tiles (#202)
* add sphinx doc for g3tiles
2024-04-08 16:48:12 +08:00

51 lines
1.4 KiB
ReStructuredText

.. _configuration_server_plain_tcp_port:
plain_tcp_port
==============
This server provides plain tcp 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>`
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 tcp 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.
.. 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
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