Mercurial > prosody-modules
view mod_auth_custom_http/README.markdown @ 5668:ecfd7aece33b
mod_measure_modules: Report module statuses via OpenMetrics
Someone in the chat asked about a health check endpoint, which reminded
me of mod_http_status, which provides access to module statuses with
full details. After that, this idea came about, which seems natural.
As noted in the README, it could be used to monitor that critical
modules are in fact loaded correctly.
As more modules use the status API, the more useful this module and
mod_http_status becomes.
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Fri, 06 Oct 2023 18:34:39 +0200 |
parents | f90cf59bee8e |
children |
line wrap: on
line source
--- summary: HTTP Authentication using custom JSON protocol ... Introduction ============ To authenticate users, this module does a `POST` request to a configured URL with a JSON payload. It is not async so requests block the server until answered. Configuration ============= ``` lua VirtualHost "example.com" authentication = "custom_http" auth_custom_http = { post_url = "http://api.example.com/auth"; } ``` Protocol ======== The JSON payload consists of an object with `username` and `password` members: {"username":"john","password":"secr1t"} The module expects the response body to be exactly `true` if the username and password are correct.