prosody-modules
tip
mod_vjud/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_vjud/README.md @ 6211:750d64c47ec6 draft default tip

Merge
author Trần H. Trung <xmpp:trần.h.trung@trung.fun>
date Tue, 18 Mar 2025 00:31:36 +0700
parent 6003:fe081789f7b5
comparison
equal deleted inserted replaced
6210:24316a399978 6211:750d64c47ec6
1 ---
2 labels:
3 - 'Stage-Alpha'
4 summary: 'XEP-0055: Jabber Search'
5 ...
6
7 Introduction
8 ============
9
10 Basic implementation of [XEP-0055: Jabber Search].
11
12 Details
13 =======
14
15 This module has two modes. One mode requires users to opt-in to be
16 searchable, then allows users to search the list of those users. The
17 second mode allows search across all users.
18
19 Usage
20 =====
21
22 First copy the module to the prosody plugins directory.
23
24 Then add "vjud" to your modules\_enabled list:
25
26 modules_enabled = {
27 -- ...
28 "vjud",
29 -- ...
30 }
31
32 Alternatively, you can load it as a component:
33
34 Component "search.example.com" "vjud"
35
36 (Some old clients require this)
37
38 Configuration
39 =============
40
41 Option Default Description
42 ------------ ---------- --------------------------------
43 vjud\_mode "opt-in" Choose how users are listed in the directory ("opt-in" or "all")
44
45 Compatibility
46 =============
47
48 ------- ---------------------------------
49 0.8 Works, but only the opt-in mode
50 0.9 Works
51 trunk Works
52 ------- ---------------------------------
53
54 Note that the version for 0.8 and 0.9 are slightly different.