node package manager


Koa redis session middleware


Redis store-based session middleware for Koa.

Based on koa-session

$ npm install koa-session-redis

Set your redis connection configuration in

example (using redis without specific configuration)

var session = require('koa-session-redis');
var koa = require('koa');
var app = koa();
app.keys = ['some secret hurr'];
    store: {
      host: process.env.SESSION_PORT_6379_TCP_ADDR || '',
      port: process.env.SESSION_PORT_6379_TCP_PORT || 6379,
      ttl: 3600,
app.use(function *(){
  var n = this.session.views || 0;
  this.session.views = ++n;
  this.body = n + ' views';
console.log('listening on port 3000');

This module provides "guest" sessions, meaning any visitor will have a session, authenticated or not. If a session is new a Set-Cookie will be produced regardless of populating the session.

The cookies opts is set by cookie object, simply passed to cookie module. And the rest is same with koa-session;

The cookie name is controlled by the key option, which defaults to "koa:sess". All other options are passed to ctx.cookies.get() and ctx.cookies.set() allowing you to control security, domain, path, and signing among other settings.

Returns true if the session is new.

To destroy a session simply set it to null:

this.session = null;