Mercurial > prosody-modules

annotate mod_auth_http_async/README.md @ 6496:5a01db53d680

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_muc_auto_role: Also restrict default role assignment to unaffiliated JIDs
author Matthew Wild <mwild1@gmail.com>
date Wed, 25 Mar 2026 09:47:22 +0000
parents 7b693a5539ad
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1933
afba0821f058 mod_auth_http_async/README: Add compatibility info
Kim Alvefur <zash@zash.se>
parents: 1888
diff changeset
1 ---
afba0821f058 mod_auth_http_async/README: Add compatibility info
Kim Alvefur <zash@zash.se>
parents: 1888
diff changeset
2 labels:
afba0821f058 mod_auth_http_async/README: Add compatibility info
Kim Alvefur <zash@zash.se>
parents: 1888
diff changeset
3 - Stage-Alpha
afba0821f058 mod_auth_http_async/README: Add compatibility info
Kim Alvefur <zash@zash.se>
parents: 1888
diff changeset
4 ...
afba0821f058 mod_auth_http_async/README: Add compatibility info
Kim Alvefur <zash@zash.se>
parents: 1888
diff changeset
5
1888
3483381c5e46 mod_auth_http_async: Add README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
6 Introduction
3483381c5e46 mod_auth_http_async: Add README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
7 ============
3483381c5e46 mod_auth_http_async: Add README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
8
6317
7b693a5539ad mod_auth_http_async: Update documentation
Kim Alvefur <zash@zash.se>
parents: 5975
diff changeset
9 This is an authentication module that does an asynchronous
1888
3483381c5e46 mod_auth_http_async: Add README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
10 HTTP call to verify username and password.
3483381c5e46 mod_auth_http_async: Add README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
11
3483381c5e46 mod_auth_http_async: Add README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
12 Details
3483381c5e46 mod_auth_http_async: Add README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
13 =======
3483381c5e46 mod_auth_http_async: Add README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
14
3483381c5e46 mod_auth_http_async: Add README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
15 When a user attempts to authenticate to Prosody, this module takes the
3483381c5e46 mod_auth_http_async: Add README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
16 username and password and does a HTTP GET request with [Basic
3483381c5e46 mod_auth_http_async: Add README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
17 authentication][rfc7617] to the configured `http_auth_url`.
3483381c5e46 mod_auth_http_async: Add README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
18
3483381c5e46 mod_auth_http_async: Add README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
19 Configuration
3483381c5e46 mod_auth_http_async: Add README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
20 =============
3483381c5e46 mod_auth_http_async: Add README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
21
6317
7b693a5539ad mod_auth_http_async: Update documentation
Kim Alvefur <zash@zash.se>
parents: 5975
diff changeset
22 After installing, enable the module by setting `authentication` to `"http_async"`.
7b693a5539ad mod_auth_http_async: Update documentation
Kim Alvefur <zash@zash.se>
parents: 5975
diff changeset
23
7b693a5539ad mod_auth_http_async: Update documentation
Kim Alvefur <zash@zash.se>
parents: 5975
diff changeset
24 The only setting is `http_auth_url` which should contain the URL endpoint where the authentication query is sent to. It can contain `$host` and
7b693a5539ad mod_auth_http_async: Update documentation
Kim Alvefur <zash@zash.se>
parents: 5975
diff changeset
25 `$user` which are substituted for the current VirtualHost and the authenticating username, respectively.
7b693a5539ad mod_auth_http_async: Update documentation
Kim Alvefur <zash@zash.se>
parents: 5975
diff changeset
26
1933
afba0821f058 mod_auth_http_async/README: Add compatibility info
Kim Alvefur <zash@zash.se>
parents: 1888
diff changeset
27 ``` lua
1888
3483381c5e46 mod_auth_http_async: Add README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
28 VirtualHost "example.com"
3483381c5e46 mod_auth_http_async: Add README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
29 authentication = "http_async"
3483381c5e46 mod_auth_http_async: Add README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
30 http_auth_url = "http://example.com/auth"
3483381c5e46 mod_auth_http_async: Add README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
31 ```
3483381c5e46 mod_auth_http_async: Add README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
32
1933
afba0821f058 mod_auth_http_async/README: Add compatibility info
Kim Alvefur <zash@zash.se>
parents: 1888
diff changeset
33 Compatibility
afba0821f058 mod_auth_http_async/README: Add compatibility info
Kim Alvefur <zash@zash.se>
parents: 1888
diff changeset
34 =============
afba0821f058 mod_auth_http_async/README: Add compatibility info
Kim Alvefur <zash@zash.se>
parents: 1888
diff changeset
35
6317
7b693a5539ad mod_auth_http_async: Update documentation
Kim Alvefur <zash@zash.se>
parents: 5975
diff changeset
36 Should work with Prosody 0.10.x and later.