# HG changeset patch
# User MWild1@gmail.com
# Date 1376416034 0
# Node ID 5720e3f68061df07021934e1c395518995dc780d
# Parent  af771646760b84081af69e1d91b7afebf706fc9c
Update docs for lpty-based version

diff -r af771646760b -r 5720e3f68061 mod_auth_external.wiki
--- a/mod_auth_external.wiki	Fri Aug 02 18:23:40 2013 +0200
+++ b/mod_auth_external.wiki	Tue Aug 13 17:47:14 2013 +0000
@@ -5,6 +5,16 @@
 
 Allow client authentication to be handled by an external script/process.
 
+= Installation =
+
+mod_auth_external depends on a Lua module called [http://www.tset.de/lpty/ lpty]. You can install it on many platforms using [http://luarocks.org/ LuaRocks], for example:
+
+{{{
+   sudo luarocks install lpty
+}}}
+
+Note: Earlier versions of the module did not depend on lpty. While using the newer version is strongly recommended, you can find the [https://prosody-modules.googlecode.com/hg-history/50ee38e95e754bf1034d980364f93564028b2f34/mod_auth_external/mod_auth_external.lua older version here] if you need it (revision 50ee38e95e75 of the repository).
+
 = Configuration =
 
 As with all auth modules, there is no need to add this to modules_enabled. Simply add in the global section, or for the relevant hosts:
@@ -17,6 +27,7 @@
 
 ||external_auth_protocol||May be "generic" or "ejabberd" (the latter for compatibility with ejabberd external auth scripts. Default is "generic".||
 ||external_auth_command||The command/script to execute.||
+||external_auth_timeout||The number of seconds to wait for a response from the auth process. Default is 5.||
 
 = Protocol =
 
@@ -59,4 +70,5 @@
 }}}
 
 = Compatibility =
-||0.8||Works||
\ No newline at end of file
+||0.8||Works||
+||0.9||Works||
\ No newline at end of file