Mercurial > prosody-wiki

annotate mod_auth_dovecot.wiki @ 242:1c53626aadde

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add stub about mod_pubsub_feed
author Kim Alvefur <zash@zash.se>
date Wed, 07 Dec 2011 18:26:25 +0100
parents a928ab41c909
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
207
d716766d946a Add page about the Dovecot auth module
Kim Alvefur <zash@zash.se>
parents:
diff changeset
1 #summary Dovecot authentication module
d716766d946a Add page about the Dovecot auth module
Kim Alvefur <zash@zash.se>
parents:
diff changeset
2 #labels Stage-Alpha,Type-Auth
d716766d946a Add page about the Dovecot auth module
Kim Alvefur <zash@zash.se>
parents:
diff changeset
3
d716766d946a Add page about the Dovecot auth module
Kim Alvefur <zash@zash.se>
parents:
diff changeset
4 = Introduction =
d716766d946a Add page about the Dovecot auth module
Kim Alvefur <zash@zash.se>
parents:
diff changeset
5
d716766d946a Add page about the Dovecot auth module
Kim Alvefur <zash@zash.se>
parents:
diff changeset
6 This is a Prosody authentication plugin which uses Dovecot as the backend.
d716766d946a Add page about the Dovecot auth module
Kim Alvefur <zash@zash.se>
parents:
diff changeset
7
d716766d946a Add page about the Dovecot auth module
Kim Alvefur <zash@zash.se>
parents:
diff changeset
8 = Configuration =
d716766d946a Add page about the Dovecot auth module
Kim Alvefur <zash@zash.se>
parents:
diff changeset
9
d716766d946a Add page about the Dovecot auth module
Kim Alvefur <zash@zash.se>
parents:
diff changeset
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:
d716766d946a Add page about the Dovecot auth module
Kim Alvefur <zash@zash.se>
parents:
diff changeset
11
d716766d946a Add page about the Dovecot auth module
Kim Alvefur <zash@zash.se>
parents:
diff changeset
12 {{{
d716766d946a Add page about the Dovecot auth module
Kim Alvefur <zash@zash.se>
parents:
diff changeset
13 authentication = "dovecot"
d716766d946a Add page about the Dovecot auth module
Kim Alvefur <zash@zash.se>
parents:
diff changeset
14 }}}
d716766d946a Add page about the Dovecot auth module
Kim Alvefur <zash@zash.se>
parents:
diff changeset
15
210
5211b343abc2 mod_auth_dovecot: minor clarification
Kim Alvefur <zash@zash.se>
parents: 209
diff changeset
16 These options are used by mod_auth_dovecot:
207
d716766d946a Add page about the Dovecot auth module
Kim Alvefur <zash@zash.se>
parents:
diff changeset
17
d716766d946a Add page about the Dovecot auth module
Kim Alvefur <zash@zash.se>
parents:
diff changeset
18 || *Name* || *Description* || *Default value* ||
214
a928ab41c909 mod_auth_dovecot: Add a little documentation for TCP socket support.
Waqas Hussain <waqas20@gmail.com>
parents: 210
diff changeset
19 || dovecot_auth_socket || Path to the Dovecot auth socket || "/var/run/dovecot/auth-login" ||
207
d716766d946a Add page about the Dovecot auth module
Kim Alvefur <zash@zash.se>
parents:
diff changeset
20 || auth_append_host || If true, sends the bare JID as authzid. || false ||
d716766d946a Add page about the Dovecot auth module
Kim Alvefur <zash@zash.se>
parents:
diff changeset
21
209
101519e4ef14 Edited wiki page mod_auth_dovecot through web user interface.
daniel@aleksand.no
parents: 207
diff changeset
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.
101519e4ef14 Edited wiki page mod_auth_dovecot through web user interface.
daniel@aleksand.no
parents: 207
diff changeset
23
101519e4ef14 Edited wiki page mod_auth_dovecot through web user interface.
daniel@aleksand.no
parents: 207
diff changeset
24 {{{
101519e4ef14 Edited wiki page mod_auth_dovecot through web user interface.
daniel@aleksand.no
parents: 207
diff changeset
25 socket listen {
101519e4ef14 Edited wiki page mod_auth_dovecot through web user interface.
daniel@aleksand.no
parents: 207
diff changeset
26 ...
101519e4ef14 Edited wiki page mod_auth_dovecot through web user interface.
daniel@aleksand.no
parents: 207
diff changeset
27 client {
101519e4ef14 Edited wiki page mod_auth_dovecot through web user interface.
daniel@aleksand.no
parents: 207
diff changeset
28 path = /var/spool/prosody/private/auth-client
101519e4ef14 Edited wiki page mod_auth_dovecot through web user interface.
daniel@aleksand.no
parents: 207
diff changeset
29 mode = 0660
101519e4ef14 Edited wiki page mod_auth_dovecot through web user interface.
daniel@aleksand.no
parents: 207
diff changeset
30 user = prosody
101519e4ef14 Edited wiki page mod_auth_dovecot through web user interface.
daniel@aleksand.no
parents: 207
diff changeset
31 group = prosody
101519e4ef14 Edited wiki page mod_auth_dovecot through web user interface.
daniel@aleksand.no
parents: 207
diff changeset
32 }
101519e4ef14 Edited wiki page mod_auth_dovecot through web user interface.
daniel@aleksand.no
parents: 207
diff changeset
33 }}}
101519e4ef14 Edited wiki page mod_auth_dovecot through web user interface.
daniel@aleksand.no
parents: 207
diff changeset
34
101519e4ef14 Edited wiki page mod_auth_dovecot through web user interface.
daniel@aleksand.no
parents: 207
diff changeset
35 Make sure the socket directories exist and are owned by the Prosody user.
101519e4ef14 Edited wiki page mod_auth_dovecot through web user interface.
daniel@aleksand.no
parents: 207
diff changeset
36
214
a928ab41c909 mod_auth_dovecot: Add a little documentation for TCP socket support.
Waqas Hussain <waqas20@gmail.com>
parents: 210
diff changeset
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.
a928ab41c909 mod_auth_dovecot: Add a little documentation for TCP socket support.
Waqas Hussain <waqas20@gmail.com>
parents: 210
diff changeset
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.
a928ab41c909 mod_auth_dovecot: Add a little documentation for TCP socket support.
Waqas Hussain <waqas20@gmail.com>
parents: 210
diff changeset
39
a928ab41c909 mod_auth_dovecot: Add a little documentation for TCP socket support.
Waqas Hussain <waqas20@gmail.com>
parents: 210
diff changeset
40 == TCP socket support for Dovecot 2.x ==
a928ab41c909 mod_auth_dovecot: Add a little documentation for TCP socket support.
Waqas Hussain <waqas20@gmail.com>
parents: 210
diff changeset
41
a928ab41c909 mod_auth_dovecot: Add a little documentation for TCP socket support.
Waqas Hussain <waqas20@gmail.com>
parents: 210
diff changeset
42 Dovecot 2.x includes TCP socket support. These are the relevant mod_auth_dovecot options:
a928ab41c909 mod_auth_dovecot: Add a little documentation for TCP socket support.
Waqas Hussain <waqas20@gmail.com>
parents: 210
diff changeset
43
a928ab41c909 mod_auth_dovecot: Add a little documentation for TCP socket support.
Waqas Hussain <waqas20@gmail.com>
parents: 210
diff changeset
44 || *Name* || *Description* || *Default value* ||
a928ab41c909 mod_auth_dovecot: Add a little documentation for TCP socket support.
Waqas Hussain <waqas20@gmail.com>
parents: 210
diff changeset
45 || dovecot_auth_host || Hostname to connect to. || "127.0.0.1" ||
a928ab41c909 mod_auth_dovecot: Add a little documentation for TCP socket support.
Waqas Hussain <waqas20@gmail.com>
parents: 210
diff changeset
46 || dovecot_auth_port || Port to connect to. || _(this value is required)_ ||
a928ab41c909 mod_auth_dovecot: Add a little documentation for TCP socket support.
Waqas Hussain <waqas20@gmail.com>
parents: 210
diff changeset
47
207
d716766d946a Add page about the Dovecot auth module
Kim Alvefur <zash@zash.se>
parents:
diff changeset
48 = Compatibility =
d716766d946a Add page about the Dovecot auth module
Kim Alvefur <zash@zash.se>
parents:
diff changeset
49 ||trunk||Works||
210
5211b343abc2 mod_auth_dovecot: minor clarification
Kim Alvefur <zash@zash.se>
parents: 209
diff changeset
50 ||0.8||Works||