# hubot-redis-brain

> A hubot script to persist hubot's brain using redis

Latest version **3.0.1** (published 2023-11-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install hubot-redis-brain
pnpm add hubot-redis-brain
yarn add hubot-redis-brain
bun add hubot-redis-brain
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: no vulnerabilities; high maintenance score.

Warnings: low downloads; no types; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 3.0.1 |
| Published | 2023-11-13 |
| First published | 2014-10-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 18 |
| Dependencies | 1 |
| Unpacked size | 16 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 70 |
| Author | Josh Nichols |
| Maintainers | technicalpickles, michaelansel, hubotbot |
| Keywords | hubot, hubot-scripts |

## Links

- npm: https://www.npmjs.com/package/hubot-redis-brain
- Repository: https://github.com/hubotio/hubot-redis-brain
- Homepage: https://github.com/hubotio/hubot-redis-brain#readme
- Issues: https://github.com/hubotio/hubot-redis-brain/issues
- npm.io page: https://npm.io/package/hubot-redis-brain

## Dependencies (1)

- [redis](https://npm.io/package/redis.md) ^4.6.10

## Recent versions

- 3.0.1 (latest) — 2023-11-13
- 1.1.3 (next) — 2023-07-23
- 3.0.0 — 2023-11-13
- 2.1.0 — 2023-10-20
- 2.0.0 — 2023-07-24
- 1.1.6 — 2023-07-23
- 1.1.5 — 2023-07-23
- 1.1.4 — 2023-07-23
- 1.1.2 — 2023-07-23
- 1.1.1 — 2023-07-13
- 1.1.0 — 2023-05-22
- 1.0.0 — 2017-06-29
- 0.0.4 — 2017-06-27
- 0.0.3 — 2015-06-06
- 0.0.2 — 2014-10-18

## README

![Build Status](https://github.com/hubotio/hubot-redis-brain/actions/workflows/pipeline.yml/badge.svg)

![E2E Tests](https://github.com/hubotio/hubot-redis-brain/actions/workflows/e2e.yml/badge.svg)

# hubot-redis-brain

A hubot script to persist hubot's brain using redis

See [`src/RedisBrain.js`](src/RedisBrain.js) for full documentation.

## Installation

In hubot project repo, run:

`npm install hubot-redis-brain --save`

Then add **hubot-redis-brain** to your `external-scripts.json`:

```json
[
  "hubot-redis-brain"
]
```

## Configuration

hubot-redis-brain requires a redis server to work. It uses the `REDIS_URL` environment variable for determining
where to connect to. The default is on localhost, port 6379 (ie the redis default).

The following attributes can be set using the `REDIS_URL`

* authentication
* hostname
* port
* key prefix

For example, `export REDIS_URL=redis://:password@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.

For a UNIX domain socket, `export REDIS_URL=redis://:password@/var/run/redis.sock?prefix` would authenticate with `password`, connecting to `/var/run/redis.sock`, and store data using the `prefix:storage` key.

### Installing your own

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

### Boxen

If you are using [boxen](https://boxen.github.com/) to manage your environment,
hubot-redis-brain will automatically use the boxen-managed redis (ie by using `BOXEN_REDIS_URL`).

### Heroku

If you are deploying on [Heroku](https://www.heroku.com/), you can add the
Redis Cloud or Redis To Go addon to have automatically configure itself to use it:

* [Redis Cloud](https://addons.heroku.com/rediscloud)
* [Redis To Go](https://addons.heroku.com/redistogo)


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)

### Redis Twemproxy

If you are using [Twemproxy](https://github.com/twitter/twemproxy) to cluster redis,
you need to turn off the redis ready check which uses the unsupported INFO cmd.

`REDIS_NO_CHECK = 1`

---
_Source: https://npm.io/package/hubot-redis-brain · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
