mod_incidents_handling/README.wiki
changeset 1786 29f3d6b7ad16
equal deleted inserted replaced
1785:12ac88940fe3 1786:29f3d6b7ad16
       
     1 #summary Incidents Handling plugin
       
     2 #labels Stage-Beta
       
     3 
       
     4 = Introduction =
       
     5 
       
     6 This module implements [http://xmpp.org/extensions/xep-0268.html XEP-268].
       
     7 
       
     8 = Details =
       
     9 
       
    10 It will let you manage reports, inquiries, requests and responses through an Adhoc interface.
       
    11 The following new adhoc admin commands will be available:
       
    12 
       
    13  * List Incidents -- List all available incidents and let's you reply requests.
       
    14  * Send Incident Inquiry -- Inquiry a remote server about an incident.
       
    15  * Send Incident Report -- Send an incident report to a remote server.
       
    16  * Send Incident Request -- Send an incident request to a remote server.
       
    17 
       
    18 Each Adhoc form provides syntax instructions through `<desc/>` elements (they may currently be stripped
       
    19 by Prosody), although it's encouraged to read the [https://tools.ietf.org/html/rfc5070 IODEF specifications].
       
    20 
       
    21 = Usage =
       
    22 
       
    23 Copy the module folder into your prosody modules directory.
       
    24 Place the module between your enabled modules either into the global or a vhost section.
       
    25 
       
    26 Optional configuration directives:
       
    27 <code language="lua">
       
    28 incidents_expire_time = 86400 -- Expiral of "closed" incidents in seconds.
       
    29 </code>
       
    30 
       
    31 = Info =
       
    32 
       
    33  * to be 0.9, works.