README

socket.io-adapter-mongo

*This module is modified from socket.io-redis

How to use

var io = require('socket.io')(3000);
var mongo = require('socket.io-adapter-mongo');
io.adapter(mongo({ host: 'localhost', port: 27017, db: 'mubsub' }));

By running socket.io with the socket.io-adapter-mongo adapter you can run multiple socket.io instances in different processes or servers that can all broadcast and emit events to and from each other.

API

adapter(uri[, opts])

uri is a string that matches a mongodb connection string

mongodb://localhost:27017
mongodb://user:pass@localhost:27017/test
localhost:27017

adapter(opts)

The following options are allowed:

key: the name of the key to pub/sub events on as prefix (socket.io)
host: host to connect to mongo on (localhost) OR an array of host and port ["10.0.15.120:27017","10.0.15.121:27017"]
port: port to connect to mongo on (27017). Not used if host is an array
db: db to use in mongo (mubsub)
username: username to connect to mongo with
password: password to connect to mongo with
socket: unix domain socket to connect to mongo ("/tmp/mongo.sock"). Will be used instead of the host and port options if specified.
client: optional, the mubsub client to publish events on
additionalOptions: optional, object with additional options such as replicaSet

Replica Set Example Usage

{
    host: ["10.0.15.120:27017","10.0.15.121:27017"],
    additionalOptions: {
        replicaSet: "rs0"
    }
}

If you decide to supply a client, make sure you use mubsub as a client or one with an equivalent API.

License

MIT

socket.io-adapter-mongo-replica

Usage no npm install needed!