annotate mod_profile/README.markdown @ 5668:ecfd7aece33b

mod_measure_modules: Report module statuses via OpenMetrics Someone in the chat asked about a health check endpoint, which reminded me of mod_http_status, which provides access to module statuses with full details. After that, this idea came about, which seems natural. As noted in the README, it could be used to monitor that critical modules are in fact loaded correctly. As more modules use the status API, the more useful this module and mod_http_status becomes.
author Kim Alvefur <zash@zash.se>
date Fri, 06 Oct 2023 18:34:39 +0200
parents 89226fb1af67
children
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:
4957
89226fb1af67 mod_profile: Obsolete. Remove. Redirect to mod_vcard_legacy
Kim Alvefur <zash@zash.se>
parents: 3665
diff changeset
3 - 'Stage-Obsolete'
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'
4957
89226fb1af67 mod_profile: Obsolete. Remove. Redirect to mod_vcard_legacy
Kim Alvefur <zash@zash.se>
parents: 3665
diff changeset
5 superseded_by: mod_vcard_legacy
2376
f0e611e40e3f mod_profile/README: Set a stage label
Kim Alvefur <zash@zash.se>
parents: 1803
diff changeset
6 ---
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
7
3664
2bbc56a19d74 mod_profile: Link to successors mod_vcard_legacy & mod_vcard4
Kim Alvefur <zash@zash.se>
parents: 3300
diff changeset
8 ::: {.alert .alert-warning}
2bbc56a19d74 mod_profile: Link to successors mod_vcard_legacy & mod_vcard4
Kim Alvefur <zash@zash.se>
parents: 3300
diff changeset
9 [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
10 [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
11 provide equivalent functionality.
2bbc56a19d74 mod_profile: Link to successors mod_vcard_legacy & mod_vcard4
Kim Alvefur <zash@zash.se>
parents: 3300
diff changeset
12 :::
2bbc56a19d74 mod_profile: Link to successors mod_vcard_legacy & mod_vcard4
Kim Alvefur <zash@zash.se>
parents: 3300
diff changeset
13
3180
00034d0cc05a mod_profile: Reformat README
Kim Alvefur <zash@zash.se>
parents: 2490
diff changeset
14 # Introduction
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
15
3664
2bbc56a19d74 mod_profile: Link to successors mod_vcard_legacy & mod_vcard4
Kim Alvefur <zash@zash.se>
parents: 3300
diff changeset
16 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
17 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
18 vCard 4 based protocol][xep0292] and integrates with [Personal
00034d0cc05a mod_profile: Reformat README
Kim Alvefur <zash@zash.se>
parents: 2490
diff changeset
19 Eventing Protocol][xep0163].
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
20
3186
1fe5b156d220 mod_profile: Add support for XEP-0398
Kim Alvefur <zash@zash.se>
parents: 3180
diff changeset
21 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
22
3180
00034d0cc05a mod_profile: Reformat README
Kim Alvefur <zash@zash.se>
parents: 2490
diff changeset
23 The vCard 4, [User Avatar][xep0084] and [User Nickname][xep0172]
00034d0cc05a mod_profile: Reformat README
Kim Alvefur <zash@zash.se>
parents: 2490
diff changeset
24 PEP nodes are updated when the vCard is changed..
00034d0cc05a mod_profile: Reformat README
Kim Alvefur <zash@zash.se>
parents: 2490
diff changeset
25
00034d0cc05a mod_profile: Reformat README
Kim Alvefur <zash@zash.se>
parents: 2490
diff changeset
26 # Configuration
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
27
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
28 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
29 -- "vcard"; -- This module must be removed
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
30
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
31 "profile";
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
32 }
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
33
3180
00034d0cc05a mod_profile: Reformat README
Kim Alvefur <zash@zash.se>
parents: 2490
diff changeset
34 # Compatibility
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
35
3180
00034d0cc05a mod_profile: Reformat README
Kim Alvefur <zash@zash.se>
parents: 2490
diff changeset
36 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
37
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
38 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
39 previously known as [mod\_pep\_plus][doc:modules:mod_pep_plus].