aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/src/mod_auth_custom_http_onefang/README.markdown
diff options
context:
space:
mode:
Diffstat (limited to 'src/mod_auth_custom_http_onefang/README.markdown')
-rw-r--r--src/mod_auth_custom_http_onefang/README.markdown32
1 files changed, 32 insertions, 0 deletions
diff --git a/src/mod_auth_custom_http_onefang/README.markdown b/src/mod_auth_custom_http_onefang/README.markdown
new file mode 100644
index 0000000..ab79bf5
--- /dev/null
+++ b/src/mod_auth_custom_http_onefang/README.markdown
@@ -0,0 +1,32 @@
1---
2summary: HTTP Authentication using custom JSON protocol
3...
4
5Introduction
6============
7
8To authenticate users, this module does a `POST` request to a configured
9URL with a JSON payload. It is not async so requests block the server
10until answered.
11
12Configuration
13=============
14
15``` lua
16VirtualHost "example.com"
17authentication = "custom_http"
18auth_custom_http = {
19 post_url = "http://api.example.com/auth";
20}
21```
22
23Protocol
24========
25
26The JSON payload consists of an object with `username` and `password`
27members:
28
29 {"username":"john","password":"secr1t"}
30
31The module expects the response body to be exactly `true` if the
32username and password are correct.