diff mod_broadcast/README.wiki @ 1782:29f3d6b7ad16

Import wiki pages
author Kim Alvefur <zash@zash.se>
date Mon, 24 Aug 2015 16:43:56 +0200
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_broadcast/README.wiki	Mon Aug 24 16:43:56 2015 +0200
@@ -0,0 +1,25 @@
+#summary Broadcast a message to online users
+#labels Stage-Stable
+
+= Introduction =
+
+This module largely duplicates the functionality of the standard mod_announce that is included with Prosody. It was developed for compatibility with some clients (e.g. iChat) that do not support ad-hoc commands or sending to JIDs with the format 'example.com/announce/online'.
+
+It may also be useful in other specific cases.
+
+= Configuration =
+
+{{{
+Component "broadcast@example.com" "broadcast"
+}}}
+
+By default, only server admins are allowed to post to this address. You can override this, by specifying the 'broadcast_senders' option:
+
+{{{
+Component "broadcast@example.com" "broadcast"
+    broadcast_senders = { "user1@example.com", "user2@example.com" }
+}}}
+
+= Compatibility =
+||0.9||Works||
+||0.10||Works||
\ No newline at end of file