view mod_http_authentication/README.markdown @ 3013:8bfba31a1f8b

mod_pubsub_post: Remove unused import [luacheck]
author Kim Alvefur <zash@zash.se>
date Sat, 19 May 2018 23:54:05 +0200
parents 1380ae0e003f
children b19d64dd4c66
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
-------------------------------  -------------------------------  -----------------------------
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".
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\>