Mercurial > prosody-modules
view mod_auth_custom_http/README.markdown @ 4615:451514e2d369
mod_http_pep_avatar: Fix name of module in example
README was copied from mod_http_avatar, probably forgot to update that.
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Tue, 06 Jul 2021 21:12:56 +0200 |
parents | f90cf59bee8e |
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.