Mercurial > prosody-modules
diff mod_auth_dovecot/README.markdown @ 1803:4d73a1a6ba68
Convert all wiki pages to Markdown
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Fri, 28 Aug 2015 18:03:58 +0200 (2015-08-28) |
parents | mod_auth_dovecot/README.wiki@29f3d6b7ad16 |
children | 8de50be756e5 |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mod_auth_dovecot/README.markdown Fri Aug 28 18:03:58 2015 +0200 @@ -0,0 +1,70 @@ +--- +labels: +- 'Stage-Alpha' +- 'Type-Auth' +summary: Dovecot authentication module +... + +Introduction +============ + +This is a Prosody authentication plugin which uses Dovecot as the +backend. + +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: + + authentication = "dovecot" + +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" + 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. + + socket listen { + ... + client { + path = /var/spool/prosody/private/auth-client + mode = 0660 + user = prosody + group = prosody + } + +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 + ------- -------