view mod_vjud.wiki @ 420:eb372e6bb82f

mod_auth_ldap: Document the ldap_mode option
author Kim Alvefur <zash@zash.se>
date Tue, 21 Jan 2014 20:26:30 +0100
parents 2454dbf940a8
children
line wrap: on
line source

#summary XEP-0055: Jabber Search
#labels Stage-Alpha

= Introduction =

Basic implementation of [http://xmpp.org/extensions/xep-0055.html 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.