Mercurial > prosody-modules

comparison mod_auth_http_async/README.md @ 6317:7b693a5539ad

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_auth_http_async: Update documentation The required async APIs were included in 0.10.0, but at the time of this writing we only consider 0.12.x and later supported. The fallback sync API would have made it work with even earlier versions, but I don't remember specifically and it doesn't matter.
author Kim Alvefur <zash@zash.se>
date Tue, 02 Sep 2025 21:32:01 +0200
parents fe081789f7b5
children
comparison
equal deleted inserted replaced
6316:8f2de6652930 6317:7b693a5539ad
4 ... 4 ...
5 5
6 Introduction 6 Introduction
7 ============ 7 ============
8 8
9 This is an experimental authentication module that does an asynchronous 9 This is an authentication module that does an asynchronous
10 HTTP call to verify username and password. 10 HTTP call to verify username and password.
11 11
12 Details 12 Details
13 ======= 13 =======
14 14
17 authentication][rfc7617] to the configured `http_auth_url`. 17 authentication][rfc7617] to the configured `http_auth_url`.
18 18
19 Configuration 19 Configuration
20 ============= 20 =============
21 21
22 After installing, enable the module by setting `authentication` to `"http_async"`.
23
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
25 `$user` which are substituted for the current VirtualHost and the authenticating username, respectively.
26
22 ``` lua 27 ``` lua
23 VirtualHost "example.com" 28 VirtualHost "example.com"
24 authentication = "http_async" 29 authentication = "http_async"
25 http_auth_url = "http://example.com/auth" 30 http_auth_url = "http://example.com/auth"
26 ``` 31 ```
27 32
28 Compatibility 33 Compatibility
29 ============= 34 =============
30 35
31 Requires Prosody trunk 36 Should work with Prosody 0.10.x and later.