mod_mam_archive/README.markdown

   1 ---
   2 labels:
   3 - 'Stage-Alpha'
   4 summary: 'XEP-0136: Message Archiving frontend for mod\_mam'
   5 ...
   6
   7 Introduction
   8 ============
   9
  10 Implementation of [XEP-0136: Message
  11 Archiving](http://xmpp.org/extensions/xep-0136.html) for
  12 [mod\_mam](mod_mam.html).
  13
  14 Details
  15 =======
  16
  17 See [mod\_mam] for details.
  18
  19 Usage
  20 =====
  21
  22 First configure mod\_mam as specified in it's [wiki][mod\_mam]. Make
  23 sure it uses sql2 storage backend.
  24
  25 Then add "mam\_archive" to your modules\_enabled list:
  26
  27         modules_enabled = {
  28             -- ...
  29             "mam_archive",
  30             -- ...
  31         }
  32
  33 Configuration
  34 =============
  35
  36 Because of the fact that [XEP-0136] defines a 'conversation' concept not
  37 present in [XEP-0313], we have to assume some periods of chat history as
  38 'conversations'.
  39
  40 Conversation interval defaults to one day, to provide for a convenient
  41 usage.
  42
  43     archive_conversation_interval = 86400; -- defined in seconds. One day by default
  44
  45 That is the only reason SQL database is required as well.
  46
  47 Compatibility
  48 =============
  49
  50   ------ ---------------
  51   0.10   Works
  52   0.9    Does not work
  53   ------ ---------------
  54
  55   ------------ ------------
  56   PostgreSQL   Tested
  57   MySQL        Not tested
  58   SQLite       Tested
  59   ------------ ------------