annotate mod_profile/README.markdown @ 4542:fb4a50bf60f1

mod_prometheus: Invoke stats collection if in 'manual' mode Since 10d13e0554f9 a special value for statistics_interval "manual" exists, where a module is expected to invoke processing in connection to collection of stats. This makes internal collection and exporting to Prometheus happens at the same time with no chance of timers getting out of sync.
author Kim Alvefur <zash@zash.se>
date Tue, 13 Apr 2021 23:53:53 +0200
parents b105c4425359
children 89226fb1af67
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
1 ---
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
2 labels:
3665
b105c4425359 mod_profile: Mark as Unmaintained
Kim Alvefur <zash@zash.se>
parents: 3664
diff changeset
3 - 'Stage-Unmaintained'
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
4 summary: 'Replacement for mod\_vcard with vcard4 support and PEP integration'
2376
f0e611e40e3f mod_profile/README: Set a stage label
Kim Alvefur <zash@zash.se>
parents: 1803
diff changeset
5 ---
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
6
3664
2bbc56a19d74 mod_profile: Link to successors mod_vcard_legacy & mod_vcard4
Kim Alvefur <zash@zash.se>
parents: 3300
diff changeset
7 ::: {.alert .alert-warning}
2bbc56a19d74 mod_profile: Link to successors mod_vcard_legacy & mod_vcard4
Kim Alvefur <zash@zash.se>
parents: 3300
diff changeset
8 [mod\_vcard\_legacy][doc:modules:mod_vcard_legacy] and
2bbc56a19d74 mod_profile: Link to successors mod_vcard_legacy & mod_vcard4
Kim Alvefur <zash@zash.se>
parents: 3300
diff changeset
9 [mod\_vcard4][doc:modules:mod_vcard4] included with Prosody 0.11.x
2bbc56a19d74 mod_profile: Link to successors mod_vcard_legacy & mod_vcard4
Kim Alvefur <zash@zash.se>
parents: 3300
diff changeset
10 provide equivalent functionality.
2bbc56a19d74 mod_profile: Link to successors mod_vcard_legacy & mod_vcard4
Kim Alvefur <zash@zash.se>
parents: 3300
diff changeset
11 :::
2bbc56a19d74 mod_profile: Link to successors mod_vcard_legacy & mod_vcard4
Kim Alvefur <zash@zash.se>
parents: 3300
diff changeset
12
3180
00034d0cc05a mod_profile: Reformat README
Kim Alvefur <zash@zash.se>
parents: 2490
diff changeset
13 # Introduction
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
14
3664
2bbc56a19d74 mod_profile: Link to successors mod_vcard_legacy & mod_vcard4
Kim Alvefur <zash@zash.se>
parents: 3300
diff changeset
15 This module was an experimental replacement for [mod\_vcard]. In addition to
3180
00034d0cc05a mod_profile: Reformat README
Kim Alvefur <zash@zash.se>
parents: 2490
diff changeset
16 the ageing protocol defined by [XEP-0054], it also supports the [new
00034d0cc05a mod_profile: Reformat README
Kim Alvefur <zash@zash.se>
parents: 2490
diff changeset
17 vCard 4 based protocol][xep0292] and integrates with [Personal
00034d0cc05a mod_profile: Reformat README
Kim Alvefur <zash@zash.se>
parents: 2490
diff changeset
18 Eventing Protocol][xep0163].
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
19
3186
1fe5b156d220 mod_profile: Add support for XEP-0398
Kim Alvefur <zash@zash.se>
parents: 3180
diff changeset
20 Also supports [XEP-0398: User Avatar to vCard-Based Avatars Conversion].
1fe5b156d220 mod_profile: Add support for XEP-0398
Kim Alvefur <zash@zash.se>
parents: 3180
diff changeset
21
3180
00034d0cc05a mod_profile: Reformat README
Kim Alvefur <zash@zash.se>
parents: 2490
diff changeset
22 The vCard 4, [User Avatar][xep0084] and [User Nickname][xep0172]
00034d0cc05a mod_profile: Reformat README
Kim Alvefur <zash@zash.se>
parents: 2490
diff changeset
23 PEP nodes are updated when the vCard is changed..
00034d0cc05a mod_profile: Reformat README
Kim Alvefur <zash@zash.se>
parents: 2490
diff changeset
24
00034d0cc05a mod_profile: Reformat README
Kim Alvefur <zash@zash.se>
parents: 2490
diff changeset
25 # Configuration
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
26
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
27 modules_enabled = {
3300
65dd8ebbd82c mod_profile: Update README file next to recent mod_pep changes
Minami-o Le Sabreur <minami-o@biboumail.fr>
parents: 3186
diff changeset
28 -- "vcard"; -- This module must be removed
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
29
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
30 "profile";
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
31 }
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
32
3180
00034d0cc05a mod_profile: Reformat README
Kim Alvefur <zash@zash.se>
parents: 2490
diff changeset
33 # Compatibility
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
34
3180
00034d0cc05a mod_profile: Reformat README
Kim Alvefur <zash@zash.se>
parents: 2490
diff changeset
35 Requires Prosody **trunk** as of 2014-05-29. Won't work in 0.10.x.
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
36
3300
65dd8ebbd82c mod_profile: Update README file next to recent mod_pep changes
Minami-o Le Sabreur <minami-o@biboumail.fr>
parents: 3186
diff changeset
37 It depends on the trunk version of [mod\_pep][doc:modules:mod_pep] for PEP support,
65dd8ebbd82c mod_profile: Update README file next to recent mod_pep changes
Minami-o Le Sabreur <minami-o@biboumail.fr>
parents: 3186
diff changeset
38 previously known as [mod\_pep\_plus][doc:modules:mod_pep_plus].