Mercurial > prosody-modules

comparison mod_auth_dovecot/README.markdown @ 1803:4d73a1a6ba68

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Convert all wiki pages to Markdown
author Kim Alvefur <zash@zash.se>
date Fri, 28 Aug 2015 18:03:58 +0200
parents mod_auth_dovecot/README.wiki@29f3d6b7ad16
children 8de50be756e5
comparison
equal deleted inserted replaced
1802:0ab737feada6 1803:4d73a1a6ba68
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 socket listen {
36 ...
37 client {
38 path = /var/spool/prosody/private/auth-client
39 mode = 0660
40 user = prosody
41 group = prosody
42 }
43
44 Make sure the socket directories exist and are owned by the Prosody
45 user.
46
47 Note: Dovecot uses UNIX sockets by default. luasocket is compiled with
48 UNIX socket on debian/ubuntu by default, but is not on many other
49 platforms. If you run into this issue, you would need to either
50 recompile luasocket with UNIX socket support, or use Dovecot 2.x's TCP
51 socket support.
52
53 TCP socket support for Dovecot 2.x
54 ----------------------------------
55
56 Dovecot 2.x includes TCP socket support. These are the relevant
57 mod\_auth\_dovecot options:
58
59 Name Description Default value
60 --------------------- ------------------------- ----------------------------
61 dovecot\_auth\_host Hostname to connect to. "127.0.0.1"
62 dovecot\_auth\_port Port to connect to. *(this value is required)*
63
64 Compatibility
65 =============
66
67 ------- -------
68 trunk Works
69 0.8 Works
70 ------- -------