Mercurial > prosody-wiki
annotate mod_group_bookmarks.wiki @ 305:f0db29e111fc
Link to mod_groups in Prosody docs
| author | MWild1@gmail.com |
|---|---|
| date | Wed, 05 Sep 2012 17:34:47 +0000 |
| parents | 85482789e90e |
| children |
| rev | line source |
|---|---|
| 162 | 1 #summary mod_groups for chatrooms |
| 2 #labels Stage-Beta | |
| 3 | |
| 4 = Introduction = | |
| 5 | |
| 305 | 6 [http://prosody.im/doc/modules/mod_groups 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. |
| 162 | 7 |
| 8 In short, if you want to automatically join users to rooms when they sign in, this is the module you want. | |
| 9 | |
| 10 = Details = | |
| 11 | |
| 12 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. | |
| 13 | |
| 14 = Usage = | |
| 15 | |
| 305 | 16 Similar to [http://prosody.im/doc/modules/mod_groups mod_groups], you need to make a text file in this format: |
| 162 | 17 |
| 18 {{{ | |
| 19 [room@conferenceserver] | |
| 20 user1@example.com=User 1 | |
| 21 user2@example.com=User 2 | |
| 22 | |
| 23 [otherroom@conferenceserver] | |
|
163
85482789e90e
mod_group_bookmarks: Fixed typo in example.
Waqas Hussain <waqas20@gmail.com>
parents:
162
diff
changeset
|
24 user3@example.net=User 3 |
| 162 | 25 }}} |
| 26 | |
| 27 Add "group_bookmarks" to your modules_enabled list: | |
| 28 {{{ | |
| 29 modules_enabled = { | |
| 30 -- ...other modules here... -- | |
| 31 "group_bookmarks"; | |
| 32 -- ...maybe some more here... -- | |
| 33 } | |
| 34 }}} | |
| 35 | |
| 36 = Configuration = | |
| 37 ||group_bookmarks_file||The path to the text file you created (as above).|| | |
| 38 | |
| 39 = Compatibility = | |
| 40 ||0.8||Works|| | |
| 41 ||0.7||Should work|| | |
| 42 ||0.6||Should work|| | |
| 43 | |
| 44 = Todo = | |
| 45 | |
| 46 * Support for injecting into ALL users bookmarks, without needing a list | |
| 47 * Allow turning off the autojoin flag | |
| 48 * Perhaps support a friendly name for the bookmark (currently uses the room address) |