koa-session-mongo

MongoDB storage layer for Koa session middleware

npm install koa-session-mongo
1 downloads in the last day
11 downloads in the last week
45 downloads in the last month

koa-session-mongo

Build Status NPM module

MongoDB storage layer for Koa session middleware. Based on connect-mongo.

Installation

npm install koa-session-mongo

Usage

var session = require('koa-session-store');
var mongoStore = require('koa-session-mongo');
var koa = require('koa');

var app = koa();

app.keys = ['some secret key'];  // needed for cookie-signing

app.use(session({
  store: mongoStore.create({
    db: 'database_name'
  })
}));

app.use(function *(){
    var n = this.session.views || 0;
    this.session.views = ++n;
    this.body = n + ' views';
});

app.listen(3000);
console.log('listening on port 3000');

If you wish to specify host, port, etc:

mongoStore.create({
  host: 'mongo.hostname.com',
  port: 48473,
  db: 'database_name',
  username: 'admin',
  password: 'password',
})

Or you can pass in connection parameters as a URL string:

mongoStore.create({
  url: 'mongodb://user:pass@host:port/database_name/collection_name'
})

Or you can use an existing node-mongo-native db object:

var mongo = require('mongodb');

var db = new mongo.Db("database_name", new mongo.Server('host', port, {}), { w: 1 });

mongoStore.create({
  db: dbConn,
  collection: 'sessions',
  username: 'admin',
  password: 'password'
})

Or you can use an existing Mongoose connection:

var mongoose = require('mongoose');

mongoose.connect(...);

var store = mongoStore.create({
  mongoose: mongoose.connection
})

Options

The following configuration options are available for the create() call:

  • db String or Object - db name or instantiated node-mongo-native db object.
  • collection String - collection name. Default is sessions.
  • host String server hostname. Default is 127.0.0.1.
  • port Number - server port. Default is 27017.
  • username String - username. Default is null.
  • password String - password. Default is null.
  • auto_reconnect Boolean - gets passed to the node-mongo-native constructor as the same option. Default is false.
  • ssl Boolean - use ssl to connect to the server. Default is false.
  • expirationTime Number - time-to-live (TTL) in seconds for any given session data - MongoDB will auto-delete data which hasn't been updated for this amount of time. Default is 2 weeks.
  • url String - connection URL of the form mongodb://user:pass@host:port/database/collection. If provided then this will take precedence over other options except mongoose.
  • mongoose Object - a Mongoose connection, use** mongoose.connection to get the connection out of an existing Mongoose object. If provided then this will take precedence over other options.

Cleaning up

You can close all connections made through the storage layer using:

var Promise = require('bluebird');
var mongoStore = require('koa-session-mongo');

...

Promise.spawn(function() {
  mongoStore.closeConnections();
});

License

Copyright (c) 2013 Ramesh Nair

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

npm loves you