Mercurial > prosody-modules
view mod_http_presence/README.md @ 6319:04c3273cb81f
mod_auth_cyrus: Add empty 'profile' table to SASL handler objects
This is for compatibility with Prosody's built-in util.sasl objects.
A SASL profile table usually includes methods supported by the backend, which
can be used by SASL mechanism handlers to perform operations (such as testing
the password). It also optionally contains a 'cb' field with channel binding
method handlers.
The Cyrus backend doesn't support channel binding, and doesn't have the same
concept of auth backend methods (it handles all that internally, and Prosody
has no insight or control over it).
Thus, we create an empty profile which informs Prosody that the SASL handler
does not support any of the auth or channel binding methods. Some features
will not work, but they didn't work anyway. This just makes it explicit.
This fixes a traceback in mod_sasl2_fast, which expected SASL handlers to
always contain a 'profile' field.
| author | Matthew Wild <mwild1@gmail.com> |
|---|---|
| date | Thu, 04 Sep 2025 10:14:46 +0100 |
| parents | 27e061d455b9 |
| children | 57cf3fc844f6 |
line wrap: on
line source
--- summary: JID presence and information through HTTP ... This module provides a web interface for viewing the status, avatar, and information of a user or MUC. # Configuration The module `http_presence` can be enabled under a VirtualHost and/or a MUC component, providing web details for JIDs under each respectively. You should not enable this module under other components. Name Description Type Default value ---------------------- --------------------------------------------------- -------- --------------- presence_http_path presence path under Prosody's http host string "/presence" presence_resource_path the path to the directory that stores assets string "resources" # URI To access a JIDs presence and information, use the following URI format: ``` https://<http_host>:5281/presence/<name>/<format> ``` Format User Muc Description ------------ ---- --- ------------------------------------------------------------------------- full Yes Yes (Default) Provides a full HTML overview that can be embedded in webpages. name No Yes Returns MUC title or name. If empty, returns JID. nickname Yes No Returns user nickname. PEP vCard4 must be set to public. status Yes Yes Returns status of JID. Returns "muc" on MUCs. message Yes No Returns status message of user. description No Yes Returns Full MUC description. status-icon Yes Yes Returns status icon from resources. Returns "muc.png" on MUCs. avatar Yes Yes Returns the users PEP avatar or MUC vCard avatar. users No Yes Returns the amount of users in a MUC. For example, you can query the description of `support@muc.example.com` with this URL: ``` https://muc.example.com:5281/presence/support/description ``` # Resources Under the resource path should be PNG icons and a style.css which are all customizable. Filename Description ------------- --------------------------------------------------- style.css Stylesheet used for full mode avatar.png Default avatar provided if the JID has no avatar away.png User "Away" status chat.png User "Chatty" or "Free To Chat" status dnd.png User "Do Not Disturb" status muc.png Status icon for MUC. offline.png User "Offline" status online.png User "Online" status xa.png User "Extended Away" or "Not Available" status Compatibility ============= version note --------- --------------------------------------------------------------------------- 13 Works 0.12 Might work