Mercurial > prosody-modules

view mod_auth_sql/README.md @ 6323:6216d85162dc

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_invites_register_web: Fix loading resources from relative paths Both module:get_option_path and module:load_resource makes the path relative to the plugin resource directory, so when running form a source checkout where this path is relative, the path was expanded relative to itself, becoming duplicated.
author Kim Alvefur <zash@zash.se>
date Sat, 06 Sep 2025 20:57:57 +0200
parents fe081789f7b5
children f1743e2c23ba
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
  ----- -------