mod_auth_dovecot/README.markdown

   1 ---
   2 labels:
   3 - 'Stage-Alpha'
   4 - 'Type-Auth'
   5 summary: Dovecot authentication module
   6 ...
   7
   8 Introduction
   9 ============
  10
  11 This is a Prosody authentication plugin which uses Dovecot as the
  12 backend.
  13
  14 Configuration
  15 =============
  16
  17 As with all auth modules, there is no need to add this to
  18 modules\_enabled. Simply add in the global section, or for the relevant
  19 hosts:
  20
  21     authentication = "dovecot"
  22
  23 These options are used by mod\_auth\_dovecot:
  24
  25   Name                    Description                               Default value
  26   ----------------------- ----------------------------------------- -------------------------------
  27   dovecot\_auth\_socket   Path to the Dovecot auth socket           "/var/run/dovecot/auth-login"
  28   auth\_append\_host      If true, sends the bare JID as authzid.   false
  29
  30 The Dovecot user and group must have access to connect to this socket.
  31 You can create a new dedicated socket for Prosody too. Add the below to
  32 the *socket listen* section of /etc/dovecot/dovecot.conf, and match the
  33 socket path in Prosody's dovecot\_auth\_socket setting.
  34
  35     service auth {
  36         unix_listener /var/spool/prosody/private/auth-client {
  37             mode = 0660
  38             user = prosody
  39             group = prosody
  40         }
  41     }
  42
  43 Make sure the socket directories exist and are owned by the Prosody
  44 user.
  45
  46 Note: Dovecot uses UNIX sockets by default. luasocket is compiled with
  47 UNIX socket on debian/ubuntu by default, but is not on many other
  48 platforms. If you run into this issue, you would need to either
  49 recompile luasocket with UNIX socket support, or use Dovecot 2.x's TCP
  50 socket support.
  51
  52 TCP socket support for Dovecot 2.x
  53 ----------------------------------
  54
  55 Dovecot 2.x includes TCP socket support. These are the relevant
  56 mod\_auth\_dovecot options:
  57
  58   Name                  Description               Default value
  59   --------------------- ------------------------- ----------------------------
  60   dovecot\_auth\_host   Hostname to connect to.   "127.0.0.1"
  61   dovecot\_auth\_port   Port to connect to.       *(this value is required)*
  62
  63 Compatibility
  64 =============
  65
  66   ------- -------
  67   trunk   Works
  68   0.8     Works
  69   ------- -------