view mod_group_bookmarks/README.markdown @ 1868:d6e673f98572

mod_filter_chatstates: Revert filter-to-nothing hack
author Kim Alvefur <>
date Mon, 21 Sep 2015 23:47:37 +0200
parents 8de50be756e5
line wrap: on
line source

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


[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.


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


Similar to [mod\_groups](, you
need to make a text file in this format:

    [room@conferenceserver] 1 2

    [otherroom@conferenceserver] 3

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

    modules_enabled = {
               -- ...other modules here... --
               -- ...maybe some more here... --


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


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


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