prosody-modules
d194d1012fd3
mod_incidents_handling/README.markdown
Software / code / prosody-modules
File
mod_incidents_handling/README.markdown @ 5931:d194d1012fd3
Updating dox for mod_rest. Ideas expressed / clarified:
1) Making clear that mod_rest isn't to be installed under VirtualHosts AND as a component.
2) Understanding some of the implications of this choice:
A) Changes to user authentication
B) How it affects subdomains
3) More consistent use of domain names for clarity.
4) Using different heading sizes to show scope of section.
Essentially, I added all the tidbits I had to clarify in getting this to work in my
own example.
| author | Ben Smith <bens@effortlessis.com> |
|---|---|
| date | Mon, 13 May 2024 13:25:13 -0700 |
| parent | 1820:8de50be756e5 |
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.
