Mercurial > prosody-modules
view mod_group_bookmarks/README.markdown @ 4974:807007913f67
mod_log_json: Prefer native Lua table.pack over Prosody util.table one
Prosody is removing support for Lua 5.1, which was the reason for
util.table.pack to exist in the first place, since Lua 5.2+ provides
table.pack. In prosody rev 5eaf77114fdb everything was switched over to
use table.pack, opening the door for removing util.table.pack at some
point. This change here is to prepare for that future eventuality.
| author | Kim Alvefur <zash@zash.se> |
|---|---|
| date | Mon, 11 Jul 2022 20:08:41 +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)