view @ 213:7c960f1b4cf8

added summary.
date Sun, 11 Sep 2011 00:30:49 +0000
parents 5211b343abc2
children a928ab41c909
line wrap: on
line source

#summary Dovecot authentication module
#labels Stage-Alpha,Type-Auth

= 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.

= Compatibility =