Diff

mod_storage_mongodb/README.wiki @ 1782:29f3d6b7ad16

Import wiki pages
author Kim Alvefur <zash@zash.se>
date Mon, 24 Aug 2015 16:43:56 +0200
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_storage_mongodb/README.wiki	Mon Aug 24 16:43:56 2015 +0200
@@ -0,0 +1,30 @@
+#summary MongoDB Storage Module
+#labels Type-Storage,Stage-Alpha
+
+= Introduction =
+
+This is a storage backend that uses MongoDB.
+Depends on [https://github.com/mwild1/luamongo luamongo bindings]
+
+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.
+
+= Configuration =
+
+Copy the module to the prosody modules/plugins directory.
+
+In Prosody's configuration file, set:
+{{{
+    storage = "mongodb"
+}}}
+
+MongoDB options are:
+|| *Name*    || *Description*                                                     ||
+|| server    || hostname:port                                                     ||
+|| dbname    || the database to use                                               ||
+|| username  || your username for the given database                              ||
+|| password  || your password for the given database (either raw or pre-digested) ||
+|| is_digest || whether the password field has been pre-digested                  ||
+
+= Compatibility =
+
+|| trunk || Untested, but should work ||
\ No newline at end of file