prosody-modules
c6e86b74f62e
mod_http_authentication/README.markdown

Find changesets by keywords by author, files, the commit message, revision number or hash, or revset expression.

Software / code / prosody-modules

Comparison

mod_http_authentication/README.markdown @ 2337:c6e86b74f62e

Add mod_http_authentication.lua
author JC Brand <jcbrand@minddistrict.com>
date Mon, 17 Oct 2016 13:03:38 +0000
child 3012:1380ae0e003f
comparison
equal deleted inserted replaced
2336:79432b859d21 2337:c6e86b74f62e
1 ---
2 labels:
3 - 'Stage-Beta'
4 summary: Enforces HTTP Basic authentication across all HTTP endpoints served by Prosody
5 ...
6
7 # mod_http_authentication
8
9 This module enforces HTTP Basic authentication across all HTTP endpoints served by Prosody.
10
11 ## Configuration
12
13 Name Default Description
14 ------------------------------- ------------------------------- -----------------------------
15 minddistrict_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".
16 unauthenticated_http_endpoints { "/http-bind", "/http-bind/" } A list of paths that should be excluded from authentication.
17
18 ## Usage
19
20 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.
21
22 ## Known issues
23
24 The module use a new API in Prosody 0.10. This API currently has an open issue ([issue #554](https://prosody.im/issues/issue/554))
25 that means this module cannot be unloaded dynamically at runtime. In practice this shouldn't be an issue, and we will resolve the problem inside Prosody in due course.
26
27 ## Details
28
29 By Kim Alvefur \<zash@zash.se\>