search

kongo2002 / ejabberd-mod-mam

Message Archive Management (XEP-0313) for ejabberd using a MongoDB backend
23 stars 10 forks source link

readme

ejabberd-mod-mam

ejabberd-mod-mam is a module for the ejabberd XMPP server that implements the "Message Archive Management" functionality XEP-0313 using a MongoDB backend.

The module targets the so-called "Community Edition" of ejabberd that can be found on the current master branch of the ejabberd repository on github.

ejabberd-mod-mam is a work in progress and currently to be considered beta

XEP-0313

I recently noticed that the XEP-0313 was updated to Version 3 that basically changed all of the query and result syntax. As of now this module still targets the Version 2 of the XEP-0313.

Requirements

Since the MongoDB erlang driver changed the maintainer and received various API changes while reducing some of its features (i.e. support for replica sets) this module still uses the old version of the MongoDB driver meaning the commit tagged with v0.3.1.

Install

In order to get going basically all you have to do is to add the MongoDB erlang driver to the ejabberd rebar script. Then you copy/link the mod_mam.erl into the src directory of ejabberd prior to compiling ejabberd itself.

Otherwise you may use my mod_mam branch of the forked official ejabberd master branch. This branch is obviously not always in-sync with the current ejabberd development but my changes may be sufficient to give an idea how to add mod_mam to your ejabberd compile process:

$ git clone git://github.com/kongo2002/ejabberd.git
$ cd ejabberd
$ git checkout origin/mod_mam -b mod_mam
$ ./configure --enable-mongodb
$ make

Configuration

In order to use mod-mam you have to add it to the modules section in your ejabberd.cfg. This could look like this:

{modules,
  [
    {mod_mam,
      [
        % use the default localhost:27017
        % or define a specific host
        {mongo, {localhost, 27017}},

        % define a database to use
        % (default: test)
        {mongo_database, test},

        % specify a collection to use
        % (default: ejabberd_mam)
        {mongo_collection, ejabberd_mam}
      ]
    },

    % ...
  ]
}.

Using the new YAML format the same configuration would look like the following:

modules:
  mod_mam:
    mongo:
      localhost: 27017
    mongo_database: test
    mongo_collection: messages

Replica sets

You may use MongoDB replica set connections as well:

{modules,
  [
    {mod_mam,
      [
        % configure a named replica set and a list of nodes
        {mongo, {<<"rs">>, [{localhost, 27017}, {localhost, 27018}]}},

        % ...
      ]
    },

    % ...
  ]
}.

The YAML equivalent looks like this:

modules:
  mod_mam:
    mongo:
      "rs":
        localhost: 27017
        localhost: 27018

MongoDB

The messages that are stored as BSON documents in the MongoDB look like the following:

{
    "_id" : ObjectId("531f6f25cdbb08145f000001"),
    "u" : "test2",
    "s" : "localhost",
    "j" : {
        "u" : "test",
        "s" : "localhost",
        "r" : "sendxmpp"
    },
    "b" : "foo bar",
    "d" : "to",
    "ts" : ISODate("2014-03-11T20:16:37.772Z"),
    "r" : "<message xml:lang='en' to='test@localhost/sendxmpp' type='chat'><body>foo bar</body><subject/></message>"
}

TODO

Maintainer

ejabberd-mod-mam is written by Gregor Uhlenheuer. You can reach me at kongo2002@gmail.com.