view mod_broadcast/README.md @ 6319:04c3273cb81f

mod_auth_cyrus: Add empty 'profile' table to SASL handler objects This is for compatibility with Prosody's built-in util.sasl objects. A SASL profile table usually includes methods supported by the backend, which can be used by SASL mechanism handlers to perform operations (such as testing the password). It also optionally contains a 'cb' field with channel binding method handlers. The Cyrus backend doesn't support channel binding, and doesn't have the same concept of auth backend methods (it handles all that internally, and Prosody has no insight or control over it). Thus, we create an empty profile which informs Prosody that the SASL handler does not support any of the auth or channel binding methods. Some features will not work, but they didn't work anyway. This just makes it explicit. This fixes a traceback in mod_sasl2_fast, which expected SASL handlers to always contain a 'profile' field.
author Matthew Wild <mwild1@gmail.com>
date Thu, 04 Sep 2025 10:14:46 +0100
parents fe081789f7b5
children 4dd7c197ca5b
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
  trunk  Doesn't work (uses is_admin)
  ------ -------