Project

General

Profile

Docs ModWSTunnel » History » Revision 5

Revision 4 (gstrauss, 2017-09-24 02:50) → Revision 5/7 (gstrauss, 2017-09-24 02:54)

h1. mod_wstunnel 

 {{>toc}} 

 *Module: mod_wstunnel* 

 WebSocket tunnel endpoint.    This module terminates the websocket tunnel from a client.    This module then passes data (without websocket frames) to a backend and encodes responses from backend in websocket frames before sending responses to client. 

 *EXPERIMENTAL* (new in lighttpd 1.4.46) 

 Note: if looking to proxy websockets to a backend, then see [[Docs_ModProxy]], [[Docs_ModCGI]], or other backends, some of which can be enabled to be transparent proxies to backends after client sends @Upgrade: websocket@ 

 h2. Description 

 Brief description of [[Docs_ConfigurationOptions#mod_wstunnel|mod_wstunnel directives]] 

 table{margin-left: 2em}. 
 |_.option |_. description | 
 | wstunnel.server | backend server definition(s) for hosts to which to send requests; [[Docs_ConfigurationOptions#gw_backend-gateway-server-host-options|options]] for each backend host | 
 | wstunnel.balance | load-balancing algorithm for backends ("fair", "least-connection", "round-robin", "hash", or "sticky") | 
 | wstunnel.debug | debug level (value between 0 and 65535) | 
 | wstunnel.frame-type | websocket frame type: "text" or "binary" | 
 | wstunnel.map-extensions | map multiple extensions to the same wstunnel backend | 
 | wstunnel.origins | list of permitted origins in Origin request header (optional) | 
 | wstunnel.ping-interval | send websocket PING frame at given interval in sec (default 0; none sent) | 

 Details for @wstunnel.server@ parameters can be found in [[Docs_ModFastCGI|mod_fastcgi]] documentation, since the wstunnel module shares the same code infrastructure with the FastCGI module, and fastcgi.server parameters are very similar.