Mercurial > prosody-modules
view mod_vjud/README.markdown @ 2818:88474dd1af48
Various READMEs: s/eg/e.g.g/
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Fri, 10 Nov 2017 05:33:28 +0100 |
parents | dd806ebeb2fc |
children | ea6b5321db50 |
line wrap: on
line source
--- labels: - 'Stage-Alpha' summary: 'XEP-0055: Jabber Search' ... Introduction ============ Basic implementation of [XEP-0055: Jabber Search]. Details ======= This module has two modes. One mode requires users to opt-in to be searchable, then allows users to search the list of those users. The second mode allows search accross all users. Usage ===== First copy the module to the prosody plugins directory. Then add "vjud" to your modules\_enabled list: modules_enabled = { -- ... "vjud", -- ... } Alternatively, you can load it as a component: Component "search.example.com" "vjud" (Some old clients require this) Configuration ============= Option Default Description ------------ ---------- -------------------------------- vjud\_mode "opt-in" Defines how the module behaves Compatibility ============= ------- --------------------------------- 0.8 Works, but only the opt-in mode 0.9 Works trunk Works ------- --------------------------------- Note that the version for 0.8 and 0.9 are slightly different.