view mod_broadcast/README.markdown @ 2029:3e00cd4a02bc

mod_component_client: Pass a non-zero exit code on shutdown due to lost connection `prosody.shutdown` takes a code as of https://hg.prosody.im/0.10/rev/a22d6a46d2ed
author daurnimator <quae@daurnimator.com>
date Wed, 20 Jan 2016 13:10:50 +1100
parents 4d73a1a6ba68
children 34fb3d239ac1
line wrap: on
line source

---
labels:
- 'Stage-Stable'
summary: Broadcast a message to online users
...

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
  ------ -------