Mercurial > prosody-modules
view mod_spam_report_forwarder/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 | 94472eb41d0a |
children |
line wrap: on
line source
--- labels: - 'Stage-Beta' summary: 'Forward spam/abuse reports to a JID' --- This module forwards spam/abuse reports (e.g. those submitted by users via XEP-0377 via mod_spam_reporting) to one or more JIDs. ## Configuration Install and enable the module the same as any other. There is a single option, `spam_report_destinations` which accepts a list of JIDs to send reports to. For example: ```lua modules_enabled = { --- "spam_reporting"; "spam_report_forwarder"; --- } spam_report_destinations = { "antispam.example.com" } ``` ## Protocol This section is intended for developers. XEP-0377 assumes the report is embedded within another protocol such as XEP-0191, and doesn't specify a format for communicating "standalone" reports. This module transmits them inside a `<message>` stanza, and adds a `<jid/>` element (borrowed from XEP-0268): ```xml <message from="prosody.example" to="destination.example"> <report xmlns="urn:xmpp:reporting:1" reason="urn:xmpp:reporting:spam"> <jid xmlns="urn:xmpp:jid:0">spammer@bad.example</jid> <text> Never came trouble to my house like this. </text> </report> </message> ```