view mod_muc_adhoc_bots/README.markdown @ 5668:ecfd7aece33b

mod_measure_modules: Report module statuses via OpenMetrics Someone in the chat asked about a health check endpoint, which reminded me of mod_http_status, which provides access to module statuses with full details. After that, this idea came about, which seems natural. As noted in the README, it could be used to monitor that critical modules are in fact loaded correctly. As more modules use the status API, the more useful this module and mod_http_status becomes.
author Kim Alvefur <zash@zash.se>
date Fri, 06 Oct 2023 18:34:39 +0200
parents 7a4a6ded2bd6
children
line wrap: on
line source

---
labels:
- Stage-Alpha
summary: Install adhoc command bots in MUCs
---

# Introduction

This module allows you to "install" bots on a MUC service (via config for
now, via adhoc command and on just one MUC to follow). All the adhoc commands
defined on the bot become adhoc commands on the service's MUCs, and the bots
can send XEP-0356 messages to the MUC to send messages as any participant.

# Configuration

List all bots to install. You must specify full JID.

    adhoc_bots = { "some@bot.example.com/bot" }
	
And enable the module on the MUC service as usual

    modules_enabled = { "muc_adhoc_bots" }