mod_storage_mongodb/README.markdown
changeset 1807 4d73a1a6ba68
parent 1786 29f3d6b7ad16
child 1824 8de50be756e5
equal deleted inserted replaced
1806:0ab737feada6 1807:4d73a1a6ba68
       
     1 ---
       
     2 labels:
       
     3 - 'Type-Storage'
       
     4 - 'Stage-Alpha'
       
     5 summary: MongoDB Storage Module
       
     6 ...
       
     7 
       
     8 Introduction
       
     9 ============
       
    10 
       
    11 This is a storage backend that uses MongoDB. Depends on [luamongo
       
    12 bindings](https://github.com/mwild1/luamongo)
       
    13 
       
    14 This module is not under active development and has a number of issues
       
    15 related to limitations in MongoDB. It is not suitable for production
       
    16 use.
       
    17 
       
    18 Configuration
       
    19 =============
       
    20 
       
    21 Copy the module to the prosody modules/plugins directory.
       
    22 
       
    23 In Prosody's configuration file, set:
       
    24 
       
    25         storage = "mongodb"
       
    26 
       
    27 MongoDB options are:
       
    28 
       
    29   Name         Description
       
    30   ------------ -------------------------------------------------------------------
       
    31   server       hostname:port
       
    32   username     your username for the given database
       
    33   password     your password for the given database (either raw or pre-digested)
       
    34   is\_digest   whether the password field has been pre-digested
       
    35 
       
    36 Compatibility
       
    37 =============
       
    38 
       
    39   ------- ---------------------------
       
    40   trunk   Untested, but should work
       
    41   ------- ---------------------------