Skip to content

Documented proxy_ssl_alpn and proxy_ssl_alpn_protocols directives. #239

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
VadimZhestikov wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Documented proxy_ssl_alpn and proxy_ssl_alpn_protocols directives. #239

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 43 additions & 1 deletion xml/en/docs/stream/ngx_stream_proxy_module.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<module name="Module ngx_stream_proxy_module"
link="/en/docs/stream/ngx_stream_proxy_module.html"
lang="en"
rev="37">
rev="38">

<section id="summary">

Expand Down Expand Up @@ -414,6 +414,48 @@ Enables the SSL/TLS protocol for connections to a proxied server.
</directive>


<directive name="proxy_ssl_alpn">
<syntax><literal>on</literal> | <literal>off</literal></syntax>
<default>on</default>
<context>stream</context>
<context>server</context>

<para>
Enables or disables sending the
<link url="https://datatracker.ietf.org/doc/html/rfc7301">ALPN</link>
extension when establishing a connection with the proxied server.
When enabled and
<link id="proxy_ssl_alpn_protocols"/> is not set,
the protocol negotiated on the downstream SSL connection is inherited
and offered to the upstream.
If no ALPN was negotiated downstream, no ALPN extension is sent upstream.
</para>

</directive>


<directive name="proxy_ssl_alpn_protocols">
<syntax><value>protocol</value> ...</syntax>
<default/>
<context>stream</context>
<context>server</context>

<para>
Specifies the list of protocols to advertise via the
<link url="https://datatracker.ietf.org/doc/html/rfc7301">ALPN</link>
extension when establishing a connection with the proxied server.
For example:
<example>
proxy_ssl_alpn_protocols h2 http/1.1;
</example>
When set, this list takes precedence over the downstream negotiated protocol.
If <link id="proxy_ssl_alpn"/> is <literal>off</literal>,
this directive is ignored.
</para>

</directive>


<directive name="proxy_ssl_certificate">
<syntax><value>file</value></syntax>
<default/>
Expand Down