view mod_mam_adhoc/README.markdown @ 2029:3e00cd4a02bc

mod_component_client: Pass a non-zero exit code on shutdown due to lost connection `prosody.shutdown` takes a code as of https://hg.prosody.im/0.10/rev/a22d6a46d2ed
author daurnimator <quae@daurnimator.com>
date Wed, 20 Jan 2016 13:10:50 +1100
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",
  -- ...
}
```