annotate mod_discoitems.wiki @ 167:caa297adfe14

Make a small amendment to the text about how OTPs work.
author MWild1
date Thu, 17 Feb 2011 16:30:00 +0000
parents 75092a6a82b2
children e4746a9ee7d4
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
110
75092a6a82b2 mod_discoitems: Updated documentation.
Waqas Hussain <waqas20@gmail.com>
parents: 82
diff changeset
1 #summary Manually override the list of service discovery items
82
f75b675c8de3 mod_discoitems: Initial commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
2 #labels Stage-Beta
f75b675c8de3 mod_discoitems: Initial commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
3
f75b675c8de3 mod_discoitems: Initial commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
4 = Introduction =
f75b675c8de3 mod_discoitems: Initial commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
5
f75b675c8de3 mod_discoitems: Initial commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
6 This Prosody plugin lets you manually override the service discovery items for a host.
f75b675c8de3 mod_discoitems: Initial commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
7
f75b675c8de3 mod_discoitems: Initial commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
8 = Usage =
f75b675c8de3 mod_discoitems: Initial commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
9
f75b675c8de3 mod_discoitems: Initial commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
10 Simply add `"discoitems"` to your modules_enabled list. Then add the `disco_items` option to hosts for which you wish to override the default response.
f75b675c8de3 mod_discoitems: Initial commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
11
f75b675c8de3 mod_discoitems: Initial commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
12 = Configuration =
f75b675c8de3 mod_discoitems: Initial commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
13
f75b675c8de3 mod_discoitems: Initial commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
14 The `disco_items` option can be added to relevant hosts:
f75b675c8de3 mod_discoitems: Initial commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
15
f75b675c8de3 mod_discoitems: Initial commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
16 {{{
f75b675c8de3 mod_discoitems: Initial commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
17 disco_items = {
f75b675c8de3 mod_discoitems: Initial commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
18 {"proxy.eu.jabber.org", "Jabber.org SOCKS5 service"};
f75b675c8de3 mod_discoitems: Initial commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
19 {"conference.jabber.org", "The Jabber.org MUC"};
f75b675c8de3 mod_discoitems: Initial commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
20 }
f75b675c8de3 mod_discoitems: Initial commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
21 }}}
f75b675c8de3 mod_discoitems: Initial commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
22
f75b675c8de3 mod_discoitems: Initial commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
23 The format for individual items is `{JID, display-name}`. The display-name can be omitted: `{JID}`.
f75b675c8de3 mod_discoitems: Initial commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
24
f75b675c8de3 mod_discoitems: Initial commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
25 = Compatibility =
110
75092a6a82b2 mod_discoitems: Updated documentation.
Waqas Hussain <waqas20@gmail.com>
parents: 82
diff changeset
26 ||0.7||Works||
82
f75b675c8de3 mod_discoitems: Initial commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
27 ||0.6||Works||
f75b675c8de3 mod_discoitems: Initial commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
28 ||0.5||Should work||
f75b675c8de3 mod_discoitems: Initial commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
29
f75b675c8de3 mod_discoitems: Initial commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
30 = Caveats/Todos/Bugs =
f75b675c8de3 mod_discoitems: Initial commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
31
110
75092a6a82b2 mod_discoitems: Updated documentation.
Waqas Hussain <waqas20@gmail.com>
parents: 82
diff changeset
32 * mod_disco in Prosody trunk supports the `disco_items` option; this plugin changes the behavior from appending items to replacing items