Mercurial > prosody-modules
view mod_auth_http_async/README.md @ 6317:7b693a5539ad
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 |
line wrap: on
line source
--- labels: - Stage-Alpha ... Introduction ============ This is an authentication module that does an asynchronous HTTP call to verify username and password. Details ======= When a user attempts to authenticate to Prosody, this module takes the username and password and does a HTTP GET request with [Basic authentication][rfc7617] to the configured `http_auth_url`. Configuration ============= After installing, enable the module by setting `authentication` to `"http_async"`. 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 `$user` which are substituted for the current VirtualHost and the authenticating username, respectively. ``` lua VirtualHost "example.com" authentication = "http_async" http_auth_url = "http://example.com/auth" ``` Compatibility ============= Should work with Prosody 0.10.x and later.
