annotate mod_storage_mondodb.wiki @ 243:b13c6033377c

Created mod_storage_mondodb wiki page.
author james@chatid.com
date Mon, 12 Dec 2011 10:48:07 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
243
b13c6033377c Created mod_storage_mondodb wiki page.
james@chatid.com
parents:
diff changeset
1 #summary MondoDB Storage Module
b13c6033377c Created mod_storage_mondodb wiki page.
james@chatid.com
parents:
diff changeset
2 #labels storage
b13c6033377c Created mod_storage_mondodb wiki page.
james@chatid.com
parents:
diff changeset
3
b13c6033377c Created mod_storage_mondodb wiki page.
james@chatid.com
parents:
diff changeset
4 = Introduction =
b13c6033377c Created mod_storage_mondodb wiki page.
james@chatid.com
parents:
diff changeset
5
b13c6033377c Created mod_storage_mondodb wiki page.
james@chatid.com
parents:
diff changeset
6 This is a storage backend that uses MongoDB.
b13c6033377c Created mod_storage_mondodb wiki page.
james@chatid.com
parents:
diff changeset
7 Depends on [https://github.com/mwild1/luamongo luamongo bindings]
b13c6033377c Created mod_storage_mondodb wiki page.
james@chatid.com
parents:
diff changeset
8
b13c6033377c Created mod_storage_mondodb wiki page.
james@chatid.com
parents:
diff changeset
9 = Configuration =
b13c6033377c Created mod_storage_mondodb wiki page.
james@chatid.com
parents:
diff changeset
10
b13c6033377c Created mod_storage_mondodb wiki page.
james@chatid.com
parents:
diff changeset
11 Copy the module to the prosody modules/plugins directory.
b13c6033377c Created mod_storage_mondodb wiki page.
james@chatid.com
parents:
diff changeset
12
b13c6033377c Created mod_storage_mondodb wiki page.
james@chatid.com
parents:
diff changeset
13 In Prosody's configuration file, set:
b13c6033377c Created mod_storage_mondodb wiki page.
james@chatid.com
parents:
diff changeset
14 {{{
b13c6033377c Created mod_storage_mondodb wiki page.
james@chatid.com
parents:
diff changeset
15 storage = "mongodb"
b13c6033377c Created mod_storage_mondodb wiki page.
james@chatid.com
parents:
diff changeset
16 }}}
b13c6033377c Created mod_storage_mondodb wiki page.
james@chatid.com
parents:
diff changeset
17
b13c6033377c Created mod_storage_mondodb wiki page.
james@chatid.com
parents:
diff changeset
18 MongoDB options are:
b13c6033377c Created mod_storage_mondodb wiki page.
james@chatid.com
parents:
diff changeset
19 || *Name* || *Description* ||
b13c6033377c Created mod_storage_mondodb wiki page.
james@chatid.com
parents:
diff changeset
20 || server || hostname:port ||
b13c6033377c Created mod_storage_mondodb wiki page.
james@chatid.com
parents:
diff changeset
21 || dbname || the database to use ||
b13c6033377c Created mod_storage_mondodb wiki page.
james@chatid.com
parents:
diff changeset
22 || username || your username for the given database ||
b13c6033377c Created mod_storage_mondodb wiki page.
james@chatid.com
parents:
diff changeset
23 || password || your password for the given database (either raw or pre-digested) ||
b13c6033377c Created mod_storage_mondodb wiki page.
james@chatid.com
parents:
diff changeset
24 || is_digest || whether the password field has been pre-digested ||
b13c6033377c Created mod_storage_mondodb wiki page.
james@chatid.com
parents:
diff changeset
25
b13c6033377c Created mod_storage_mondodb wiki page.
james@chatid.com
parents:
diff changeset
26 = Compatibility =
b13c6033377c Created mod_storage_mondodb wiki page.
james@chatid.com
parents:
diff changeset
27
b13c6033377c Created mod_storage_mondodb wiki page.
james@chatid.com
parents:
diff changeset
28 || trunk || Untested, but should work ||