Software / code / prosody-modules
Comparison
mod_incidents_handling/README.markdown @ 1803:4d73a1a6ba68
Convert all wiki pages to Markdown
| author | Kim Alvefur <zash@zash.se> |
|---|---|
| date | Fri, 28 Aug 2015 18:03:58 +0200 |
| parent | 1782:mod_incidents_handling/README.wiki@29f3d6b7ad16 |
| child | 1820:8de50be756e5 |
comparison
equal
deleted
inserted
replaced
| 1802:0ab737feada6 | 1803:4d73a1a6ba68 |
|---|---|
| 1 --- | |
| 2 labels: | |
| 3 - 'Stage-Beta' | |
| 4 summary: Incidents Handling plugin | |
| 5 ... | |
| 6 | |
| 7 Introduction | |
| 8 ============ | |
| 9 | |
| 10 This module implements | |
| 11 [XEP-268](http://xmpp.org/extensions/xep-0268.html). | |
| 12 | |
| 13 Details | |
| 14 ======= | |
| 15 | |
| 16 It will let you manage reports, inquiries, requests and responses | |
| 17 through an Adhoc interface. The following new adhoc admin commands will | |
| 18 be available: | |
| 19 | |
| 20 - List Incidents -- List all available incidents and let's you reply | |
| 21 requests. | |
| 22 - Send Incident Inquiry -- Inquiry a remote server about an incident. | |
| 23 - Send Incident Report -- Send an incident report to a remote server. | |
| 24 - Send Incident Request -- Send an incident request to a remote | |
| 25 server. | |
| 26 | |
| 27 Each Adhoc form provides syntax instructions through `<desc/>` elements | |
| 28 (they may currently be stripped by Prosody), although it's encouraged to | |
| 29 read the [IODEF specifications](https://tools.ietf.org/html/rfc5070). | |
| 30 | |
| 31 Usage | |
| 32 ===== | |
| 33 | |
| 34 Copy the module folder into your prosody modules directory. Place the | |
| 35 module between your enabled modules either into the global or a vhost | |
| 36 section. | |
| 37 | |
| 38 Optional configuration directives: | |
| 39 | |
| 40 ``` {.lua} | |
| 41 | |
| 42 incidents_expire_time = 86400 -- Expiral of "closed" incidents in seconds. | |
| 43 ``` | |
| 44 | |
| 45 Info | |
| 46 ==== | |
| 47 | |
| 48 - to be 0.9, works. |