view mod_incidents_handling/README.markdown @ 5585:5b316088bef5

mod_rest: Use logger of HTTP request in trunk In Prosody trunk rev c975dafa4303 each HTTP request gained its own log sink, to make it easy to log things related to each request and group those messages. Especially where async is used, spreading the request and response apart as mod_rest does with iq stanzas, this grouped logging should help find related messages.
author Kim Alvefur <zash@zash.se>
date Fri, 07 Jul 2023 00:10:37 +0200
parents 8de50be756e5
children
line wrap: on
line source

---
labels:
- 'Stage-Beta'
summary: Incidents Handling plugin
...

Introduction
============

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

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 [IODEF specifications](https://tools.ietf.org/html/rfc5070).

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:

``` {.lua}
incidents_expire_time = 86400 -- Expiral of "closed" incidents in seconds.
```

Info
====

-   to be 0.9, works.