annotate mod_auth_sql.wiki @ 503:a4637b24841a

mod_admin_message -- added Stage-Beta label.
author mikael.berthe@gmail.com
date Sun, 25 Jan 2015 19:10:06 +0000
parents a7fb9f14c50e
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
480
a7fb9f14c50e Consistency
paul.aurich@gmail.com
parents: 306
diff changeset
1 #summary SQL Database authentication module
194
aa6f9235fb61 Edited wiki page mod_auth_sql through web user interface.
tomasz.sterna@gmail.com
parents: 193
diff changeset
2 #labels Type-Auth,Stage-Stable
193
ac9dca526a4e Created wiki page through web user interface.
tomasz.sterna@gmail.com
parents:
diff changeset
3
ac9dca526a4e Created wiki page through web user interface.
tomasz.sterna@gmail.com
parents:
diff changeset
4 = Introduction =
ac9dca526a4e Created wiki page through web user interface.
tomasz.sterna@gmail.com
parents:
diff changeset
5
306
2ec60540a8c7 Clarify relationship to mod_storage_sql
MWild1@gmail.com
parents: 196
diff changeset
6 Allow client authentication to be handled by an SQL database query.
193
ac9dca526a4e Created wiki page through web user interface.
tomasz.sterna@gmail.com
parents:
diff changeset
7
306
2ec60540a8c7 Clarify relationship to mod_storage_sql
MWild1@gmail.com
parents: 196
diff changeset
8 Unlike mod_storage_sql (which is supplied with Prosody) this module allows for custom schemas (though currently it is required to edit the source).
193
ac9dca526a4e Created wiki page through web user interface.
tomasz.sterna@gmail.com
parents:
diff changeset
9
ac9dca526a4e Created wiki page through web user interface.
tomasz.sterna@gmail.com
parents:
diff changeset
10 = Configuration =
ac9dca526a4e Created wiki page through web user interface.
tomasz.sterna@gmail.com
parents:
diff changeset
11
ac9dca526a4e Created wiki page through web user interface.
tomasz.sterna@gmail.com
parents:
diff changeset
12 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:
ac9dca526a4e Created wiki page through web user interface.
tomasz.sterna@gmail.com
parents:
diff changeset
13
ac9dca526a4e Created wiki page through web user interface.
tomasz.sterna@gmail.com
parents:
diff changeset
14 {{{
ac9dca526a4e Created wiki page through web user interface.
tomasz.sterna@gmail.com
parents:
diff changeset
15 authentication = "sql"
ac9dca526a4e Created wiki page through web user interface.
tomasz.sterna@gmail.com
parents:
diff changeset
16 }}}
ac9dca526a4e Created wiki page through web user interface.
tomasz.sterna@gmail.com
parents:
diff changeset
17
196
05d9b1ba313a Typo fixes and some clarification
MWild1
parents: 194
diff changeset
18 This module reuses the database configuration of [http://prosody.im/doc/modules/mod_storage_sql mod_storage_sql] (the 'sql' option), which you can set even if you are not using SQL as Prosody's primary storage backend.
193
ac9dca526a4e Created wiki page through web user interface.
tomasz.sterna@gmail.com
parents:
diff changeset
19
196
05d9b1ba313a Typo fixes and some clarification
MWild1
parents: 194
diff changeset
20 The query is currently hardcoded in the module, so you will need to edit the module to change it. The default query is compatible with jabberd2 DB schema.
193
ac9dca526a4e Created wiki page through web user interface.
tomasz.sterna@gmail.com
parents:
diff changeset
21
ac9dca526a4e Created wiki page through web user interface.
tomasz.sterna@gmail.com
parents:
diff changeset
22 = Compatibility =
ac9dca526a4e Created wiki page through web user interface.
tomasz.sterna@gmail.com
parents:
diff changeset
23 ||0.8||Works||