prosody-modules
d194d1012fd3
mod_muc_hats_adhoc/README.markdown
Software / code / prosody-modules
File
mod_muc_hats_adhoc/README.markdown @ 5931:d194d1012fd3
Updating dox for mod_rest. Ideas expressed / clarified:
1) Making clear that mod_rest isn't to be installed under VirtualHosts AND as a component.
2) Understanding some of the implications of this choice:
A) Changes to user authentication
B) How it affects subdomains
3) More consistent use of domain names for clarity.
4) Using different heading sizes to show scope of section.
Essentially, I added all the tidbits I had to clarify in getting this to work in my
own example.
| author | Ben Smith <bens@effortlessis.com> |
|---|---|
| date | Mon, 13 May 2024 13:25:13 -0700 |
| parent | 3950:e9e41e75c5a0 |
line wrap: on
line source
--- summary: Ad-hoc commands for managing MUC hats --- # Introduction This module provides an internal API (i.e. to other modules) to manage 'hats' for users in MUC rooms. Hats (first defined in [XEP-0317], currently deferred) are additional identifiers that can be attached to users in a group chat. For example in an educational context, you may have a 'Teacher' hat that allows students to identify their teachers. Hats consist of a machine-readable unique identifier (a URI), and optionally a human-readable label. This module provides ad-hoc commands for MUC service admins to add/remove hats to/from users in MUC rooms. It depends (automatically) on mod_muc_hats_api. ## Configuration ``` Component "conference.example.com" "muc" modules_enabled = { "muc_hats_adhoc" } ``` ## Usage To successfully use the module you will need to use an XMPP client that is capable of sending commands to a specific host (e.g. via the service discovery browser in Gajim, Psi/Psi+ and other clients), and you'll find the commands on the MUC host. Also note that the display of hats in clients is currently non-existent, but will hopefully improve after [XEP-0317] is resurrected or replaced.
