mod_proxy_wstunnel.xml revision 2544c1693130c0a3106f2ff2c0ef7e3cf0a228e0
bee2440354b4bc8796e1de0b6cbd60e1f68deba0Phill Cunnington<?xml version="1.0" encoding="utf-8"?>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<!DOCTYPE modulesynopsis SYSTEM "/style/modulesynopsis.dtd">
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<?xml-stylesheet type="text/xsl" href="/style/manual.en.xsl"?>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<!-- $LastChangedRevision: 1174747 $ -->
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<!--
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster Licensed to the Apache Software Foundation (ASF) under one or more
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster contributor license agreements. See the NOTICE file distributed with
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster this work for additional information regarding copyright ownership.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster The ASF licenses this file to You under the Apache License, Version 2.0
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster (the "License"); you may not use this file except in compliance with
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster the License. You may obtain a copy of the License at
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster http://www.apache.org/licenses/LICENSE-2.0
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster Unless required by applicable law or agreed to in writing, software
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster distributed under the License is distributed on an "AS IS" BASIS,
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster See the License for the specific language governing permissions and
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster limitations under the License.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster-->
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<modulesynopsis metafile="mod_proxy_wstunnel.xml.meta">
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<name>mod_proxy_wstunnel</name>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<description>Websockets support module for
365156d5428edc07eae024879829e586bbaf9d42Neil Madden<module>mod_proxy</module></description>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<status>Extension</status>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<sourcefile>mod_proxy_wstunnel.c</sourcefile>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<identifier>proxy_wstunnel_module</identifier>
bee2440354b4bc8796e1de0b6cbd60e1f68deba0Phill Cunnington<compatibility>Available for unix in version 2.4.5 and later</compatibility>
bee2440354b4bc8796e1de0b6cbd60e1f68deba0Phill Cunnington
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<summary>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <p>This module <em>requires</em> the service of <module
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster >mod_proxy</module>. It provides support for the tunnelling of web
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster socket connections to a backend websockets server. The connection
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster is automagically upgraded to a websocket connection:</p>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <highlight language="config">
8af80418ba1ec431c8027fa9668e5678658d3611Allan FosterUpgrade: WebSocket
8af80418ba1ec431c8027fa9668e5678658d3611Allan FosterConnection: Upgrade
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster </highlight>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <example><title>Proxying requests to websockets server</title>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <highlight language="config">
8af80418ba1ec431c8027fa9668e5678658d3611Allan FosterProxyPass /ws2/ ws://echo.websocket.org/
8af80418ba1ec431c8027fa9668e5678658d3611Allan FosterProxyPass /wss2/ wss://echo.websocket.org/
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster </highlight>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster </example>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster</summary>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<seealso><module>mod_proxy</module></seealso>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster</modulesynopsis>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster