Opened 3 weeks ago

Closed 3 weeks ago

#2094 closed enhancement (wontfix)

"proxy_protocol" parameter in directive "listen" is incompatible with "udp".

Reported by: zhoushulin1992@… Owned by:
Priority: minor Milestone:
Component: documentation Version: 1.18.x
Keywords: Cc: zhoushulin1992@…
uname -a: Linux xlarge 4.15.0-72-generic #81-Ubuntu SMP Tue Nov 26 12:20:02 UTC 2019 x86_64 x86_64 x86_64 GNU/Linux
nginx -V: nginx version: nginx/1.18.0
built by gcc 7.4.0 (Ubuntu 7.4.0-1ubuntu1~18.04.1)
configure arguments: --prefix=/usr/local/nginx --with-pcre=/root/Downloads/pcre-8.43

Description

When users try to use udp protocol in directive "listen", the parameter "proxy_protocol" should not be used. But no message is mentioned in the doc of directive "listen" in https://nginx.org/en/docs/stream/ngx_stream_core_module.html#listen. I think we should add this information in the doc. A similar situation also occur in parameter "ssl", "so_keepalive", and "backlog" in directive "listen".

Change History (1)

comment:1 by Maxim Dounin, 3 weeks ago

Resolution: wontfix
Status: newclosed

Thank you for your suggestion. The UDP protocol implies various semantic limitations, such as no proxy_protocol since it is designed for TCP proxies, and no backlog due to no 3-way handshake in UDP. It is believed that trying to document these limitations is not very well suited for nginx documentation. On the other hand, trying to document allowed parameter combinations is hardly needed as long as protocol limitations are understood.

Note: See TracTickets for help on using tickets.