koa2-session-redis

Middleware for Koa2 to get/set session use with Redis stores

Use native ES6(async/await) by Nodejs v7.x, use --harmony option.

Or you can use the old versions:

• babel
• node6

Require

node v7.x +

Install

npm install koa2-session2-redis

Usage

1const Koa = require("koa");
2const session = require("koa2-session2-redis");
3
4const app = new Koa();
5
6app.use(session({
7  key: 'koa:sess',
8  maxAge: 100000,
9  overwrite: true,
10  httpOnly: true,
11  signed: true,
12  resave: true,    //resave every request
13  redisCofig: {
14      port: 6379,
15      host: '127.0.0.1',
16      db: 3,
17      family: 4,
18      password: '',
19      options: {
20          return_buffers: false,
21          auth_pass: ''
22      }
23  }
24}))

Options

Most options based on cookies

• key: a string for store session id in cookie

• maxAge: a number representing the milliseconds from Date.now() for expiry

• expires: a Date object indicating the cookie's expiration date (expires at the end of session by default).

• path: a string indicating the path of the cookie (/ by default).

• domain: a string indicating the domain of the cookie (no default).

• secure: a boolean indicating whether the cookie is only to be sent over HTTPS (false by default for HTTP, true by default for HTTPS).

• httpOnly: a boolean indicating whether the cookie is only to be sent over HTTP(S), and not made available to client JavaScript (true by default).

• signed: a boolean indicating whether the cookie is to be signed (false by default). If this is true, another cookie of the same name with the .sig suffix appended will also be sent, with a 27-byte url-safe base64 SHA1 value representing the hash of cookie-name=cookie-value against the first Keygrip key. This signature key is used to detect tampering the next time a cookie is received.

• overwrite: a boolean indicating whether to overwrite previously set cookies of the same name (false by default). If this is true, all cookies set during the same request with the same name (regardless of path or domain) are filtered out of the Set-Cookie header when setting this cookie.

• resave: refresh session id & session expires every request

License

MIT