changeset 96:90b363bc0fb8

mod_srvinjection: Initial documentation commit.
author Waqas Hussain <waqas20@gmail.com>
date Mon, 23 Nov 2009 21:40:08 +0500
parents f18d4607c52d
children 0f5256889fef
files mod_srvinjection.wiki
diffstat 1 files changed, 38 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_srvinjection.wiki	Mon Nov 23 21:40:08 2009 +0500
@@ -0,0 +1,38 @@
+#summary Manually specify SRV records
+#labels Stage-Alpha
+
+= Introduction =
+This Prosody plugin lets you manually override SRV records used for a remote host.
+
+= Usage =
+Simply add `"srvinjection"` to your `modules_enabled` list to enable. Then add the `srvinjection` option to the global section.
+
+= Configuration =
+The `srvinjection` option can be used as follows:
+
+{{{
+srvinjection = {
+  ["example.com"] = {"localhost", 5000};
+  ["jabber.org"] = {"localhost", 5001};
+};
+}}}
+
+The format for individual items is `["remote-hostname"] = {"srv-hostname", srv-port};`.
+
+= Reloading =
+The module can be reloaded via the telnet console. Edit the config file to make any updates.
+
+You can reload the configuration from disk:
+{{{
+config:reload()
+}}}
+And then reload the module to apply the configuration changes:
+{{{
+module:reload("srvinjection", "*")
+}}}
+
+= Compatibility =
+||0.6||Works||
+
+= How it works =
+The module replaces the `lookup` function of the `net.adns` module with its own. The original is set back when the module is unloaded.