Diff

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_auth_custom_http/README.md	Tue Oct 22 10:26:01 2024 +0200
@@ -0,0 +1,32 @@
+---
+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.