view mod_mam_adhoc/README.markdown @ 5551:8bfcedd93a72

mod_rest: List all error conditions in OpenAPI spec These are not handled by datamanager but by util.stanza and util.error, so they are not represented in the JSON schema file.
author Kim Alvefur <zash@zash.se>
date Sat, 17 Jun 2023 16:26:33 +0200
parents 8de50be756e5
children
line wrap: on
line source

---
labels:
- 'Stage-Alpha'
summary: 'Ad-hoc interface to Message Archive Management Settings'
...

Introduction
============

This module complements mod\_mam by allowing clients to change archiving
preferences through an Ad-hoc command.

Details
=======

When enabled, an "Archive Settings" command should appear in the list of
Ad-hoc commands available. This allows the user to change default policy
(always, never, roster) and which JIDs to always store or never store.

Usage
=====

First copy the module to the prosody plugins directory.

Then add "mam\_adhoc" to your modules\_enabled list:

``` {.lua}
modules_enabled = {
  -- ...
    "mam",
  "mam_adhoc",
  -- ...
}
```