File

mod_incidents_handling/README.wiki @ 1797:a946aa422503

mod_mam_sql/README: More obvious pointers to use mod_mam instead
author Kim Alvefur <zash@zash.se>
date Thu, 27 Aug 2015 16:14:54 +0200
parent 1782:29f3d6b7ad16
line wrap: on
line source

#summary Incidents Handling plugin
#labels Stage-Beta

= Introduction =

This module implements [http://xmpp.org/extensions/xep-0268.html XEP-268].

= Details =

It will let you manage reports, inquiries, requests and responses through an Adhoc interface.
The following new adhoc admin commands will be available:

 * List Incidents -- List all available incidents and let's you reply requests.
 * Send Incident Inquiry -- Inquiry a remote server about an incident.
 * Send Incident Report -- Send an incident report to a remote server.
 * Send Incident Request -- Send an incident request to a remote server.

Each Adhoc form provides syntax instructions through `<desc/>` elements (they may currently be stripped
by Prosody), although it's encouraged to read the [https://tools.ietf.org/html/rfc5070 IODEF specifications].

= Usage =

Copy the module folder into your prosody modules directory.
Place the module between your enabled modules either into the global or a vhost section.

Optional configuration directives:
<code language="lua">
incidents_expire_time = 86400 -- Expiral of "closed" incidents in seconds.
</code>

= Info =

 * to be 0.9, works.