Mercurial > prosody-modules
view mod_http_muc_kick/README.md @ 5627:3a5cf8d80089
mod_http_oauth2: Tweak method of centering the UI
The percentage here was relative to the viewport width, which on some
very wide screens may put the UI slightly outside of the view, requiring
scrolling to see.
By using a unit relative to the height of the viewport, this is avoided
and should work better. But no guarantees, it's still possible to resize
the browser or adjust font sizes so that the UI goes out of view.
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Mon, 31 Jul 2023 07:28:09 +0200 |
parents | 9fc52ccfb445 |
children |
line wrap: on
line source
# Introduction This module allows kicking users out of MUCs via HTTP. It can be used in combination with [mod_muc_http_auth](https://modules.prosody.im/mod_muc_http_auth.html) as a complement to externalize MUC access. This module expects a JSON payload with the following keys: * `nickname` Mandatory. The nickname of the user to be kicked. * `muc` Mandatory. The JID of the muc to kick the user from. * `reason` Optional. A comment explaining the reason of the kick (More details https://xmpp.org/extensions/xep-0045.html#example-91). Example: ``` { nickname: "Bob", muc: "snuggery@chat.example.org", } ``` If the user was kicked successfuly, the module will return a 200 status code. Otherwise, the according status code will be returned in the response, as well as a JSON payload providing an error message. ``` { error: "Missing nickname and/or MUC" } ``` The path this module listens on is `/muc_kick`. Example of a request to kick `Bob` from the `snuggery@chat.example.org` MUC using cURL: ``` curl --header "Content-Type: application/json" \ --request POST \ -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=" \ --data '{"nickname":"Bob","muc":"snuggery@chat.example.org"}' \ http://chat.example.org:5280/muc_kick ``` # Configuring ## Enabling ``` {.lua} Component "chat.example.org" "muc" modules_enabled = { "http_muc_kick"; } http_muc_kick_authorization_header = "Basic YWxhZGRpbjpvcGVuc2VzYW1l" -- Check the Settings section below ``` ## Settings |Name |Description |Default | |-----|------------|--------| |http_muc_kick_authorization_header| Value of the Authorization header expected by every request when trying to kick a user. Example: `Basic dXNlcm5hbWU6cGFzc3dvcmQ=`| nil | Even though there is no check on whether the Authorization header provided is a valid one, please be aware that if `http_muc_kick_authorization_header` is nil, the module will not load as a reminder that some authorization should be enforced for this module.