prosody-modules
tip
mod_http_presence/README.md

Find changesets by keywords by author, files, the commit message, revision number or hash, or revset expression.

Software / code / prosody-modules

Comparison

mod_http_presence/README.md @ 6344:eb834f754f57 draft default tip

Merge update
author Trần H. Trung <xmpp:trần.h.trung@trung.fun>
date Fri, 18 Jul 2025 20:45:38 +0700
parent 6330:27e061d455b9
comparison
equal deleted inserted replaced
6309:342f88e8d522 6344:eb834f754f57
1 ---
2 summary: JID presence and information through HTTP
3 ...
4
5 This module provides a web interface for viewing the status, avatar, and information of a user or MUC.
6
7 # Configuration
8
9 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.
10
11 Name Description Type Default value
12 ---------------------- --------------------------------------------------- -------- ---------------
13 presence_http_path presence path under Prosody's http host string "/presence"
14 presence_resource_path the path to the directory that stores assets string "resources"
15
16 # URI
17
18 To access a JIDs presence and information, use the following URI format:
19 ```
20 https://<http_host>:5281/presence/<name>/<format>
21 ```
22
23 Format User Muc Description
24 ------------ ---- --- -------------------------------------------------------------------------
25 full Yes Yes (Default) Provides a full HTML overview that can be embedded in webpages.
26 name No Yes Returns MUC title or name. If empty, returns JID.
27 nickname Yes No Returns user nickname. PEP vCard4 must be set to public.
28 status Yes Yes Returns status of JID. Returns "muc" on MUCs.
29 message Yes No Returns status message of user.
30 description No Yes Returns Full MUC description.
31 status-icon Yes Yes Returns status icon from resources. Returns "muc.png" on MUCs.
32 avatar Yes Yes Returns the users PEP avatar or MUC vCard avatar.
33 users No Yes Returns the amount of users in a MUC.
34
35 For example, you can query the description of `support@muc.example.com` with this URL:
36 ```
37 https://muc.example.com:5281/presence/support/description
38 ```
39
40 # Resources
41
42 Under the resource path should be PNG icons and a style.css which are all customizable.
43
44 Filename Description
45 ------------- ---------------------------------------------------
46 style.css Stylesheet used for full mode
47 avatar.png Default avatar provided if the JID has no avatar
48 away.png User "Away" status
49 chat.png User "Chatty" or "Free To Chat" status
50 dnd.png User "Do Not Disturb" status
51 muc.png Status icon for MUC.
52 offline.png User "Offline" status
53 online.png User "Online" status
54 xa.png User "Extended Away" or "Not Available" status
55
56 Compatibility
57 =============
58
59 version note
60 --------- ---------------------------------------------------------------------------
61 13 Works
62 0.12 Might work