README.markdown
1---
2labels:
3- 'Stage-Alpha'
4- 'Type-Auth'
5summary: Dovecot authentication module
6...
7
8Introduction
9============
10
11This is a Prosody authentication plugin which uses Dovecot as the
12backend.
13
14Configuration
15=============
16
17As with all auth modules, there is no need to add this to
18modules\_enabled. Simply add in the global section, or for the relevant
19hosts:
20
21 authentication = "dovecot"
22
23These 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
30The Dovecot user and group must have access to connect to this socket.
31You can create a new dedicated socket for Prosody too. Add the below to
32the *socket listen* section of /etc/dovecot/dovecot.conf, and match the
33socket 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
43Make sure the socket directories exist and are owned by the Prosody
44user.
45
46Note: Dovecot uses UNIX sockets by default. luasocket is compiled with
47UNIX socket on debian/ubuntu by default, but is not on many other
48platforms. If you run into this issue, you would need to either
49recompile luasocket with UNIX socket support, or use Dovecot 2.x's TCP
50socket support.
51
52TCP socket support for Dovecot 2.x
53----------------------------------
54
55Dovecot 2.x includes TCP socket support. These are the relevant
56mod\_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
63Compatibility
64=============
65
66 ------- -------
67 trunk Works
68 0.8 Works
69 ------- -------
70