annotate mod_incidents_handling.wiki @ 371:bdac3ad25bce

mod_dwd: Add wiki page
author Kim Alvefur <zash@zash.se>
date Fri, 28 Jun 2013 18:35:40 +0200
parents 859253320275
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
322
c52f914590e7 wiki commit.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
1 #summary Incidents Handling plugin
c52f914590e7 wiki commit.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
2 #labels Stage-Beta
c52f914590e7 wiki commit.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
3
c52f914590e7 wiki commit.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
4 = Introduction =
c52f914590e7 wiki commit.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
5
c52f914590e7 wiki commit.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
6 This module implements [http://xmpp.org/extensions/xep-0268.html XEP-268].
c52f914590e7 wiki commit.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
7
c52f914590e7 wiki commit.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
8 = Details =
c52f914590e7 wiki commit.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
9
c52f914590e7 wiki commit.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
10 It will let you manage reports, inquiries, requests and responses through an Adhoc interface.
c52f914590e7 wiki commit.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
11 The following new adhoc admin commands will be available:
c52f914590e7 wiki commit.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
12
c52f914590e7 wiki commit.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
13 * List Incidents -- List all available incidents and let's you reply requests.
c52f914590e7 wiki commit.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
14 * Send Incident Inquiry -- Inquiry a remote server about an incident.
c52f914590e7 wiki commit.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
15 * Send Incident Report -- Send an incident report to a remote server.
c52f914590e7 wiki commit.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
16 * Send Incident Request -- Send an incident request to a remote server.
c52f914590e7 wiki commit.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
17
324
859253320275 add code inline syntax to "<desc/>".
Marco Cirillo <maranda@lightwitch.org>
parents: 323
diff changeset
18 Each Adhoc form provides syntax instructions through `<desc/>` elements (they may currently be stripped
322
c52f914590e7 wiki commit.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
19 by Prosody), although it's encouraged to read the [https://tools.ietf.org/html/rfc5070 IODEF specifications].
c52f914590e7 wiki commit.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
20
c52f914590e7 wiki commit.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
21 = Usage =
c52f914590e7 wiki commit.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
22
c52f914590e7 wiki commit.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
23 Copy the module folder into your prosody modules directory.
c52f914590e7 wiki commit.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
24 Place the module between your enabled modules either into the global or a vhost section.
c52f914590e7 wiki commit.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
25
c52f914590e7 wiki commit.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
26 Optional configuration directives:
c52f914590e7 wiki commit.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
27 <code language="lua">
c52f914590e7 wiki commit.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
28 incidents_expire_time = 86400 -- Expiral of "closed" incidents in seconds.
c52f914590e7 wiki commit.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
29 </code>
c52f914590e7 wiki commit.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
30
c52f914590e7 wiki commit.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
31 = Info =
c52f914590e7 wiki commit.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
32
c52f914590e7 wiki commit.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
33 * to be 0.9, works.