Diff

mod_discoitems/README.markdown @ 1803:4d73a1a6ba68

Convert all wiki pages to Markdown
author Kim Alvefur <zash@zash.se>
date Fri, 28 Aug 2015 18:03:58 +0200 (2015-08-28)
parent 1782:29f3d6b7ad16
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_discoitems/README.markdown	Fri Aug 28 18:03:58 2015 +0200
@@ -0,0 +1,44 @@
+---
+labels:
+- 'Stage-Beta'
+summary: Manually override the list of service discovery items
+...
+
+Introduction
+============
+
+This Prosody plugin lets you manually override the service discovery
+items for a host.
+
+Usage
+=====
+
+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.
+
+Note: mod\_disco in Prosody 0.8+ supports the `disco_items` option; this
+plugin changes the behavior from appending items to replacing items
+
+Configuration
+=============
+
+The `disco_items` option can be added to relevant hosts:
+
+    disco_items = {
+      {"proxy.eu.jabber.org", "Jabber.org SOCKS5 service"};
+      {"conference.jabber.org", "The Jabber.org MUC"};
+    }
+
+The format for individual items is `{JID, display-name}`. The
+display-name can be omitted: `{JID}`.
+
+Compatibility
+=============
+
+  ----- -------------
+  0.8   Works
+  0.7   Works
+  0.6   Works
+  0.5   Should work
+  ----- -------------