svn commit: r1907038 - /httpd/httpd/trunk/docs/manual/mod/mod_proxy_wstunnel.xml

[yl...@apache.org]

Author: ylavic
Date: Fri Jan 27 17:46:45 2023
New Revision: 1907038

URL: http://svn.apache.org/viewvc?rev=1907038&view=rev
Log:
docs: move mod_proxy_wstunnel deprecation warning up and warn about ANY/NONE protos.

[skip ci]

Modified:
    httpd/httpd/trunk/docs/manual/mod/mod_proxy_wstunnel.xml

Modified: httpd/httpd/trunk/docs/manual/mod/mod_proxy_wstunnel.xml
URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/docs/manual/mod/mod_proxy_wstunnel.xml?rev=1907038&r1=1907037&r2=1907038&view=diff
==============================================================================
--- httpd/httpd/trunk/docs/manual/mod/mod_proxy_wstunnel.xml (original)
+++ httpd/httpd/trunk/docs/manual/mod/mod_proxy_wstunnel.xml Fri Jan 27 17:46:45 2023
@@ -31,6 +31,12 @@
 <compatibility>Available in httpd 2.4.5 and later</compatibility>
 
 <summary>
+  <note type="warning"><title><a id="deprecation" name="deprecation">Deprecation</a></title>
+    <p>Since Apache HTTP Server 2.4.47, protocol Upgrade (tunneling) can be better handled by
+    <module>mod_proxy_http</module>.</p>
+    <p>See <a href="mod_proxy.html#protoupgrade">Protocol Upgrade</a>.</p>
+  </note>
+
     <p>This module <em>requires</em> the service of <module >mod_proxy</module>.
     It provides support for the tunnelling of web
     socket connections to a backend websockets server. The connection
@@ -61,18 +67,18 @@ ProxyPass "/"  "http://backend.example.c
 
 <p>Load balancing for multiple backends can be achieved using <module>mod_proxy_balancer</module>.</p>
 
-<p>In fact the module can be used to upgrade to other protocols, you can set the <code>upgrade</code>
-parameter in the <directive type="ProxyPass" module="mod_proxy">ProxyPass</directive>
-directive to allow the module to accept other protocol.
-NONE means you bypass the check for the header but still upgrade to WebSocket.
-ANY means that <code>Upgrade</code> will read in the request headers and use
-in the response <code>Upgrade</code></p>
-
-  <note type="warning"><title><a id="deprecation" name="deprecation">Deprecation</a></title>
-    <p>Since Apache HTTP Server 2.4.47, protocol Upgrade (tunneling) can be better handled by
-    <module>mod_proxy_http</module>.</p>
-    <p>See <a href="mod_proxy.html#protoupgrade">Protocol Upgrade</a>.</p>
-  </note>
+<p>
+The module can also be used to upgrade to other protocols than WebSocket, by setting
+the <var><a href="mod_proxy.html#upgrade">upgrade</a></var> parameter in the
+<directive type="ProxyPass" module="mod_proxy">ProxyPass</directive>
+directive to some custom protocol name.
+Special <code>upgrade=NONE</code> and <code>upgrade=ANY</code> values may be used for
+testing/forcing the upgrade but they are <strong>not recommended</strong> for production for
+security reasons.
+<code>NONE</code> means that the check for the header is omitted but still the upgrade to
+WebSocket still happens.
+<code>ANY</code> means that the upgrade will happen with any protocol asked by the client.
+</p>
 </summary>
 
 <seealso><module>mod_proxy</module></seealso>