README
socket.io-redis
How to use
var io = require('socket.io')(3000);
var redis = require('socket.io-redis');
io.adapter(redis({ host: 'localhost', port: 6379 }));
By running socket.io with the socket.io-redis
adapter you can run
multiple socket.io instances in different processes or servers that can
all broadcast and emit events to and from each other.
If you need to emit events to socket.io instances from a non-socket.io process, you should use socket.io-emitter.
API
adapter(uri[, opts])
uri
is a string like localhost:6379
where your redis server
is located. For a list of options see below.
adapter(opts)
The following options are allowed:
key
: the name of the key to pub/sub events on as prefix (socket.io
)host
: host to connect to redis on (localhost
)port
: port to connect to redis on (6379
)socket
: unix domain socket to connect to redis ("/tmp/redis.sock"
). Will be used instead of the host and port options if specified.pubClient
: optional, the redis client to publish events onsubClient
: optional, the redis client to subscribe to events on
If you decide to supply pubClient
and subClient
, make sure you use
node_redis as a client or one
with an equivalent API.
If you supply clients, make sure you initialized them with
the return_buffers
option set to true
.
Adapter with password
If you need to create a redisAdapter to a redis instance that has a password, use pub/sub options.
Example:
var pub = redis.createClient(port, host, {auth_pass:"PASSWORD"});
var sub = redis.createClient(port, host, {detect_buffers: true, auth_pass:"PASSWORD"} );
io.adapter( redisAdapter({pubClient: pub, subClient: sub}) );
License
MIT