Mercurial > prosody-modules

view mod_auth_sql/README.markdown @ 3329:43d0e298ddda

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_conversejs: Explicitly depend on mod_http Not required since mod_bosh and mod_websocket already depend on mod_http, but explicit > implicit. hg: Enter commit message. Lines beginning with 'HG:' are removed.
author Kim Alvefur <zash@zash.se>
date Sun, 23 Sep 2018 18:54:52 +0200
parents 4d73a1a6ba68
children
line wrap: on
line source

---
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
  ----- -------