Mercurial > prosody-modules
view mod_http_authentication/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 | b19d64dd4c66 |
| children |
line wrap: on
line source
--- labels: - 'Stage-Beta' summary: Enforces HTTP Basic authentication across all HTTP endpoints served by Prosody ... # mod_http_authentication This module enforces HTTP Basic authentication across all HTTP endpoints served by Prosody. ## Configuration Name Default Description ---------------------------------- --------------------------------- -------------------------------------------------------------------------------------------------------------------------------------- http\_credentials "minddistrict:secretpassword" The credentials that HTTP clients must provide to access the HTTP interface. Should be a string with the syntax "username:password". unauthenticated\_http\_endpoints { "/http-bind", "/http-bind/" } A list of paths that should be excluded from authentication. ## Usage This is a global module, so should be added to the global `modules_enabled` option in your config file. It applies to all HTTP virtual hosts. ## Compatibility The module use a new API in Prosody 0.10 and will not work with older versions. ## Details By Kim Alvefur \<zash@zash.se\>