From: Jim Jagielski <jim@apache.org>
Date: Thu, 13 Jun 2013 15:45:18 +0000 (+0000)
Subject: manual (docs are ctr)
X-Git-Tag: 2.4.5~118
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=058dc34f9a88ace3b24b3c52fcad2d5e2ae07458;p=apache

manual (docs are ctr)


git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/branches/2.4.x@1492711 13f79535-47bb-0310-9956-ffa450edef68
---

diff --git a/docs/manual/mod/mod_proxy_wstunnel.xml b/docs/manual/mod/mod_proxy_wstunnel.xml
new file mode 100644
index 0000000000..eec31cc287
--- /dev/null
+++ b/docs/manual/mod/mod_proxy_wstunnel.xml
@@ -0,0 +1,55 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
+<?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
+<!-- $LastChangedRevision: 1174747 $ -->
+
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+<modulesynopsis metafile="mod_proxy_wstunnel.xml.meta">
+
+<name>mod_proxy_wstunnel</name>
+<description>wstunnel external process support module for
+<module>mod_proxy</module></description>
+<status>Extension</status>
+<sourcefile>mod_proxy_wstunnel.c</sourcefile>
+<identifier>proxy_wstunnel_module</identifier>
+<compatibility>Available for unix in version 2.4.5 and later</compatibility>
+
+<summary>
+    <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
+    is automagically upgraded to a websocket connection:</p>
+
+    <highlight language="config">
+Upgrade: WebSocket
+Connection: Upgrade
+    </highlight>
+
+
+    <example><title>Proxying requests to websockets server</title>
+    <highlight language="config">
+ProxyPass /ws2/  ws://echo.websocket.org/
+ProxyPass /wss2/ wss://echo.websocket.org/
+    </highlight>
+    </example>
+
+</summary>
+
+<seealso><module>mod_proxy</module></seealso>
+</modulesynopsis>