summaryrefslogtreecommitdiff
path: root/docs/manual
diff options
context:
space:
mode:
authorYann Ylavic <ylavic@apache.org>2023-01-27 17:46:57 +0000
committerYann Ylavic <ylavic@apache.org>2023-01-27 17:46:57 +0000
commitffabdc4a5c26932c96d25750feb22dd0fbd6c2a4 (patch)
treeab5d08f4418c71c1a8c90080552afa2ca02a87a0 /docs/manual
parent509959caf9f412fbc0501017db6895262f997ce5 (diff)
downloadhttpd-ffabdc4a5c26932c96d25750feb22dd0fbd6c2a4.tar.gz
docs xforms [skip ci]
git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@1907039 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'docs/manual')
-rw-r--r--docs/manual/mod/mod_proxy_wstunnel.html.en.utf830
-rw-r--r--docs/manual/mod/mod_proxy_wstunnel.html.fr.utf82
-rw-r--r--docs/manual/mod/mod_proxy_wstunnel.xml.meta2
3 files changed, 19 insertions, 15 deletions
diff --git a/docs/manual/mod/mod_proxy_wstunnel.html.en.utf8 b/docs/manual/mod/mod_proxy_wstunnel.html.en.utf8
index cf89de9b5d..66578ca9e6 100644
--- a/docs/manual/mod/mod_proxy_wstunnel.html.en.utf8
+++ b/docs/manual/mod/mod_proxy_wstunnel.html.en.utf8
@@ -37,6 +37,12 @@
<tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Available in httpd 2.4.5 and later</td></tr></table>
<h3>Summary</h3>
+ <div class="warning"><h3><a id="deprecation" name="deprecation">Deprecation</a></h3>
+ <p>Since Apache HTTP Server 2.4.47, protocol Upgrade (tunneling) can be better handled by
+ <code class="module"><a href="../mod/mod_proxy_http.html">mod_proxy_http</a></code>.</p>
+ <p>See <a href="mod_proxy.html#protoupgrade">Protocol Upgrade</a>.</p>
+ </div>
+
<p>This module <em>requires</em> the service of <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code>.
It provides support for the tunnelling of web
socket connections to a backend websockets server. The connection
@@ -62,18 +68,18 @@ ProxyPass "/" "http://backend.example.com:9080/"</pre>
<p>Load balancing for multiple backends can be achieved using <code class="module"><a href="../mod/mod_proxy_balancer.html">mod_proxy_balancer</a></code>.</p>
-<p>In fact the module can be used to upgrade to other protocols, you can set the <code>upgrade</code>
-parameter in the <code class="directive"><a href="../mod/mod_proxy.html#proxypass">ProxyPass</a></code>
-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>
-
- <div class="warning"><h3><a id="deprecation" name="deprecation">Deprecation</a></h3>
- <p>Since Apache HTTP Server 2.4.47, protocol Upgrade (tunneling) can be better handled by
- <code class="module"><a href="../mod/mod_proxy_http.html">mod_proxy_http</a></code>.</p>
- <p>See <a href="mod_proxy.html#protoupgrade">Protocol Upgrade</a>.</p>
- </div>
+<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
+<code class="directive"><a href="../mod/mod_proxy.html#proxypass">ProxyPass</a></code>
+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>
</div>
<div id="quickview"><h3 class="directives">Directives</h3>
<ul id="toc">
diff --git a/docs/manual/mod/mod_proxy_wstunnel.html.fr.utf8 b/docs/manual/mod/mod_proxy_wstunnel.html.fr.utf8
index 6f37723c0e..a5fc74b7e7 100644
--- a/docs/manual/mod/mod_proxy_wstunnel.html.fr.utf8
+++ b/docs/manual/mod/mod_proxy_wstunnel.html.fr.utf8
@@ -29,8 +29,6 @@
<p><span>Langues Disponibles: </span><a href="../en/mod/mod_proxy_wstunnel.html" hreflang="en" rel="alternate" title="English">&nbsp;en&nbsp;</a> |
<a href="../fr/mod/mod_proxy_wstunnel.html" title="Français">&nbsp;fr&nbsp;</a></p>
</div>
-<div class="outofdate">Cette traduction peut être périmée. Vérifiez la version
- anglaise pour les changements récents.</div>
<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Module pour <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code> supportant les
websockets</td></tr>
<tr><th><a href="module-dict.html#Status">Statut:</a></th><td>Extension</td></tr>
diff --git a/docs/manual/mod/mod_proxy_wstunnel.xml.meta b/docs/manual/mod/mod_proxy_wstunnel.xml.meta
index b54b72811c..6c0a516e2a 100644
--- a/docs/manual/mod/mod_proxy_wstunnel.xml.meta
+++ b/docs/manual/mod/mod_proxy_wstunnel.xml.meta
@@ -8,6 +8,6 @@
<variants>
<variant>en</variant>
- <variant outdated="yes">fr</variant>
+ <variant>fr</variant>
</variants>
</metafile>