Add short example on how to get Websockets to work

fdd168f9 · Lasse Karstensen · Tollef Fog Heen · 7160b841 · fdd168f9
Commit fdd168f9 authored Feb 24, 2012 by Lasse Karstensen Committed by Tollef Fog Heen May 23, 2012
Hide whitespace changes
Inline Side-by-side

Showing with 20 additions and 0 deletions

websockets.rst doc/sphinx/tutorial/websockets.rst +20 -0

No files found.
--- a/doc/sphinx/tutorial/websockets.rst
+++ b/doc/sphinx/tutorial/websockets.rst
+
+Using Websockets 
+----------------
+
+Websockets is a technology for creating a bidirectional stream-based channel over HTTP.
+
+To run websockets through Varnish you need to pipe it, and copy the Upgrade header. Use the following
+VCL config to do so::
+
+    sub vcl_pipe {
+         if (req.http.upgrade) {
+             set bereq.http.upgrade = req.http.upgrade;
+         }
+    }
+    sub vcl_recv {
+         if (req.http.Upgrade ~ "(?i)websocket") {
+             return (pipe);
+         }
+    }
+