README.md

RedisSMQ Web UI

💡 Note: You are viewing the next branch with upcoming features. For stable releases, check the master branch.

A Single Page Application for monitoring and managing RedisSMQ. Inspect queues and messages, review consumers, and perform common actions — with an integrated, type-safe OpenAPI client.

• Works seamlessly with the RedisSMQ REST API
• Best served via the RedisSMQ Web Server (serves the static UI and hosts or proxies the API)
• Ships with developer-friendly types and OpenAPI client generation

Features

• Dashboard for queues, consumers, and message stats
• Queue/message browsers with filters and actions (ack, retry, delete, etc.)
• Supports multiple queue and delivery models
• Exchange types: Direct, Topic, Fanout
• Type-safe OpenAPI client (generated from the REST API schema)

Requirements

See RedisSMQ requirements.

Installation

Typically consumed via the RedisSMQ Web Server. To set up everything:

npm install redis-smq@next redis-smq-common@next redis-smq-rest-api@next redis-smq-web-ui@next redis-smq-web-server@next
# Choose a Redis client:
npm install ioredis
# or
npm install @redis/client

Version Compatibility

Always install matching versions of RedisSMQ packages to ensure compatibility. See version compatibility for details.

Documentation

For in-depth guides and API references, see the documentation page.

Related packages

• redis-smq: Core message queue
• redis-smq-common: Shared components/utilities
• redis-smq-rest-api: REST API with OpenAPI v3 and Swagger UI
• redis-smq-web-server: Static hosting + in-process or proxied API

License

RedisSMQ Web UI is released under the MIT License.