le-store-redis

library0.2.3jsnpmunverified

A Redis storage backend for node-letsencrypt (greenlock) that persists keypairs, accounts, certificates, and domain metadata. Version 0.2.3 is the latest stable release; the package is in maintenance mode as the node-letsencrypt ecosystem has largely been superseded by greenlock-express and ACME.js v2. Key differentiator: provides a scalable, shared certificate store for multi-server load-balanced deployments, with indexing by email, account, and domain. Production use requires careful Redis security configuration.

storage

npm install le-store-redis

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · LE-STORE-REDIS

le-store-redis

storagejavascriptv0.2.3

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.

create

✓ const leStore = require('le-store-redis').create(opts);

✗ const leStore = require('le-store-redis'); // .create() is missing

The module exports a factory object; you must call .create() to get a storage instance.

RedisStorage

✓ const { RedisStorage } = require('le-store-redis');

✗ import { RedisStorage } from 'le-store-redis'; // No ESM exports, use require()

The package only provides CommonJS exports. There is no default export or TypeScript types.

all

✓ const leStore = require('le-store-redis');

✗ const leStore = require('le-store-redis').default; // No default export

The require returns an object with .create(). There is no .default property.

Initializes a Redis-backed storage backend for Let's Encrypt using node-letsencrypt or greenlock.

const leStore = require('le-store-redis').create({ debug: true, redisOptions: { host: '127.0.0.1', port: 6379, password: process.env.REDIS_PASSWORD || '', db: 2 } }); // Then pass to node-letsencrypt / greenlock // const lex = require('greenlock').create({ store: leStore });

Debug

Known issues

breakingThe node-letsencrypt package is deprecated; use greenlock-express or acme-v2 instead.

fix

Migrate to greenlock-express (https://git.rootprojects.org/root/greenlock-express.js) which uses le-store-pluggable-store and does not support le-store-redis directly.

affects: *

deprecatedThe redis package (node_redis) used here has been deprecated in favor of ioredis.

fix

Consider switching to ioredis-based storage or wrapping with an adapter.

affects: >=2.0.0

gotchaRedis password and other options must be passed via redisOptions, not at top level.

fix

Set Redis authentication inside redisOptions: { password: '...' }.

affects: *

gotchaDatabase keys expire after certExpiry seconds (default 100 days) and may be cleaned up by Redis eviction.

fix

Set certExpiry to 0 to disable automatic expiration, or adjust accordingly.

affects: *

Errors

Common errors & fixes

Error: The 'store' option must be an object with a 'create' method

passing the result of require('le-store-redis') directly instead of calling .create()

fix

Use leStore = require('le-store-redis').create(opts);

TypeError: Cannot read property 'redis' of undefined

Redis connection failed because redisOptions is missing or contains invalid host/port

fix

Ensure redisOptions.host and redisOptions.port are set correctly and Redis is running.

NOAUTH Authentication required

Redis server requires authentication but no password was provided in redisOptions

fix

Set redisOptions.password to the correct Redis password.

Redis connection to 127.0.0.1:6379 failed - connect ECONNREFUSED

Redis server is not running or unreachable

fix

Start Redis server or verify the host/port in redisOptions.

Upgrade

Version history

0.2.3latest on npm

Audit

Dependencies

redisrequiredOfficial Node.js Redis client used for database operations

Agent activity

24 hits · last 30 days

node

Resources

githubhttps://github.com/digitalbazaar/le-store-redis ↗

packagele-store-redis ↗

homepagehttps://github.com/digitalbazaar/le-store-redis#readme ↗