# HG changeset patch
# User MWild1@gmail.com
# Date 1376481885 0
# Node ID 0045196dc6b9caf64833dee17a72e6ec741b57e6
# Parent  5720e3f68061df07021934e1c395518995dc780d
Add new options

diff -r 5720e3f68061 -r 0045196dc6b9 mod_auth_external.wiki
--- a/mod_auth_external.wiki	Tue Aug 13 17:47:14 2013 +0000
+++ b/mod_auth_external.wiki	Wed Aug 14 12:04:45 2013 +0000
@@ -27,7 +27,18 @@
 
 ||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.||
+
+Two other options are also available, depending on whether the module is running in 'blocking' or 'non-blocking' mode:
+||external_auth_timeout||blocking||The number of seconds to wait for a response from the auth process. Default is 5.||
+||external_auth_processes||non-blocking||The number of concurrent processes to spawn. Default is 1, increase to handle high connection rates efficiently.||
+
+== Blocking vs non-blocking ==
+
+Non-blocking mode is automatically activated when:
+
+  * Running Prosody trunk ([http://prosody.im/nightly/ nightly] build 414+).
+  * [http://prosody.im/doc/libevent libevent] is enabled in the config, and LuaEvent is available.
+  * lpty (see installation above) is version 1.0.1 or later.
 
 = Protocol =