Mercurial > prosody-wiki

annotate mod_srvinjection.wiki @ 164:5417e7610ad4

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_srvinjection: Update docs for wildcard host support.
author Waqas Hussain <waqas20@gmail.com>
date Wed, 09 Feb 2011 16:37:51 +0500
parents 90b363bc0fb8
children 44f9d6dae0cc
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
96
90b363bc0fb8 mod_srvinjection: Initial documentation commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
1 #summary Manually specify SRV records
90b363bc0fb8 mod_srvinjection: Initial documentation commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
2 #labels Stage-Alpha
90b363bc0fb8 mod_srvinjection: Initial documentation commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
3
90b363bc0fb8 mod_srvinjection: Initial documentation commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
4 = Introduction =
90b363bc0fb8 mod_srvinjection: Initial documentation commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
5 This Prosody plugin lets you manually override SRV records used for a remote host.
90b363bc0fb8 mod_srvinjection: Initial documentation commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
6
90b363bc0fb8 mod_srvinjection: Initial documentation commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
7 = Usage =
90b363bc0fb8 mod_srvinjection: Initial documentation commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
8 Simply add `"srvinjection"` to your `modules_enabled` list to enable. Then add the `srvinjection` option to the global section.
90b363bc0fb8 mod_srvinjection: Initial documentation commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
9
90b363bc0fb8 mod_srvinjection: Initial documentation commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
10 = Configuration =
90b363bc0fb8 mod_srvinjection: Initial documentation commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
11 The `srvinjection` option can be used as follows:
90b363bc0fb8 mod_srvinjection: Initial documentation commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
12
90b363bc0fb8 mod_srvinjection: Initial documentation commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
13 {{{
90b363bc0fb8 mod_srvinjection: Initial documentation commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
14 srvinjection = {
90b363bc0fb8 mod_srvinjection: Initial documentation commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
15 ["example.com"] = {"localhost", 5000};
90b363bc0fb8 mod_srvinjection: Initial documentation commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
16 ["jabber.org"] = {"localhost", 5001};
90b363bc0fb8 mod_srvinjection: Initial documentation commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
17 };
90b363bc0fb8 mod_srvinjection: Initial documentation commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
18 }}}
90b363bc0fb8 mod_srvinjection: Initial documentation commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
19
90b363bc0fb8 mod_srvinjection: Initial documentation commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
20 The format for individual items is `["remote-hostname"] = {"srv-hostname", srv-port};`.
90b363bc0fb8 mod_srvinjection: Initial documentation commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
21
164
5417e7610ad4 mod_srvinjection: Update docs for wildcard host support.
Waqas Hussain <waqas20@gmail.com>
parents: 96
diff changeset
22 The special remote hostname "*" can be used as a wildcard:
5417e7610ad4 mod_srvinjection: Update docs for wildcard host support.
Waqas Hussain <waqas20@gmail.com>
parents: 96
diff changeset
23 {{{
5417e7610ad4 mod_srvinjection: Update docs for wildcard host support.
Waqas Hussain <waqas20@gmail.com>
parents: 96
diff changeset
24 srvinjection = { ["*"] = {"xmpp-server.l.google.com", 5269} } -- Use Google's XMPP server for all hostnames
5417e7610ad4 mod_srvinjection: Update docs for wildcard host support.
Waqas Hussain <waqas20@gmail.com>
parents: 96
diff changeset
25 }}}
5417e7610ad4 mod_srvinjection: Update docs for wildcard host support.
Waqas Hussain <waqas20@gmail.com>
parents: 96
diff changeset
26
96
90b363bc0fb8 mod_srvinjection: Initial documentation commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
27 = Reloading =
90b363bc0fb8 mod_srvinjection: Initial documentation commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
28 The module can be reloaded via the telnet console. Edit the config file to make any updates.
90b363bc0fb8 mod_srvinjection: Initial documentation commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
29
90b363bc0fb8 mod_srvinjection: Initial documentation commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
30 You can reload the configuration from disk:
90b363bc0fb8 mod_srvinjection: Initial documentation commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
31 {{{
90b363bc0fb8 mod_srvinjection: Initial documentation commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
32 config:reload()
90b363bc0fb8 mod_srvinjection: Initial documentation commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
33 }}}
90b363bc0fb8 mod_srvinjection: Initial documentation commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
34 And then reload the module to apply the configuration changes:
90b363bc0fb8 mod_srvinjection: Initial documentation commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
35 {{{
90b363bc0fb8 mod_srvinjection: Initial documentation commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
36 module:reload("srvinjection", "*")
90b363bc0fb8 mod_srvinjection: Initial documentation commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
37 }}}
90b363bc0fb8 mod_srvinjection: Initial documentation commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
38
90b363bc0fb8 mod_srvinjection: Initial documentation commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
39 = Compatibility =
90b363bc0fb8 mod_srvinjection: Initial documentation commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
40 ||0.6||Works||
90b363bc0fb8 mod_srvinjection: Initial documentation commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
41
90b363bc0fb8 mod_srvinjection: Initial documentation commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
42 = How it works =
90b363bc0fb8 mod_srvinjection: Initial documentation commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
43 The module replaces the `lookup` function of the `net.adns` module with its own. The original is set back when the module is unloaded.