A hubot script to persist hubot's brain using redis
See src/redis-brain.coffee for full documentation.
In hubot project repo, run:
npm install hubot-redis-brain --save
Then add hubot-redis-brain to your external-scripts.json:
[
"hubot-redis-brain"
]hubot-redis-brain requires a redis server to work.
It can be set up with REDIS_URL or REDIS_PARAMS for more options.
When you use REDIS_PARAMS, all the options in redis.createClient are available.
(i.e. UNIX sockets and a specific DB can be used).
Ex:
REDIS_PARAMS='{"createClient":{"path":"/tmp/redis.sock"},"db":2}'connect to the unix socket/tmp/redis.sockandd use DB 2 in redis.REDIS_PARAMS='{"createClient":{"host":"myredis.example.com","port":"16370","auth_pass":"123"},"prefix":"that-bot"}'connect to myredis.example.com:16370 authenticating with password "123" and store inthat-bot:storage
When you use REDIS_URL, the following attributes can be set:
- authentication
- hostname
- port
- key prefix
For example, export REDIS_URL=redis://passwd@192.168.0.1:16379/prefix would
authenticate with password, connecting to 192.168.0.1 on port 16379, and store
data using the prefix:storage key.
The default is on localhost, port 6379 (i.e. the redis default).
If you need to install and run your own, most package managers have a package for redis:
- Mac OS X with homebrew:
brew install redis - Ubuntu/Debian with apt:
apt-get install redis-server - Compile from source: http://redis.io/topics/quickstart
If you are using boxen to manage your environment,
hubot-redis-brain will automatically use the boxen-managed redis (ie by using BOXEN_REDIS_URL).
If you are deploying on Heroku, you can add the Redis Cloud or Redis To Go addon to have automatically configure itself to use it:
Other redis addons would need to be configured using REDIS_URL until support
is added to hubot-redis-brain (or hubot-redis-brain needs to be updated to look
for the environment variable the service uses)