1 ---

     2 labels:

     3 - 'Stage-Stable'

     4 summary: Broadcast a message to online users

     5 ...

     6 

     7 Introduction

     8 ============

     9 

    10 This module largely duplicates the functionality of the standard

    11 mod\_announce that is included with Prosody. It was developed for

    12 compatibility with some clients (e.g. iChat) that do not support ad-hoc

    13 commands or sending to JIDs with the format

    14 'example.com/announce/online'.

    15 

    16 It may also be useful in other specific cases.

    17 

    18 Configuration

    19 =============

    20 

    21     Component "broadcast@example.com" "broadcast"

    22 

    23 By default, only server admins are allowed to post to this address. You

    24 can override this, by specifying the 'broadcast\_senders' option:

    25 

    26     Component "broadcast@example.com" "broadcast"

    27         broadcast_senders = { "user1@example.com", "user2@example.com" }

    28 

    29 Compatibility

    30 =============

    31 

    32   ------ -------

    33   0.9    Works

    34   0.10   Works

    35   ------ -------