Mercurial > prosody-modules
comparison mod_vjud/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 |
| parents | mod_vjud/README.wiki@29f3d6b7ad16 |
| children | dd806ebeb2fc |
comparison
equal
deleted
inserted
replaced
| 1802:0ab737feada6 | 1803:4d73a1a6ba68 |
|---|---|
| 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 | |
| 11 Search](http://xmpp.org/extensions/xep-0055.html). | |
| 12 | |
| 13 Details | |
| 14 ======= | |
| 15 | |
| 16 This module has two modes. One mode requires users to opt-in to be | |
| 17 searchable, then allows users to search the list of those users. The | |
| 18 second mode allows search accross all users. | |
| 19 | |
| 20 Usage | |
| 21 ===== | |
| 22 | |
| 23 First copy the module to the prosody plugins directory. | |
| 24 | |
| 25 Then add "vjud" to your modules\_enabled list: | |
| 26 | |
| 27 modules_enabled = { | |
| 28 -- ... | |
| 29 "vjud", | |
| 30 -- ... | |
| 31 } | |
| 32 | |
| 33 Alternatively, you can load it as a component: | |
| 34 | |
| 35 Component "search.example.com" "vjud" | |
| 36 | |
| 37 (Some old clients require this) | |
| 38 | |
| 39 Configuration | |
| 40 ============= | |
| 41 | |
| 42 Option Default Description | |
| 43 ------------ ---------- -------------------------------- | |
| 44 vjud\_mode "opt-in" Defines how the module behaves | |
| 45 | |
| 46 Compatibility | |
| 47 ============= | |
| 48 | |
| 49 ------- --------------------------------- | |
| 50 0.8 Works, but only the opt-in mode | |
| 51 0.9 Works | |
| 52 trunk Works | |
| 53 ------- --------------------------------- | |
| 54 | |
| 55 Note that the version for 0.8 and 0.9 are slightly different. |