view mod_group_bookmarks/README.markdown @ 4651:8231774f5bfd

mod_cloud_notify_encrypted: Ensure body substring remains valid UTF-8 The `body:sub()` call risks splitting the string in the middle of a multi-byte UTF-8 sequence. This should have been caught by util.stanza validation, but that would have caused some havoc, at the very least causing the notification to not be sent. There have been no reports of this happening. Likely because this module isn't widely deployed among users with languages that use many longer UTF-8 sequences. The util.encodings.utf8.valid() function is O(n) where only the last sequence really needs to be checked, but it's in C and expected to be fast.
author Kim Alvefur <zash@zash.se>
date Sun, 22 Aug 2021 13:22:59 +0200
parents 8de50be756e5
children
line wrap: on
line source

---
labels:
- 'Stage-Beta'
summary: 'mod\_groups for chatrooms'
...

Introduction
============

[mod\_groups](http://prosody.im/doc/modules/mod_groups) allows you to
insert contacts into users' contact lists. Well mod\_group\_bookmarks
allows you to insert chatrooms into the user's bookmarks. These are
fetched by their client and automatically joined when the log in.

In short, if you want to automatically join users to rooms when they
sign in, this is the module you want.

Details
=======

Most clients support storing a private list of room "bookmarks" on the
server. When they log in, they fetch this list and join any that are
marked as "autojoin". Without affecting normal usage of the bookmarks
store this module dynamically inserts custom rooms into users' bookmarks
lists.

Usage
=====

Similar to [mod\_groups](http://prosody.im/doc/modules/mod_groups), you
need to make a text file in this format:

    [room@conferenceserver]
    user1@example.com=User 1
    user2@example.com=User 2

    [otherroom@conferenceserver]
    user3@example.net=User 3

Add "group\_bookmarks" to your modules\_enabled list:

    modules_enabled = {
               -- ...other modules here... --
               "group_bookmarks";
               -- ...maybe some more here... --
    }

Configuration
=============

  ------------------------ ---------------------------------------------------
  group\_bookmarks\_file   The path to the text file you created (as above).
  ------------------------ ---------------------------------------------------

Compatibility
=============

  ----- -------------
  0.8   Works
  0.7   Should work
  0.6   Should work
  ----- -------------

Todo
====

-   Support for injecting into ALL users bookmarks, without needing a
    list
-   Allow turning off the autojoin flag
-   Perhaps support a friendly name for the bookmark (currently uses the
    room address)