Mercurial > prosody-modules
changeset 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 | 8f2de6652930 |
| children | 07808fcda0e4 |
| files | mod_auth_http_async/README.md |
| diffstat | 1 files changed, 7 insertions(+), 2 deletions(-) [+] |
line wrap: on
line diff
--- a/mod_auth_http_async/README.md Mon Aug 18 08:42:34 2025 -0400 +++ b/mod_auth_http_async/README.md Tue Sep 02 21:32:01 2025 +0200 @@ -6,7 +6,7 @@ Introduction ============ -This is an experimental authentication module that does an asynchronous +This is an authentication module that does an asynchronous HTTP call to verify username and password. Details @@ -19,6 +19,11 @@ 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" @@ -28,4 +33,4 @@ Compatibility ============= -Requires Prosody trunk +Should work with Prosody 0.10.x and later.