annotate mod_storage_mongodb.wiki @ 491:e15448188d05

Update with current behaviour and options
author Kim Alvefur <zash@zash.se>
date Fri, 14 Nov 2014 17:41:54 +0100
parents b70f4ca106d5
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
245
2890500db303 Rename wiki page for mod_storage_mongo from mondo
james@chatid.com
parents:
diff changeset
1 #summary MongoDB Storage Module
484
b70f4ca106d5 Edited wiki page mod_storage_mongodb through web user interface.
MWild1@gmail.com
parents: 382
diff changeset
2 #labels Type-Storage,Stage-Alpha
245
2890500db303 Rename wiki page for mod_storage_mongo from mondo
james@chatid.com
parents:
diff changeset
3
2890500db303 Rename wiki page for mod_storage_mongo from mondo
james@chatid.com
parents:
diff changeset
4 = Introduction =
2890500db303 Rename wiki page for mod_storage_mongo from mondo
james@chatid.com
parents:
diff changeset
5
2890500db303 Rename wiki page for mod_storage_mongo from mondo
james@chatid.com
parents:
diff changeset
6 This is a storage backend that uses MongoDB.
2890500db303 Rename wiki page for mod_storage_mongo from mondo
james@chatid.com
parents:
diff changeset
7 Depends on [https://github.com/mwild1/luamongo luamongo bindings]
2890500db303 Rename wiki page for mod_storage_mongo from mondo
james@chatid.com
parents:
diff changeset
8
484
b70f4ca106d5 Edited wiki page mod_storage_mongodb through web user interface.
MWild1@gmail.com
parents: 382
diff changeset
9 This module is not under active development and has a number of issues related to limitations in MongoDB. It is not suitable for production use.
b70f4ca106d5 Edited wiki page mod_storage_mongodb through web user interface.
MWild1@gmail.com
parents: 382
diff changeset
10
245
2890500db303 Rename wiki page for mod_storage_mongo from mondo
james@chatid.com
parents:
diff changeset
11 = Configuration =
2890500db303 Rename wiki page for mod_storage_mongo from mondo
james@chatid.com
parents:
diff changeset
12
2890500db303 Rename wiki page for mod_storage_mongo from mondo
james@chatid.com
parents:
diff changeset
13 Copy the module to the prosody modules/plugins directory.
2890500db303 Rename wiki page for mod_storage_mongo from mondo
james@chatid.com
parents:
diff changeset
14
2890500db303 Rename wiki page for mod_storage_mongo from mondo
james@chatid.com
parents:
diff changeset
15 In Prosody's configuration file, set:
2890500db303 Rename wiki page for mod_storage_mongo from mondo
james@chatid.com
parents:
diff changeset
16 {{{
2890500db303 Rename wiki page for mod_storage_mongo from mondo
james@chatid.com
parents:
diff changeset
17 storage = "mongodb"
2890500db303 Rename wiki page for mod_storage_mongo from mondo
james@chatid.com
parents:
diff changeset
18 }}}
2890500db303 Rename wiki page for mod_storage_mongo from mondo
james@chatid.com
parents:
diff changeset
19
2890500db303 Rename wiki page for mod_storage_mongo from mondo
james@chatid.com
parents:
diff changeset
20 MongoDB options are:
2890500db303 Rename wiki page for mod_storage_mongo from mondo
james@chatid.com
parents:
diff changeset
21 || *Name* || *Description* ||
2890500db303 Rename wiki page for mod_storage_mongo from mondo
james@chatid.com
parents:
diff changeset
22 || server || hostname:port ||
2890500db303 Rename wiki page for mod_storage_mongo from mondo
james@chatid.com
parents:
diff changeset
23 || dbname || the database to use ||
2890500db303 Rename wiki page for mod_storage_mongo from mondo
james@chatid.com
parents:
diff changeset
24 || username || your username for the given database ||
2890500db303 Rename wiki page for mod_storage_mongo from mondo
james@chatid.com
parents:
diff changeset
25 || password || your password for the given database (either raw or pre-digested) ||
2890500db303 Rename wiki page for mod_storage_mongo from mondo
james@chatid.com
parents:
diff changeset
26 || is_digest || whether the password field has been pre-digested ||
2890500db303 Rename wiki page for mod_storage_mongo from mondo
james@chatid.com
parents:
diff changeset
27
2890500db303 Rename wiki page for mod_storage_mongo from mondo
james@chatid.com
parents:
diff changeset
28 = Compatibility =
2890500db303 Rename wiki page for mod_storage_mongo from mondo
james@chatid.com
parents:
diff changeset
29
484
b70f4ca106d5 Edited wiki page mod_storage_mongodb through web user interface.
MWild1@gmail.com
parents: 382
diff changeset
30 || trunk || Untested, but should work ||