Mercurial > prosody-modules
diff mod_auth_custom_http/README.markdown @ 1934:6c569c481ffa
mod_auth_custom_http: Add README
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Sat, 24 Oct 2015 14:01:40 +0200 |
parents | |
children | f90cf59bee8e |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mod_auth_custom_http/README.markdown Sat Oct 24 14:01:40 2015 +0200 @@ -0,0 +1,30 @@ +--- +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 = "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.