annotate mod_storage_mongodb.wiki @ 340:ecf8bfe998ec

Add documentation on DAY, TIME, RATE and LIMIT firewall conditions
author MWild1@gmail.com
date Sat, 06 Apr 2013 23:28:14 +0000
parents 2890500db303
children 469bcbdfe281
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
2890500db303 Rename wiki page for mod_storage_mongo from mondo
james@chatid.com
parents:
diff changeset
2
2890500db303 Rename wiki page for mod_storage_mongo from mondo
james@chatid.com
parents:
diff changeset
3 = Introduction =
2890500db303 Rename wiki page for mod_storage_mongo from mondo
james@chatid.com
parents:
diff changeset
4
2890500db303 Rename wiki page for mod_storage_mongo from mondo
james@chatid.com
parents:
diff changeset
5 This is a storage backend that uses MongoDB.
2890500db303 Rename wiki page for mod_storage_mongo from mondo
james@chatid.com
parents:
diff changeset
6 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
7
2890500db303 Rename wiki page for mod_storage_mongo from mondo
james@chatid.com
parents:
diff changeset
8 = Configuration =
2890500db303 Rename wiki page for mod_storage_mongo from mondo
james@chatid.com
parents:
diff changeset
9
2890500db303 Rename wiki page for mod_storage_mongo from mondo
james@chatid.com
parents:
diff changeset
10 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
11
2890500db303 Rename wiki page for mod_storage_mongo from mondo
james@chatid.com
parents:
diff changeset
12 In Prosody's configuration file, set:
2890500db303 Rename wiki page for mod_storage_mongo from mondo
james@chatid.com
parents:
diff changeset
13 {{{
2890500db303 Rename wiki page for mod_storage_mongo from mondo
james@chatid.com
parents:
diff changeset
14 storage = "mongodb"
2890500db303 Rename wiki page for mod_storage_mongo from mondo
james@chatid.com
parents:
diff changeset
15 }}}
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 MongoDB options are:
2890500db303 Rename wiki page for mod_storage_mongo from mondo
james@chatid.com
parents:
diff changeset
18 || *Name* || *Description* ||
2890500db303 Rename wiki page for mod_storage_mongo from mondo
james@chatid.com
parents:
diff changeset
19 || server || hostname:port ||
2890500db303 Rename wiki page for mod_storage_mongo from mondo
james@chatid.com
parents:
diff changeset
20 || dbname || the database to use ||
2890500db303 Rename wiki page for mod_storage_mongo from mondo
james@chatid.com
parents:
diff changeset
21 || username || your username for the given database ||
2890500db303 Rename wiki page for mod_storage_mongo from mondo
james@chatid.com
parents:
diff changeset
22 || 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
23 || 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
24
2890500db303 Rename wiki page for mod_storage_mongo from mondo
james@chatid.com
parents:
diff changeset
25 = Compatibility =
2890500db303 Rename wiki page for mod_storage_mongo from mondo
james@chatid.com
parents:
diff changeset
26
2890500db303 Rename wiki page for mod_storage_mongo from mondo
james@chatid.com
parents:
diff changeset
27 || trunk || Untested, but should work ||