Mercurial > prosody-modules
annotate mod_auth_sql/README.md @ 6403:13c61a068c71
mod_pubsub_serverinfo: Include hostname in default pubsub node name
This change ensures that every host publishes to a unique node by default,
which is important when publishing info about multiple hosts.
The old default node name was "serverinfo"
The new default node name is in the format "serverinfo/example.com" where
example.com is automatically replaced by the publishing host's name.
This affects existing deployments in the following ways:
- If you already configured pubsub_serverinfo_node explicitly in your config,
then nothing will change, your current configuration will still be used.
- If you did not specify it in your config (i.e. used the default) then the
module will switch to publishing to the new node. If your configuration is
correct this shouldn't be noticed, because the new node will automatically
be created and configured by the module. If you want, you can clean up the
old 'serverinfo' node using:
prosodyctl shell pubsub delete_node pubsub.example.com serverinfo
| author | Matthew Wild <mwild1@gmail.com> |
|---|---|
| date | Wed, 11 Feb 2026 09:40:30 +0000 |
| parents | caaa9ea58bec |
| children |
| rev | line source |
|---|---|
|
1803
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
1 --- |
|
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
2 labels: |
|
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
3 - 'Type-Auth' |
|
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
4 - 'Stage-Stable' |
|
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
5 summary: SQL Database authentication module |
|
6370
f1743e2c23ba
mod_auth_sql: Fix markdown frontmatter in README
Christian Weiske <cweiske@cweiske.de>
parents:
5975
diff
changeset
|
6 --- |
| 1782 | 7 |
|
1803
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
8 Introduction |
|
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
9 ============ |
| 1782 | 10 |
| 11 Allow client authentication to be handled by an SQL database query. | |
| 12 | |
|
1803
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
13 Unlike mod\_storage\_sql (which is supplied with Prosody) this module |
|
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
14 allows for custom schemas (though currently it is required to edit the |
|
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
15 source). |
| 1782 | 16 |
|
1803
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
17 Configuration |
|
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
18 ============= |
| 1782 | 19 |
|
1803
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
20 As with all auth modules, there is no need to add this to |
|
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
21 modules\_enabled. Simply add in the global section, or for the relevant |
|
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
22 hosts: |
|
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
23 |
|
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
24 authentication = "sql" |
| 1782 | 25 |
|
1803
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
26 This module reuses the database configuration of |
|
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
27 [mod\_storage\_sql](http://prosody.im/doc/modules/mod_storage_sql) (the |
|
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
28 'sql' option), which you can set even if you are not using SQL as |
|
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
29 Prosody's primary storage backend. |
| 1782 | 30 |
|
1803
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
31 The query is currently hardcoded in the module, so you will need to edit |
|
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
32 the module to change it. The default query is compatible with jabberd2 |
|
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
33 DB schema. |
| 1782 | 34 |
|
6371
caaa9ea58bec
mod_auth_sql: Document database table in README
Christian Weiske <cweiske@cweiske.de>
parents:
6370
diff
changeset
|
35 |
|
caaa9ea58bec
mod_auth_sql: Document database table in README
Christian Weiske <cweiske@cweiske.de>
parents:
6370
diff
changeset
|
36 Database schema |
|
caaa9ea58bec
mod_auth_sql: Document database table in README
Christian Weiske <cweiske@cweiske.de>
parents:
6370
diff
changeset
|
37 =============== |
|
caaa9ea58bec
mod_auth_sql: Document database table in README
Christian Weiske <cweiske@cweiske.de>
parents:
6370
diff
changeset
|
38 |
|
caaa9ea58bec
mod_auth_sql: Document database table in README
Christian Weiske <cweiske@cweiske.de>
parents:
6370
diff
changeset
|
39 `mod_auth_sql` requires a database table `authreg` with the following columns: |
|
caaa9ea58bec
mod_auth_sql: Document database table in README
Christian Weiske <cweiske@cweiske.de>
parents:
6370
diff
changeset
|
40 |
|
caaa9ea58bec
mod_auth_sql: Document database table in README
Christian Weiske <cweiske@cweiske.de>
parents:
6370
diff
changeset
|
41 - `username` - First part of the JID, before the `@` |
|
caaa9ea58bec
mod_auth_sql: Document database table in README
Christian Weiske <cweiske@cweiske.de>
parents:
6370
diff
changeset
|
42 - `realm` - Part of the JID after the `@` |
|
caaa9ea58bec
mod_auth_sql: Document database table in README
Christian Weiske <cweiske@cweiske.de>
parents:
6370
diff
changeset
|
43 - `password` - Plain text password (insecure!) |
|
caaa9ea58bec
mod_auth_sql: Document database table in README
Christian Weiske <cweiske@cweiske.de>
parents:
6370
diff
changeset
|
44 |
|
caaa9ea58bec
mod_auth_sql: Document database table in README
Christian Weiske <cweiske@cweiske.de>
parents:
6370
diff
changeset
|
45 |
|
1803
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
46 Compatibility |
|
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
47 ============= |
| 1782 | 48 |
|
1803
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
49 ----- ------- |
|
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
50 0.8 Works |
|
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
51 ----- ------- |
