Mercurial > prosody-modules
view mod_group_bookmarks/README.markdown @ 3965:2b10e51d85a6
mod_muc_limits: Add config option to limit to join stanzas only
This is a bit more limited in pre-0.11 MUC modules, because it just
detects stanzas sent to full JIDs (which would include all presence
and nick changes).
This option is useful for setups where users are typically unaffiliated,
but trusted (e.g. if access to the room is gated through some other
means such as password/token auth).
| author | Matthew Wild <mwild1@gmail.com> |
|---|---|
| date | Fri, 03 Apr 2020 12:26:56 +0100 |
| 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)