1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
4        XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
5              This file is generated from xml source: DO NOT EDIT
6        XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
7      -->
8<title>mod_proxy_wstunnel - Apache HTTP Server</title>
9<link href="/style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
10<link href="/style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
11<link href="/style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" /><link rel="stylesheet" type="text/css" href="/style/css/prettify.css" />
12<script src="/style/scripts/prettify.min.js" type="text/javascript">
13</script>
14
15<link href="/images/favicon.ico" rel="shortcut icon" /></head>
16<body>
17<div id="page-header">
18<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/directives.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="/glossary.html">Glossary</a> | <a href="/sitemap.html">Sitemap</a></p>
19<p class="apache">Apache HTTP Server Version 2.4</p>
20<img alt="" src="/images/feather.gif" /></div>
21<div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="/images/left.gif" /></a></div>
22<div id="path">
23<a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP Server</a> &gt; <a href="http://httpd.apache.org/docs/">Documentation</a> &gt; <a href="../">Version 2.4</a> &gt; <a href="./">Modules</a></div>
24<div id="page-content">
25<div id="preamble"><h1>Apache Module mod_proxy_wstunnel</h1>
26<div class="toplang">
27<p><span>Available Languages: </span><a href="/en/mod/mod_proxy_wstunnel.html" title="English">&nbsp;en&nbsp;</a></p>
28</div>
29<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Websockets support module for
30<code class="module"><a href="/mod/mod_proxy.html">mod_proxy</a></code></td></tr>
31<tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
32<tr><th><a href="module-dict.html#ModuleIdentifier">Module�Identifier:</a></th><td>proxy_wstunnel_module</td></tr>
33<tr><th><a href="module-dict.html#SourceFile">Source�File:</a></th><td>mod_proxy_wstunnel.c</td></tr>
34<tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Available for unix in version 2.4.5 and later</td></tr></table>
35<h3>Summary</h3>
36
37    <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
38    socket connections to a backend websockets server. The connection
39    is automagically upgraded to a websocket connection:</p>
40
41    <pre class="prettyprint lang-config">Upgrade: WebSocket
42Connection: Upgrade</pre>
43
44
45
46    <div class="example"><h3>Proxying requests to websockets server</h3><pre class="prettyprint lang-config">ProxyPass /ws2/  ws://echo.websocket.org/
47ProxyPass /wss2/ wss://echo.websocket.org/</pre>
48</div>
49
50</div>
51<div id="quickview"><h3 class="directives">Directives</h3>
52<p>This module provides no
53            directives.</p>
54<h3>See also</h3>
55<ul class="seealso">
56<li><code class="module"><a href="/mod/mod_proxy.html">mod_proxy</a></code></li>
57</ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
58
59</div>
60<div class="bottomlang">
61<p><span>Available Languages: </span><a href="/en/mod/mod_proxy_wstunnel.html" title="English">&nbsp;en&nbsp;</a></p>
62</div><div class="top"><a href="#page-header"><img src="/images/up.gif" alt="top" /></a></div><div class="section"><h2><a id="comments_section" name="comments_section">Comments</a></h2><div class="warning"><strong>Notice:</strong><br />This is not a Q&amp;A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed again by our moderators if they are either implemented or considered invalid/off-topic. Questions on how to manage the Apache HTTP Server should be directed at either our IRC channel, #httpd, on Freenode, or sent to our <a href="http://httpd.apache.org/lists.html">mailing lists</a>.</div>
63<script type="text/javascript"><!--//--><![CDATA[//><!--
64var comments_shortname = 'httpd';
65var comments_identifier = 'http://httpd.apache.org/docs/2.4/mod/mod_proxy_wstunnel.html';
66(function(w, d) {
67    if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
68        d.write('<div id="comments_thread"><\/div>');
69        var s = d.createElement('script');
70        s.type = 'text/javascript';
71        s.async = true;
72        s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
73        (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
74    }
75    else { 
76        d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
77    }
78})(window, document);
79//--><!]]></script></div><div id="footer">
80<p class="apache">Copyright 2014 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
81<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/directives.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="/glossary.html">Glossary</a> | <a href="/sitemap.html">Sitemap</a></p></div><script type="text/javascript"><!--//--><![CDATA[//><!--
82if (typeof(prettyPrint) !== 'undefined') {
83    prettyPrint();
84}
85//--><!]]></script>
86</body></html>