Mercurial > prosody-modules
view mod_http_authentication/README.markdown @ 5907:d194d1012fd3
Updating dox for mod_rest. Ideas expressed / clarified:
1) Making clear that mod_rest isn't to be installed under VirtualHosts AND as a component.
2) Understanding some of the implications of this choice:
A) Changes to user authentication
B) How it affects subdomains
3) More consistent use of domain names for clarity.
4) Using different heading sizes to show scope of section.
Essentially, I added all the tidbits I had to clarify in getting this to work in my
own example.
| author | Ben Smith <bens@effortlessis.com> |
|---|---|
| date | Mon, 13 May 2024 13:25:13 -0700 |
| 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\>