view mod_incidents_handling/README.markdown @ 4542:fb4a50bf60f1

mod_prometheus: Invoke stats collection if in 'manual' mode Since 10d13e0554f9 a special value for statistics_interval "manual" exists, where a module is expected to invoke processing in connection to collection of stats. This makes internal collection and exporting to Prometheus happens at the same time with no chance of timers getting out of sync.
author Kim Alvefur <zash@zash.se>
date Tue, 13 Apr 2021 23:53:53 +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.