mod_muc_adhoc_bots/README.markdown
author Kim Alvefur <zash@zash.se>
Mon, 12 Feb 2024 15:44:38 +0100
changeset 5841 7d11a3133d17
parent 5662 7a4a6ded2bd6
permissions -rw-r--r--
mod_blocking: Drop mention of mod_privacy
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
5656
eade7ff9f52c mod_muc_adhoc_bots: add module
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
     1
---
eade7ff9f52c mod_muc_adhoc_bots: add module
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
     2
labels:
5662
7a4a6ded2bd6 mod_muc_adhoc_bots: Fix unbalanced quote in metadata section
Kim Alvefur <zash@zash.se>
parents: 5656
diff changeset
     3
- Stage-Alpha
5656
eade7ff9f52c mod_muc_adhoc_bots: add module
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
     4
summary: Install adhoc command bots in MUCs
eade7ff9f52c mod_muc_adhoc_bots: add module
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
     5
---
eade7ff9f52c mod_muc_adhoc_bots: add module
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
     6
eade7ff9f52c mod_muc_adhoc_bots: add module
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
     7
# Introduction
eade7ff9f52c mod_muc_adhoc_bots: add module
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
     8
eade7ff9f52c mod_muc_adhoc_bots: add module
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
     9
This module allows you to "install" bots on a MUC service (via config for
eade7ff9f52c mod_muc_adhoc_bots: add module
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
    10
now, via adhoc command and on just one MUC to follow). All the adhoc commands
eade7ff9f52c mod_muc_adhoc_bots: add module
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
    11
defined on the bot become adhoc commands on the service's MUCs, and the bots
eade7ff9f52c mod_muc_adhoc_bots: add module
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
    12
can send XEP-0356 messages to the MUC to send messages as any participant.
eade7ff9f52c mod_muc_adhoc_bots: add module
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
    13
eade7ff9f52c mod_muc_adhoc_bots: add module
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
    14
# Configuration
eade7ff9f52c mod_muc_adhoc_bots: add module
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
    15
eade7ff9f52c mod_muc_adhoc_bots: add module
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
    16
List all bots to install. You must specify full JID.
eade7ff9f52c mod_muc_adhoc_bots: add module
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
    17
eade7ff9f52c mod_muc_adhoc_bots: add module
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
    18
    adhoc_bots = { "some@bot.example.com/bot" }
eade7ff9f52c mod_muc_adhoc_bots: add module
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
    19
	
eade7ff9f52c mod_muc_adhoc_bots: add module
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
    20
And enable the module on the MUC service as usual
eade7ff9f52c mod_muc_adhoc_bots: add module
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
    21
eade7ff9f52c mod_muc_adhoc_bots: add module
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
    22
    modules_enabled = { "muc_adhoc_bots" }