mod_srvinjection/README.wiki
changeset 1786 29f3d6b7ad16
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_srvinjection/README.wiki	Mon Aug 24 16:43:56 2015 +0200
@@ -0,0 +1,45 @@
+#summary Manually specify SRV records
+#labels Stage-Beta
+
+= 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};`.
+
+The special remote hostname `"*"` can be used as a wildcard:
+{{{
+	srvinjection = { ["*"] = {"xmpp-server.l.google.com", 5269} } -- Use Google's XMPP server for all hostnames
+}}}
+
+= 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.8||Works||
+||0.7||Works||
+||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.
\ No newline at end of file