annotate mod_pep_vcard_avatar/README.markdown @ 5536:96dec7681af8

mod_firewall: Update user marks to store instantly via map store The original approach was to keep marks in memory only, and persist them at shutdown. That saves I/O, at the cost of potentially losing marks on an unclean shutdown. This change persists marks instantly, which may have some performance overhead but should be more "correct". It also splits the marking/unmarking into an event which may be watched or even fired by other modules.
author Matthew Wild <mwild1@gmail.com>
date Thu, 08 Jun 2023 16:20:42 +0100
parents 41dd405efb5a
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:
diff changeset
1 ---
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
2 labels:
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
3 - 'Stage-Alpha'
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
4 summary: Sync avatars between vCards and PEP
3179
84f50531a192 mod_pep_vcard_avatar: Normalize syntax in README
Kim Alvefur <zash@zash.se>
parents: 3178
diff changeset
5 ---
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
6
3179
84f50531a192 mod_pep_vcard_avatar: Normalize syntax in README
Kim Alvefur <zash@zash.se>
parents: 3178
diff changeset
7 ## Introduction
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
8
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
9 This module pushes the users nickname and avatar from vCards into PEP,
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
10 or into vCards from PEP. This allows interop between older clients that
3179
84f50531a192 mod_pep_vcard_avatar: Normalize syntax in README
Kim Alvefur <zash@zash.se>
parents: 3178
diff changeset
11 use [XEP-0153: vCard-Based Avatars] to see the avatars of clients that
84f50531a192 mod_pep_vcard_avatar: Normalize syntax in README
Kim Alvefur <zash@zash.se>
parents: 3178
diff changeset
12 use [XEP-0084: User Avatar] and vice versa.
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
13
3178
bd28da2f813c mod_pep_vcard_avatar: Mention XEP-398
Kim Alvefur <zash@zash.se>
parents: 1803
diff changeset
14 Also see [XEP-0398: User Avatar to vCard-Based Avatars Conversion].
bd28da2f813c mod_pep_vcard_avatar: Mention XEP-398
Kim Alvefur <zash@zash.se>
parents: 1803
diff changeset
15
3179
84f50531a192 mod_pep_vcard_avatar: Normalize syntax in README
Kim Alvefur <zash@zash.se>
parents: 3178
diff changeset
16 ## Configuration
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
17
3179
84f50531a192 mod_pep_vcard_avatar: Normalize syntax in README
Kim Alvefur <zash@zash.se>
parents: 3178
diff changeset
18 Simply [enable it like most other modules][doc:installing_modules#prosody-modules],
84f50531a192 mod_pep_vcard_avatar: Normalize syntax in README
Kim Alvefur <zash@zash.se>
parents: 3178
diff changeset
19 no further configuration needed.
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
20
3179
84f50531a192 mod_pep_vcard_avatar: Normalize syntax in README
Kim Alvefur <zash@zash.se>
parents: 3178
diff changeset
21 ## Compatibility
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
22
3421
41dd405efb5a mod_pep_vcard_avatar: Update docs to point at mod_vcard_legacy
Kim Alvefur <zash@zash.se>
parents: 3215
diff changeset
23 ------- --------------------------------
41dd405efb5a mod_pep_vcard_avatar: Update docs to point at mod_vcard_legacy
Kim Alvefur <zash@zash.se>
parents: 3215
diff changeset
24 trunk Use mod\_vcard\_legacy instead
41dd405efb5a mod_pep_vcard_avatar: Update docs to point at mod_vcard_legacy
Kim Alvefur <zash@zash.se>
parents: 3215
diff changeset
25 0.11 Use mod\_vcard\_legacy instead
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
26 0.10 Works
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
27 0.9 Does not work
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
28 0.8 Does not work
3421
41dd405efb5a mod_pep_vcard_avatar: Update docs to point at mod_vcard_legacy
Kim Alvefur <zash@zash.se>
parents: 3215
diff changeset
29 ------- --------------------------------