Mercurial > prosody-modules
diff mod_auth_sql/README.markdown @ 1803:4d73a1a6ba68
Convert all wiki pages to Markdown
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Fri, 28 Aug 2015 18:03:58 +0200 |
parents | mod_auth_sql/README.wiki@29f3d6b7ad16 |
children |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mod_auth_sql/README.markdown Fri Aug 28 18:03:58 2015 +0200 @@ -0,0 +1,40 @@ +--- +labels: +- 'Type-Auth' +- 'Stage-Stable' +summary: SQL Database authentication module +... + +Introduction +============ + +Allow client authentication to be handled by an SQL database query. + +Unlike mod\_storage\_sql (which is supplied with Prosody) this module +allows for custom schemas (though currently it is required to edit the +source). + +Configuration +============= + +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: + + authentication = "sql" + +This module reuses the database configuration of +[mod\_storage\_sql](http://prosody.im/doc/modules/mod_storage_sql) (the +'sql' option), which you can set even if you are not using SQL as +Prosody's primary storage backend. + +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. + +Compatibility +============= + + ----- ------- + 0.8 Works + ----- -------