prosody-modules
fe081789f7b5
mod_auth_dovecot/README.md

Find changesets by keywords by author, files, the commit message, revision number or hash, or revset expression.

Software / code / prosody-modules

Comparison

mod_auth_dovecot/README.md @ 6003:fe081789f7b5

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