Mercurial > prosody-modules

annotate mod_bookmarks2/README.markdown @ 5668:ecfd7aece33b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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 2718652c18ca
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3677
90f88a643973 mod_bookmarks2: Add new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
1 ---
90f88a643973 mod_bookmarks2: Add new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
2 labels:
4852
810b0e17d3aa mod_bookmarks2: Update Compatibility table
Kim Alvefur <zash@zash.se>
parents: 4851
diff changeset
3 - 'Stage-Merged'
4834
7ed2467c9bb5 mod_bookmarks2: Add simple support for legacy PEP queries
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 4278
diff changeset
4 summary: Synchronise bookmarks between Private XML, legacy PEP, and PEP
3677
90f88a643973 mod_bookmarks2: Add new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
5 ...
90f88a643973 mod_bookmarks2: Add new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
6
4851
0ceb2f223b30 mod_bookmarks2: Add a notice of inclusion in prosody-trunk
Kim Alvefur <zash@zash.se>
parents: 4834
diff changeset
7 ::: {.alert .alert-info}
5051
2718652c18ca mod_bookmarks2: Update README to reflect 0.12 release
Matthew Wild <mwild1@gmail.com>
parents: 4852
diff changeset
8 **Deprecatation notice:** This module has been merged into Prosody as
2718652c18ca mod_bookmarks2: Update README to reflect 0.12 release
Matthew Wild <mwild1@gmail.com>
parents: 4852
diff changeset
9 [mod_bookmarks][doc:modules:mod_bookmarks]. Users of Prosody **0.12**
2718652c18ca mod_bookmarks2: Update README to reflect 0.12 release
Matthew Wild <mwild1@gmail.com>
parents: 4852
diff changeset
10 and later should switch to that.
4851
0ceb2f223b30 mod_bookmarks2: Add a notice of inclusion in prosody-trunk
Kim Alvefur <zash@zash.se>
parents: 4834
diff changeset
11 :::
0ceb2f223b30 mod_bookmarks2: Add a notice of inclusion in prosody-trunk
Kim Alvefur <zash@zash.se>
parents: 4834
diff changeset
12
3677
90f88a643973 mod_bookmarks2: Add new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
13 Introduction
90f88a643973 mod_bookmarks2: Add new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
14 ------------
90f88a643973 mod_bookmarks2: Add new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
15
4834
7ed2467c9bb5 mod_bookmarks2: Add simple support for legacy PEP queries
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 4278
diff changeset
16 This module fetches users’ bookmarks from Private XML (or legacy PEP) and
7ed2467c9bb5 mod_bookmarks2: Add simple support for legacy PEP queries
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 4278
diff changeset
17 pushes them to PEP on login, and then redirects any Private XML query (or
7ed2467c9bb5 mod_bookmarks2: Add simple support for legacy PEP queries
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 4278
diff changeset
18 legacy PEP) to PEP. This allows interoperability between older clients that
7ed2467c9bb5 mod_bookmarks2: Add simple support for legacy PEP queries
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 4278
diff changeset
19 use [XEP-0048](https://xmpp.org/extensions/xep-0048.html) and recent clients
7ed2467c9bb5 mod_bookmarks2: Add simple support for legacy PEP queries
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 4278
diff changeset
20 which use [XEP-0402](https://xmpp.org/extensions/xep-0402.html).
3677
90f88a643973 mod_bookmarks2: Add new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
21
90f88a643973 mod_bookmarks2: Add new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
22 Configuration
90f88a643973 mod_bookmarks2: Add new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
23 -------------
90f88a643973 mod_bookmarks2: Add new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
24
90f88a643973 mod_bookmarks2: Add new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
25 Simply [enable it like most other
90f88a643973 mod_bookmarks2: Add new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
26 modules](https://prosody.im/doc/installing_modules#prosody-modules), no
90f88a643973 mod_bookmarks2: Add new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
27 further configuration is needed.
90f88a643973 mod_bookmarks2: Add new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
28
90f88a643973 mod_bookmarks2: Add new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
29 Compatibility
90f88a643973 mod_bookmarks2: Add new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
30 -------------
90f88a643973 mod_bookmarks2: Add new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
31
4852
810b0e17d3aa mod_bookmarks2: Update Compatibility table
Kim Alvefur <zash@zash.se>
parents: 4851
diff changeset
32 ------- -----------------------------------------
5051
2718652c18ca mod_bookmarks2: Update README to reflect 0.12 release
Matthew Wild <mwild1@gmail.com>
parents: 4852
diff changeset
33 0.12 [Use the official mod_bookmarks module instead][doc:modules:mod_bookmarks]
3677
90f88a643973 mod_bookmarks2: Add new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
34 0.11 Works
90f88a643973 mod_bookmarks2: Add new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
35 0.10 Does not work
90f88a643973 mod_bookmarks2: Add new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
36 0.9 Does not work
4852
810b0e17d3aa mod_bookmarks2: Update Compatibility table
Kim Alvefur <zash@zash.se>
parents: 4851
diff changeset
37 ------- -----------------------------------------