prosody-modules
4d73a1a6ba68
mod_group_bookmarks/README.markdown

Find changesets by keywords by author, files, the commit message, revision number or hash, or revset expression.

Software / code / prosody-modules

Comparison

mod_group_bookmarks/README.markdown @ 1803:4d73a1a6ba68

Convert all wiki pages to Markdown
author Kim Alvefur <zash@zash.se>
date Fri, 28 Aug 2015 18:03:58 +0200
parent 1782:mod_group_bookmarks/README.wiki@29f3d6b7ad16
child 1820:8de50be756e5
comparison
equal deleted inserted replaced
1802:0ab737feada6 1803:4d73a1a6ba68
1 ---
2 labels:
3 - 'Stage-Beta'
4 summary: 'mod\_groups for chatrooms'
5 ...
6
7 Introduction
8 ============
9
10 [mod\_groups](http://prosody.im/doc/modules/mod_groups) allows you to
11 insert contacts into users' contact lists. Well mod\_group\_bookmarks
12 allows you to insert chatrooms into the user's bookmarks. These are
13 fetched by their client and automatically joined when the log in.
14
15 In short, if you want to automatically join users to rooms when they
16 sign in, this is the module you want.
17
18 Details
19 =======
20
21 Most clients support storing a private list of room "bookmarks" on the
22 server. When they log in, they fetch this list and join any that are
23 marked as "autojoin". Without affecting normal usage of the bookmarks
24 store this module dynamically inserts custom rooms into users' bookmarks
25 lists.
26
27 Usage
28 =====
29
30 Similar to [mod\_groups](http://prosody.im/doc/modules/mod_groups), you
31 need to make a text file in this format:
32
33 [room@conferenceserver]
34 user1@example.com=User 1
35 user2@example.com=User 2
36
37 [otherroom@conferenceserver]
38 user3@example.net=User 3
39
40 Add "group\_bookmarks" to your modules\_enabled list:
41
42 modules_enabled = {
43 -- ...other modules here... --
44 "group_bookmarks";
45 -- ...maybe some more here... --
46 }
47
48 Configuration
49 =============
50
51 ------------------------ ---------------------------------------------------
52 group\_bookmarks\_file The path to the text file you created (as above).
53 ------------------------ ---------------------------------------------------
54
55 Compatibility
56 =============
57
58 ----- -------------
59 0.8 Works
60 0.7 Should work
61 0.6 Should work
62 ----- -------------
63
64 Todo
65 ====
66
67 - Support for injecting into ALL users bookmarks, without needing a
68 list
69 - Allow turning off the autojoin flag
70 - Perhaps support a friendly name for the bookmark (currently uses the
71 room address)