Mercurial > prosody-modules
diff mod_storage_xmlarchive/README.markdown @ 1940:453eee191e18
mod_storage_xmlarchive/README: Add example configuration
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Wed, 28 Oct 2015 16:16:59 +0100 |
parents | 4d73a1a6ba68 |
children | e63dba236a2a |
line wrap: on
line diff
--- a/mod_storage_xmlarchive/README.markdown Wed Oct 28 15:08:19 2015 +0100 +++ b/mod_storage_xmlarchive/README.markdown Wed Oct 28 16:16:59 2015 +0100 @@ -12,18 +12,36 @@ This module implements stanza archives using files, similar to the default "internal" storage. -Details -======= +Configuration +============= + +To use this with [mod\_mam] add this to your config: + +``` lua +storage = { + archive2 = "xmlarchive" +} +``` + +To use it with [mod\_mam\_muc] or [mod_http_muc_log]: + +``` lua +storage = { + muc_log = "xmlarchive" +} +``` Refer to [Prosodys data storage -documentation](https://prosody.im/doc/storage). +documentation](https://prosody.im/doc/storage) for more information. Note that this module does not implement the "keyval" storage method and -can't be used by anything other than archives, eg MAM and MUC logs. +can't be used by anything other than archives. Compatibility ============= - --------- ------------- - \>=0.10 Should work - --------- ------------- + ------ --------------- + 0.10 Works + 0.9 Maybe + 0.8 Does not work + ------ ---------------