mod_bookmarks2/README.markdown
author Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
Thu, 03 Dec 2020 19:25:33 +0100
changeset 4282 4ac5d3a5f580
parent 3681 90f88a643973
child 4838 7ed2467c9bb5
permissions -rw-r--r--
mod_bookmarks2: Add a warning about client compatibility
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
3681
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:
90f88a643973 mod_bookmarks2: Add new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
     3
- 'Stage-Alpha'
90f88a643973 mod_bookmarks2: Add new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
     4
summary: Synchronise bookmarks between Private XML and PEP
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
4282
4ac5d3a5f580 mod_bookmarks2: Add a warning about client compatibility
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 3681
diff changeset
     7
::: {.alert .alert-warning}
4ac5d3a5f580 mod_bookmarks2: Add a warning about client compatibility
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 3681
diff changeset
     8
**WARNING:** This module is incompatible with clients which only use
4ac5d3a5f580 mod_bookmarks2: Add a warning about client compatibility
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 3681
diff changeset
     9
[deprecated PEP bookmarks
4ac5d3a5f580 mod_bookmarks2: Add a warning about client compatibility
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 3681
diff changeset
    10
(XEP-0048)](https://xmpp.org/extensions/xep-0048.html), such as
4ac5d3a5f580 mod_bookmarks2: Add a warning about client compatibility
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 3681
diff changeset
    11
[Converse.js](https://conversejs.org).
4ac5d3a5f580 mod_bookmarks2: Add a warning about client compatibility
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 3681
diff changeset
    12
4ac5d3a5f580 mod_bookmarks2: Add a warning about client compatibility
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 3681
diff changeset
    13
If you need to be compatible with these clients, use
4ac5d3a5f580 mod_bookmarks2: Add a warning about client compatibility
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 3681
diff changeset
    14
[mod\_bookmarks](mod_bookmarks.html) instead.
4ac5d3a5f580 mod_bookmarks2: Add a warning about client compatibility
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 3681
diff changeset
    15
:::
4ac5d3a5f580 mod_bookmarks2: Add a warning about client compatibility
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 3681
diff changeset
    16
4ac5d3a5f580 mod_bookmarks2: Add a warning about client compatibility
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 3681
diff changeset
    17
3681
90f88a643973 mod_bookmarks2: Add new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
    18
Introduction
90f88a643973 mod_bookmarks2: Add new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
    19
------------
90f88a643973 mod_bookmarks2: Add new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
    20
90f88a643973 mod_bookmarks2: Add new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
    21
This module fetches users’ bookmarks from Private XML and pushes them
90f88a643973 mod_bookmarks2: Add new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
    22
to PEP on login, and then redirects any Private XML query to PEP.  This
90f88a643973 mod_bookmarks2: Add new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
    23
allows interop between older clients that use [XEP-0048: Bookmarks
90f88a643973 mod_bookmarks2: Add new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
    24
version 1.0](https://xmpp.org/extensions/attic/xep-0048-1.0.html) and
90f88a643973 mod_bookmarks2: Add new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
    25
recent clients which use
90f88a643973 mod_bookmarks2: Add new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
    26
[XEP-0402](https://xmpp.org/extensions/xep-0402.html).
90f88a643973 mod_bookmarks2: Add new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
    27
90f88a643973 mod_bookmarks2: Add new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
    28
Configuration
90f88a643973 mod_bookmarks2: Add new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
    29
-------------
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
Simply [enable it like most other
90f88a643973 mod_bookmarks2: Add new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
    32
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
    33
further configuration is needed.
90f88a643973 mod_bookmarks2: Add new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
    34
90f88a643973 mod_bookmarks2: Add new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
    35
Compatibility
90f88a643973 mod_bookmarks2: Add new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
    36
-------------
90f88a643973 mod_bookmarks2: Add new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
    37
90f88a643973 mod_bookmarks2: Add new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
    38
  ------- ---------------
90f88a643973 mod_bookmarks2: Add new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
    39
  trunk   Works
90f88a643973 mod_bookmarks2: Add new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
    40
  0.11    Works
90f88a643973 mod_bookmarks2: Add new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
    41
  0.10    Does not work
90f88a643973 mod_bookmarks2: Add new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
    42
  0.9     Does not work
90f88a643973 mod_bookmarks2: Add new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
    43
  ------- ---------------