Mercurial > prosody-modules

comparison mod_vjud/README.wiki @ 1782:29f3d6b7ad16

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Import wiki pages
author Kim Alvefur <zash@zash.se>
date Mon, 24 Aug 2015 16:43:56 +0200
parents
children
comparison
equal deleted inserted replaced
1781:12ac88940fe3 1782:29f3d6b7ad16
1 #summary XEP-0055: Jabber Search
2 #labels Stage-Alpha
3
4 = Introduction =
5
6 Basic implementation of [http://xmpp.org/extensions/xep-0055.html XEP-0055: Jabber Search].
7
8 = Details =
9
10 This module has two modes. One mode requires users to opt-in to be
11 searchable, then allows users to search the list of those users. The
12 second mode allows search accross all users.
13
14 = Usage =
15
16 First copy the module to the prosody plugins directory.
17
18 Then add "vjud" to your modules_enabled list:
19 {{{
20 modules_enabled = {
21 -- ...
22 "vjud",
23 -- ...
24 }
25 }}}
26
27
28 Alternatively, you can load it as a component:
29
30 {{{
31 Component "search.example.com" "vjud"
32 }}}
33
34 (Some old clients require this)
35
36 = Configuration =
37
38 || Option || Default || Description ||
39 || vjud_mode || "opt-in" || Defines how the module behaves ||
40
41 = Compatibility =
42 || 0.8 || Works, but only the opt-in mode ||
43 || 0.9 || Works ||
44 || trunk || Works ||
45
46 Note that the version for 0.8 and 0.9 are slightly different.
47