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