Mercurial > prosody-modules

comparison mod_auth_sql/README.md @ 5975:fe081789f7b5

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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
parents mod_auth_sql/README.markdown@4d73a1a6ba68
children f1743e2c23ba
comparison
equal deleted inserted replaced
5974:5a65a632d5b9 5975:fe081789f7b5
1 ---
2 labels:
3 - 'Type-Auth'
4 - 'Stage-Stable'
5 summary: SQL Database authentication module
6 ...
7
8 Introduction
9 ============
10
11 Allow client authentication to be handled by an SQL database query.
12
13 Unlike mod\_storage\_sql (which is supplied with Prosody) this module
14 allows for custom schemas (though currently it is required to edit the
15 source).
16
17 Configuration
18 =============
19
20 As with all auth modules, there is no need to add this to
21 modules\_enabled. Simply add in the global section, or for the relevant
22 hosts:
23
24 authentication = "sql"
25
26 This module reuses the database configuration of
27 [mod\_storage\_sql](http://prosody.im/doc/modules/mod_storage_sql) (the
28 'sql' option), which you can set even if you are not using SQL as
29 Prosody's primary storage backend.
30
31 The query is currently hardcoded in the module, so you will need to edit
32 the module to change it. The default query is compatible with jabberd2
33 DB schema.
34
35 Compatibility
36 =============
37
38 ----- -------
39 0.8 Works
40 ----- -------