r5193 - trunk/varnish-cache/doc/sphinx/reference

[perbu at varnish-cache.org]

Author: perbu
Date: 2010-09-12 23:04:54 +0200 (Sun, 12 Sep 2010)
New Revision: 5193

Modified:
   trunk/varnish-cache/doc/sphinx/reference/vcl.rst
Log:
first take at documenting the two new directors

Modified: trunk/varnish-cache/doc/sphinx/reference/vcl.rst
===================================================================
--- trunk/varnish-cache/doc/sphinx/reference/vcl.rst	2010-09-12 18:18:47 UTC (rev 5192)
+++ trunk/varnish-cache/doc/sphinx/reference/vcl.rst	2010-09-12 21:04:54 UTC (rev 5193)
@@ -139,8 +139,33 @@
 The round-robin director
 ~~~~~~~~~~~~~~~~~~~~~~~~
 
-The round-robin does not take any options.
+The round-robin director does not take any options.
 
+
+The client director
+~~~~~~~~~~~~~~~~~~~
+
+The client director picks a backend based on the clients
+*identity*. You can set the VCL variable *client.identity* to identify
+the client by picking up the value of a session cookie or similar.
+
+Note: in 2.1 *client.identity* isn't available and the director will
+use client.ip to distribute clients across backends.
+
+The client director takes no options.
+
+The hash director
+~~~~~~~~~~~~~~~~~
+
+The hash director will pick a backend based on the URL hash
+value. 
+
+This is useful is you are using Varnish to load balance in front of
+other Varnish caches or other web accelerators as objects won't be
+duplicated across caches.
+
+The hash director takes no options.
+
 The DNS director
 ~~~~~~~~~~~~~~~~