prosody-modules
tip
mod_webpresence/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_webpresence/README.md @ 6211:750d64c47ec6 draft default tip

Merge
author Trần H. Trung <xmpp:trần.h.trung@trung.fun>
date Tue, 18 Mar 2025 00:31:36 +0700
parent 5588:mod_webpresence/README.markdown@f16720087ef2
parent 6003:mod_webpresence/README.markdown@fe081789f7b5
comparison
equal deleted inserted replaced
6210:24316a399978 6211:750d64c47ec6
1 ---
2 labels:
3 - 'Stage-Stable'
4 summary: Display your online status in web pages
5 rockspec:
6 build:
7 copy_directories:
8 - icons
9 ...
10
11 Introduction
12 ============
13
14 Quite often you may want to publish your Jabber status to your blog or
15 website. mod\_webpresence allows you to do exactly this via adhoc control.
16
17 Installation
18 ============
19
20 Copy mod\_webpresence.lua to your modules directory then add it to your
21 modules\_enabled list:
22
23 ```
24
25 modules_enabled = {
26 "webpresence";
27 };
28
29 ```
30
31 Configuration & Usage
32 =====================
33
34 There is a set of icons supplied with the module. But you can configure it to
35 load your own in the config file:
36
37 ```
38
39 webpresence_icons = "/path/to/your/icons";
40
41 ```
42
43 Beware that the icon files must have the same names as the default files.
44
45 This module will always returns offline until you enable it via adhoc.
46
47 You can embed the icon into a page using a simple `<img>` tag, as follows:
48
49 <img src="http://prosody.example.com:5280/status/john.smith@domain.net" />
50
51 Alternatively, it can be used to get status name as plain text, status message
52 as plain text or html-code for embedding on web-pages.
53
54 To get status name in plain text you can use something like this link:
55 `http://prosody.example.com:5280/status/john.smith@domain.net/text`
56
57 To get status message as plain text you can use something like following
58 link: `http://prosody.example.com:5280/status/john.smith@domain.net/message`
59
60 To get html code, containing status name, status image and status message
61 (if set): `http://prosody.example.com:5280/status/john.smith@domain.net/html`
62
63 Compatibility
64 =============
65
66 ----- -------
67 trunk Works
68 0.12.3 Works
69 0.10 Works
70 0.9 Works
71 0.8 Works
72 0.7 Works
73 0.6 Works
74 ----- -------
75
76 Todo
77 ====
78
79 - Display PEP information (maybe a new plugin?)
80 - Internal/external image generator (GD, ImageMagick)
81 - Display the correct boolean in the first form.