view mod_auth_custom_http/README.md @ 6256:8d337dae5a62

mod_csi_grace_period: Fix readme again diff --git a/mod_csi_grace_period/README.md b/mod_csi_grace_period/README.md --- a/mod_csi_grace_period/README.md +++ b/mod_csi_grace_period/README.md @@ -20,5 +20,6 @@ included with Prosody. trunk* Works 13 Works 0.12 Works + ------- ------- *as of 2025-06-13
author Menel <menel@snikket.de>
date Fri, 13 Jun 2025 10:10:26 +0200
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.