|
1782
|
1 #summary Dovecot authentication module |
|
|
2 #labels Stage-Alpha,Type-Auth |
|
|
3 |
|
|
4 = Introduction = |
|
|
5 |
|
|
6 This is a Prosody authentication plugin which uses Dovecot as the backend. |
|
|
7 |
|
|
8 = Configuration = |
|
|
9 |
|
|
10 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: |
|
|
11 |
|
|
12 {{{ |
|
|
13 authentication = "dovecot" |
|
|
14 }}} |
|
|
15 |
|
|
16 These options are used by mod_auth_dovecot: |
|
|
17 |
|
|
18 || *Name* || *Description* || *Default value* || |
|
|
19 || dovecot_auth_socket || Path to the Dovecot auth socket || "/var/run/dovecot/auth-login" || |
|
|
20 || auth_append_host || If true, sends the bare JID as authzid. || false || |
|
|
21 |
|
|
22 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. |
|
|
23 |
|
|
24 {{{ |
|
|
25 socket listen { |
|
|
26 ... |
|
|
27 client { |
|
|
28 path = /var/spool/prosody/private/auth-client |
|
|
29 mode = 0660 |
|
|
30 user = prosody |
|
|
31 group = prosody |
|
|
32 } |
|
|
33 }}} |
|
|
34 |
|
|
35 Make sure the socket directories exist and are owned by the Prosody user. |
|
|
36 |
|
|
37 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. |
|
|
38 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. |
|
|
39 |
|
|
40 == TCP socket support for Dovecot 2.x == |
|
|
41 |
|
|
42 Dovecot 2.x includes TCP socket support. These are the relevant mod_auth_dovecot options: |
|
|
43 |
|
|
44 || *Name* || *Description* || *Default value* || |
|
|
45 || dovecot_auth_host || Hostname to connect to. || "127.0.0.1" || |
|
|
46 || dovecot_auth_port || Port to connect to. || _(this value is required)_ || |
|
|
47 |
|
|
48 = Compatibility = |
|
|
49 ||trunk||Works|| |
|
|
50 ||0.8||Works|| |
