redsmin

library5.0.1jsnpmunverified

Redsmin proxy daemon that securely bridges Redis servers behind firewalls or localhost to the Redsmin cloud-based Redis GUI (https://redsmin.com). Current stable version 5.0.1 runs on Node >=6. Provides encrypted tunneling with mutual TLS, supports Docker deployment, automatic reconnection, and configuration via environment variables or files. Compared to manual SSH tunneling, it offers a dedicated proxy with authentication, ready check handling, and integration with Redsmin's management dashboard.

devops database

npm install redsmin

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · REDSMIN

redsmin

devopsjavascriptv5.0.1

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

CLI

✓ npx redsmin

✗ npm install -g redsmin && redsmin

Package is a CLI tool, not a library; use via npx for temporary execution.

Docker image

✓ docker run -e REDSMIN_KEY=... redsmin/proxy

✗ npm run redsmin

Official Docker images are available on Docker Hub; prefer Docker for production.

Configuration

✓ export REDSMIN_KEY='...' && redsmin

✗ redsmin --key '...'

Uses environment variables only; no CLI flags for key or Redis URI.

Installs the redsmin CLI globally, sets required environment variables, and starts the proxy to connect a local Redis instance to Redsmin.

npm install -g redsmin # Set environment variables export REDSMIN_KEY='your-redsmin-connection-key' export REDIS_URI='redis://127.0.0.1:6379' export REDIS_AUTH='your-redis-password' # optional # Start the proxy redsmin

Debug

Known issues

breakingThe proxy requires Node.js >=6. Earlier versions are not supported and will fail to start.

fix

Update Node.js to version 6 or higher, or use the Docker image which bundles a compatible Node version.

affects: <5.0.0

deprecatedUse of CLI flags (e.g., --key) for configuration is deprecated in v4. Only environment variables are supported in v5.

fix

Replace --key with REDSMIN_KEY environment variable; see documentation for full env var list.

affects: >=4.0.0

gotchaIf your Redis server requires authentication without setting REDIS_AUTH, the proxy will fail with 'NOAUTH Authentication required'.

fix

Set the REDIS_AUTH environment variable to your Redis password before starting the proxy.

affects: all

gotchaWhen using a Unix socket for Redis, set REDIS_URI to the socket path (e.g., /tmp/redis.sock) instead of a TCP URI. Using a tcp:// prefix may cause connection failure.

fix

Specify the absolute path to the socket file without protocol prefix.

affects: all

deprecatedThe CONFIG_FILE environment variable is deprecated in v5. Configuration should be done exclusively via environment variables.

fix

Migrate from JSON config file to environment variables for all settings.

affects: >=5.0.0

Errors

Common errors & fixes

Error: REDSMIN_KEY required

The REDSMIN_KEY environment variable is not set or is empty.

fix

export REDSMIN_KEY='your-key' before running redsmin.

Error: getaddrinfo ENOTFOUND redsmin.com

The proxy cannot resolve the Redsmin server hostname, possibly due to network or DNS issues.

fix

Check internet connectivity and DNS resolution; ensure firewall allows outbound HTTPS (port 443) to redsmin.com.

Ready check failed: NOAUTH Authentication required.

Redis server requires authentication but REDIS_AUTH is not set or incorrect.

fix

Set REDIS_AUTH environment variable to the correct Redis password.

Error: Redis connection to 127.0.0.1:6379 failed - connect ECONNREFUSED

The proxy cannot connect to the specified Redis instance; Redis might be down or listening on a different port/host.

fix

Verify Redis is running and accessible; check REDIS_URI for correct host and port.

Upgrade

Version history

5.0.1latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

4 hits · last 30 days

node

Resources

githubgit://github.com/Redsmin/proxy ↗

packageredsmin ↗

homepagehttps://redsmin.com ↗