mod_http_authentication/README.markdown

   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   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 ## Compatibility
  23
  24 The module use a new API in Prosody 0.10 and will not work with older
  25 versions.
  26
  27 ## Details
  28
  29 By Kim Alvefur \<zash@zash.se\>