diff mod_auth_sql/README.wiki @ 1782:29f3d6b7ad16

Import wiki pages
author Kim Alvefur <zash@zash.se>
date Mon, 24 Aug 2015 16:43:56 +0200
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_auth_sql/README.wiki	Mon Aug 24 16:43:56 2015 +0200
@@ -0,0 +1,23 @@
+#summary SQL Database authentication module
+#labels Type-Auth,Stage-Stable
+
+= 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 [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.
+
+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||
\ No newline at end of file