connect-redis is a Redis session store backed by node_redis, and is insanely fast :). Requires redis >= 2.0.0
for the SETEX command.
Note: connect-redis
>= 2.0.0
only supports express>= 4.0.0
. Use connect-redis1.4.7
for express 3.x.
$ npm install connect-redis
A Redis client is required. An existing client can be passed directly using the client
param or created for you using the host
, port
, or socket
params.
client
An existing client created usingredis.createClient()
host
Redis server hostnameport
Redis server portnosocket
Redis server unix_socket
The following additional params may be included:
ttl
Redis session TTL (expiration) in secondsdb
Database index to usepass
Password for Redis authenticationprefix
Key prefix defaulting to "sess:"unref
Settrue
to unref the Redis client. Warning: this is an experimental feature.
Any options not included in this list will be passed to the redis createClient()
method directly.
Due to express >= 4
changes, we now need to pass express-session
to the function connect-redis
exports in order to extend session.Store
:
var session = require('express-session');
var RedisStore = require('connect-redis')(session);
app.use(session({
store: new RedisStore(options),
secret: 'keyboard cat'
}));
MIT