view mod_http_authentication/README.markdown @ 4315:87e250409998

mod_pastebin: Normalize markdown [fix] md:command=pandoc -f markdown-smart+emoji -s -t markdown-smart+emoji+pipe_tables+simple_tables-multiline_tables-grid_tables-raw_html md:pattern=set:**.md + **.markdown
author Kim Alvefur <zash@zash.se>
date Sat, 02 Jan 2021 15:28:45 +0100
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\>