prosody-modules
d611ed13df7e
mod_default_bookmarks/README.md

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

Software / code / prosody-modules

Comparison

mod_default_bookmarks/README.md @ 6209:d611ed13df7e draft

Merge
author Trần H. Trung <xmpp:trần.h.trung@trung.fun>
date Tue, 18 Mar 2025 00:16:25 +0700
parent 5613:mod_default_bookmarks/README.markdown@39bb7232326d
comparison
equal deleted inserted replaced
6208:e20901443eae 6209:d611ed13df7e
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 ``` lua
35 default_bookmarks = {
36 { jid = "room@conference.example.com"; name = "The Room"; autojoin = true };
37 -- Specifying a password is supported:
38 { jid = "secret-room@conference.example.com"; name = "A Secret Room"; password = "secret"; autojoin = true };
39 -- You can also use this compact syntax:
40 "yetanother@conference.example.com"; -- this will get "yetanother" as name
41 };
42 ```
43
44 Compatibility
45 -------------
46
47 ------- ---------------
48 trunk Works
49 0.10 Should work
50 0.9 Should work
51 ------- ---------------