# HG changeset patch
# User Waqas Hussain <waqas20@gmail.com>
# Date 1316270850 -18000
# Node ID a928ab41c909a4923b1f99ba2e2811b9e2dd0eee
# Parent  7c960f1b4cf867e7e6998973ff920f99b77039c8
mod_auth_dovecot: Add a little documentation for TCP socket support.

diff -r 7c960f1b4cf8 -r a928ab41c909 mod_auth_dovecot.wiki
--- a/mod_auth_dovecot.wiki	Sun Sep 11 00:30:49 2011 +0000
+++ b/mod_auth_dovecot.wiki	Sat Sep 17 19:47:30 2011 +0500
@@ -16,7 +16,7 @@
 These options are used by mod_auth_dovecot:
 
 || *Name* || *Description* || *Default value* ||
-|| dovecot_auth_socket || Path to the Dovecot auth socket || /var/run/dovecot/auth-login ||
+|| dovecot_auth_socket || Path to the Dovecot auth socket || "/var/run/dovecot/auth-login" ||
 || auth_append_host || If true, sends the bare JID as authzid. || false ||
 
 The Dovecot user and group must have access to connect to this socket. You can create a new dedicated socket for Prosody too. Add the below to the _socket listen_ section of /etc/dovecot/dovecot.conf, and match the socket path in Prosody's dovecot_auth_socket setting.
@@ -34,6 +34,17 @@
 
 Make sure the socket directories exist and are owned by the Prosody user.
 
+Note: Dovecot uses UNIX sockets by default. luasocket is compiled with UNIX socket on debian/ubuntu by default, but is not on many other platforms.
+If you run into this issue, you would need to either recompile luasocket with UNIX socket support, or use Dovecot 2.x's TCP socket support.
+
+== TCP socket support for Dovecot 2.x ==
+
+Dovecot 2.x includes TCP socket support. These are the relevant mod_auth_dovecot options:
+
+|| *Name* || *Description* || *Default value* ||
+|| dovecot_auth_host || Hostname to connect to. || "127.0.0.1" ||
+|| dovecot_auth_port || Port to connect to. || _(this value is required)_ ||
+
 = Compatibility =
 ||trunk||Works||
 ||0.8||Works||