@eggjs/session-redis

A session extension for store session in redis.

Install

1npm i @eggjs/session-redis @eggjs/redis

Usage

This module dependent on @eggjs/redis plugin, so we must enable both.

1// {app_root}/config/plugin.js
2exports.sessionRedis = {
3  enable: true,
4  package: '@eggjs/session-redis',
5};
6
7exports.redis = {
8  enable: true,
9  package: '@eggjs/redis',
10};

Configuration

If we only have one redis instance:

1// {app_root}/config/config.default.js
2exports.redis = {
3  client: {
4    host: 'your redis host',
5    port: 'your redis port',
6    password: '',
7    db: '0',
8  },
9  agent:true
10};
11// no need to set any sessionRedis config

If we have more than one redis instance, we need to configure which instance to be used as session store.

1// {app_root}/config/config.default.js
2
3exports.redis = {
4  clients: {
5    session: { /* config */ },
6    cache: { /* config */ },
7  },
8};
9
10exports.sessionRedis = {
11  name: 'session', // specific instance `session` as the session store
12};

Questions & Suggestions

Please open an issue here.

License

MIT

Contributors

Made with contributors-img.