# @awearsolutions/redis-commander

> Redis web-based management tool written in node.js

Latest version **0.4.5-rc.8** (published 2018-06-16) · 0 weekly downloads

## Install

```sh
npm install @awearsolutions/redis-commander
pnpm add @awearsolutions/redis-commander
yarn add @awearsolutions/redis-commander
bun add @awearsolutions/redis-commander
```

Provides the command `redis-commander`.

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; low quality score; pre 1.0.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.4.5-rc.8 |
| Published | 2018-06-16 |
| First published | 2018-01-09 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=6.0 |
| Dependencies | 17 |
| Unpacked size | 1.5 MB |
| Known vulnerabilities | 0 (+15 in 5 direct dependencies) |
| Install scripts | no |
| GitHub stars | 4002 |
| Author | Joe Ferner |
| Maintainers | ozomer |
| Keywords | redis, redis-client, redis-gui, redis-node |

## Links

- npm: https://www.npmjs.com/package/@awearsolutions/redis-commander
- Repository: https://github.com/joeferner/redis-commander
- Homepage: https://github.com/joeferner/redis-commander#readme
- Issues: https://github.com/joeferner/redis-commander/issues
- npm.io page: https://npm.io/package/@awearsolutions/redis-commander

## Dependencies (17)

- [sf](https://npm.io/package/sf.md) 0.1.9
- [ejs](https://npm.io/package/ejs.md) 0.8.8
- [async](https://npm.io/package/async.md) 0.1.22
- [bcrypt](https://npm.io/package/bcrypt.md) 2.0.1
- [express](https://npm.io/package/express.md) 3.x.x
- [ioredis](https://npm.io/package/ioredis.md) 1.15.1
- [bcryptjs](https://npm.io/package/bcryptjs.md) 2.4.3
- [optimist](https://npm.io/package/optimist.md) 0.3.7
- [cmdparser](https://npm.io/package/cmdparser.md) 0.0.3
- [inflection](https://npm.io/package/inflection.md) 1.2.7
- [body-parser](https://npm.io/package/body-parser.md) 1.18.2
- [jsonwebtoken](https://npm.io/package/jsonwebtoken.md) 8.1.0
- [method-override](https://npm.io/package/method-override.md) 2.3.10
- [node-redis-dump](https://npm.io/package/node-redis-dump.md) 0.2.1
- [express-partials](https://npm.io/package/express-partials.md) 0.3.0
- [readline-browserify](https://npm.io/package/readline-browserify.md) 0.0.4
- [browserify-middleware](https://npm.io/package/browserify-middleware.md) 7.1.0

## Alternatives

- [memory-cache](https://npm.io/package/memory-cache.md) — 795.0K weekly downloads
- [@httptoolkit/proxy-agent](https://npm.io/package/@httptoolkit/proxy-agent.md) — 11.2K weekly downloads
- [express-cache-controller](https://npm.io/package/express-cache-controller.md) — 5.3K weekly downloads
- [http-cache-middleware](https://npm.io/package/http-cache-middleware.md) — 4.5K weekly downloads
- [cache2](https://npm.io/package/cache2.md) — 1.5K weekly downloads

## Recent versions

- 0.4.5-rc.8 (latest) — 2018-06-16
- 0.4.5-rc.7 — 2018-04-29
- 0.4.5-rc.6 — 2018-04-29
- 0.4.5-rc.5 — 2018-01-11
- 0.4.5-rc.4 — 2018-01-11
- 0.4.5-rc.3 — 2018-01-11
- 0.4.5-rc.2 — 2018-01-11
- 0.4.5-rc.1 — 2018-01-11
- 0.4.5-rc.0 — 2018-01-11
- 0.4.5 — 2018-01-09

## README

# Redis Commander

Redis management tool written in node.js

# Install and Run

```bash
$ npm install -g redis-commander
$ redis-commander
```

# Usage

```bash
$ redis-commander --help
Options:
  --redis-port                         The port to find redis on.              [string]
  --redis-host                         The host to find redis on.              [string]
  --redis-socket                       The unix-socket to find redis on.       [string]
  --redis-password                     The redis password.                     [string]
  --redis-db                           The redis database.                     [string]
  --http-auth-username, --http-u       The http authorisation username.        [string]
  --http-auth-password, --http-p       The http authorisation password.        [string]
  --http-auth-password-hash, --http-h  The http authorisation password hash.   [string]
  --port, -p                           The port to run the server on.          [string]  [default: 8081]
  --address, -a                        The address to run the server on        [string]  [default: 0.0.0.0]
  --root-pattern, -rp                  The root pattern of the redis keys      [string]  [default: *]
```

## Docker

Hosts can be optionally specified with a comma separated string by setting the `REDIS_HOSTS` environment variable.

After running the container, `redis-commander` will be available at [localhost:8081](http://localhost:8081).

### Valid host strings

Form should follow one of these templates:

`hostname`

`label:hostname`

`label:hostname:port`

`label:hostname:port:dbIndex`

`label:hostname:port:dbIndex:password`

### With docker-compose

```yml
version: '3'
services:
  redis:
    container_name: redis
    hostname: redis
    image: redis

  redis-commander:
    container_name: redis-commander
    hostname: redis-commander
    image: rediscommander/redis-commander:latest
    build: .
    restart: always
    environment:
    - REDIS_HOSTS=local:redis:6379
    ports:
    - 8081:8081
```

### Without docker-compose

#### Simplest

If you're running redis on `localhost:6379`, this is all you need to get started.

```bash
docker run --rm --name redis-commander -d \
  -p 8081:8081 \
  rediscommander/redis-commander:latest
```

#### Specify single host

```bash
docker run --rm --name redis-commander -d \
  --env REDIS_HOSTS=10.10.20.30 \
  -p 8081:8081 \
  rediscommander/redis-commander:latest
```

#### Specify multiple hosts with labels

```bash
docker run --rm --name redis-commander -d \
  --env REDIS_HOSTS=local:localhost:6379,myredis:10.10.20.30 \
  -p 8081:8081 \
  rediscommander/redis-commander:latest
```

## Kubernetes

An example deployment can be found at [k8s/redis-commander/deployment.yaml](k8s/redis-commander/deployment.yaml).

If you already have a cluster running with `redis` in the default namespace, deploy `redis-commander` with `kubectl apply -f k8s/redis-commander`. If you don't have `redis` running yet, you can deploy a simple pod with `kubectl apply -f k8s/redis`.

Alternatively, you can add a container to a deployment's spec like this:

```
containers:
- name: redis-commander
  image: rediscommander/redis-commander
  env:
  - name: REDIS_HOSTS
    value: instance1:redis:6379
  ports:
  - name: redis-commander
    containerPort: 8081
```

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