Mercurial > prosody-modules

diff mod_auth_external/README.markdown @ 3390:788200f5f481

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_auth_external/README: Update to reflect non-blocking by default
author Kim Alvefur <zash@zash.se>
date Sat, 01 Dec 2018 15:27:53 +0100
parents ea6b5321db50
children 3287dd234f3f
line wrap: on
line diff
--- a/mod_auth_external/README.markdown	Sat Dec 01 15:22:49 2018 +0100
+++ b/mod_auth_external/README.markdown	Sat Dec 01 15:27:53 2018 +0100
@@ -52,7 +52,9 @@
 Blocking vs non-blocking
 ------------------------
 
-Non-blocking mode is automatically activated when:
+Non-blocking mode is experimental and is disabled by default.
+
+Enable at your own risk if you fulfil these conditions:
 
 -   Running Prosody trunk ([nightly](http://prosody.im/nightly/) build
     414+).
@@ -60,6 +62,10 @@
     and LuaEvent is available.
 -   lpty (see installation above) is version 1.0.1 or later.
 
+```lua
+external_auth_blocking = false;
+```
+
 Protocol
 ========