Registry / database / p3x-redis-ui-server

p3x-redis-ui-server

library2026.4.373jsnpmunverified

Socket.IO backend server for the P3X Redis UI (v2026.4.373) with dual Angular/React frontends. Provides real-time Redis management via WebSocket events, supporting ioredis (standalone, cluster, sentinel), JWT-based authentication, AI query translation to Redis commands via Groq, and auto-decompression of 7 compressed formats (GZIP, ZIP, zlib, Zstandard, LZ4, Snappy, Brotli). Requires Node.js >=22. Released under MIT, no REST endpoints—all communication is socket-based. Differentiator: dual frontend stack (Angular + React) with full feature parity, 54 languages, 7 themes, and integrated login page.

database communication auth-security

npm install p3x-redis-ui-server

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · P3X-REDIS-UI-SERVE

p3x-redis-ui-server

databasejavascriptv2026.4.373

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

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

default

✓ import P3XRedisUiServer from 'p3x-redis-ui-server'

✗ const P3XRedisUiServer = require('p3x-redis-ui-server')

Package is ESM-only since v2023. CommonJS require() will not work.

startServer

✓ import { startServer } from 'p3x-redis-ui-server'

✗ import startServer from 'p3x-redis-ui-server'

Named export, not default. Introduced in v2024.

P3XRedisUiServerOptions

✓ import type { P3XRedisUiServerOptions } from 'p3x-redis-ui-server'

✗ import { P3XRedisUiServerOptions } from 'p3x-redis-ui-server'

Type imports must use 'import type' in TypeScript under 'verbatimModuleSyntax'. The type is not a runtime value.

Initializes the P3X Redis UI server with custom config, authentication, and AI query support.

import { startServer } from 'p3x-redis-ui-server'; import { createServer } from 'http'; const httpServer = createServer(); const apiServer = await startServer({ httpServer, config: { p3xrs: { port: 7843, connections: { 'my-redis': { host: 'localhost', port: 6379, password: process.env.REDIS_PASSWORD ?? '' } }, auth: { enabled: true, username: 'admin', password: process.env.UI_PASSWORD ?? 'changeme' }, lang: 'en', theme: 'dark-blue', ai: { provider: 'groq', apiKey: process.env.GROQ_API_KEY ?? '' } } } }); httpServer.listen(7843, () => { console.log('P3X Redis UI server running on http://localhost:7843'); });

Debug

Known issues

breakingMinimum Node.js version required: >=22. Versions <22 will throw an engine check error or fail to start.

fix

Upgrade Node.js to v22 or later (currently tested on v24.14.1).

affects: <22.0.0

breakingESM-only package since v2023.4. CommonJS require() throws MODULE_NOT_FOUND or ERR_REQUIRE_ESM.

fix

Convert project to ESM (type: 'module' in package.json) or use dynamic import().

affects: >=2023.4.0

breakingNo REST API endpoints. All Redis operations must be done via Socket.IO events. HTTP requests to paths other than /health and the frontend assets will fail.

fix

Use Socket.IO client to communicate. See documentation for event list.

affects: >=2022.0.0

deprecatedThe 'p3xrs.connectionsFile' config option is deprecated in favor of 'p3xrs.connections.fileName' and will be removed in v2027.

fix

Rename config key 'connectionsFile' to 'connections.fileName' in p3xrs.json.

affects: >=2026.0.0

gotchaGroq API key usage: The AI query feature sends your Groq API key to Groq's servers. Ensure the key has appropriate rate limits and permissions. The package does not encrypt the key in memory.

fix

Store the API key in an environment variable (GROQ_API_KEY) and restrict network access to api.groq.com for the server process.

affects: >=2025.0.0

gotchaFile descriptor leak: Running the server in a tight reconnect loop with many Redis connections may exhaust file descriptors. Limit number of concurrent connections or set ulimit.

fix

Monitor open file handles with lsof. Reduce connection pool size in config or increase system limit (ulimit -n 65536).

affects: >=2024.0.0

Errors

Common errors & fixes

TypeError: Cannot destructure property 'startServer' of '...' as it is undefined.

CommonJS require() used for an ESM-only package.

fix

Use import { startServer } from 'p3x-redis-ui-server' or change your project to ESM.

Error [ERR_REQUIRE_ESM]: require() of ES Module /path/to/p3x-redis-ui-server/index.js from /path/to/your/index.js not supported.

The package is ESM-only and cannot be required from CJS context.

fix

Convert your entry point to ESM by setting 'type': 'module' in package.json or use dynamic import().

Error: listen EADDRINUSE :::7843

Port 7843 is already in use by another instance or process.

fix

Kill the existing process (lsof -ti :7843 | xargs kill) or change the port in config.

Error: getaddrinfo ENOTFOUND redis-host

Hostname 'redis-host' could not be resolved. Check your connections configuration.

fix

Verify the hostname or IP in p3xrs.json for the Redis connection.

Upgrade

Version history

2026.4.373latest on npm

Audit

Dependencies

p3x-redis-ui-materialrequiredServes the dual Angular/React frontend assets (not directly a npm dep, but bundled together)

ioredisrequiredRedis client for standalone, cluster, and sentinel modes

socket.iorequiredCore real-time communication protocol

Agent activity

13 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/patrikx3/redis-ui-server ↗

packagehttps://www.npmjs.com/package/p3x-redis-ui-server ↗

homepagehttps://corifeus.com/redis-ui-server ↗