view mod_auth_custom_http/README.md @ 6402:4ddb5c69bc89

mod_xmllang_check: Fix and link ejabberd source URLs in markdown doc
author Waqas Hussain <waqas20@gmail.com>
date Mon, 09 Feb 2026 18:49:58 -0500
parents fe081789f7b5
children
line wrap: on
line source

---
summary: HTTP Authentication using custom JSON protocol
...

Introduction
============

To authenticate users, this module does a `POST` request to a configured
URL with a JSON payload. It is not async so requests block the server
until answered.

Configuration
=============

``` lua
VirtualHost "example.com"
authentication = "custom_http"
auth_custom_http = {
  post_url = "http://api.example.com/auth";
}
```

Protocol
========

The JSON payload consists of an object with `username` and `password`
members:

    {"username":"john","password":"secr1t"}

The module expects the response body to be exactly `true` if the
username and password are correct.