Mercurial > prosody-modules

comparison mod_default_bookmarks/README.markdown @ 1803:4d73a1a6ba68

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Convert all wiki pages to Markdown
author Kim Alvefur <zash@zash.se>
date Fri, 28 Aug 2015 18:03:58 +0200
parents mod_default_bookmarks/README.wiki@29f3d6b7ad16
children 73906187f964
comparison
equal deleted inserted replaced
1802:0ab737feada6 1803:4d73a1a6ba68
1 ---
2 labels:
3 summary: Default bookmarked chatrooms
4 ...
5
6 Introduction
7 ============
8
9 This module allows you to add default bookmarks for users. It only kicks
10 in when the user has no existing bookmarks, so users are free to add,
11 change or remove them.
12
13 Details
14 =======
15
16 Most clients support storing a private list of room "bookmarks" on the
17 server. When they log in, they fetch this list and join any that are
18 marked as "autojoin". If this list is empty, as it would be for new
19 users, this module would return the list supplied in the config.
20
21 Configuration
22 =============
23
24 Add "default\_bookmarks" to your modules\_enabled list:
25
26 modules_enabled = {
27 -- ...other modules here... --
28 "default_bookmarks";
29 -- ...maybe some more here... --
30 }
31
32 Then add a list of the default rooms you want:
33
34 default_bookmarks = {
35 { jid = "room@conference.example.com", name = "The Room" };
36 { jid = "another-room@conference.example.com", name = "The Other Room" };
37 -- You can also use this compact syntax:
38 "yetanother@conference.example.com"; -- this will get "yetanother" as name
39 };