redis-smq-web-server
v9.0.5
Published
Web server for RedisSMQ Web UI: serves the SPA and hosts or proxies the RedisSMQ REST API.
Maintainers
Readme
RedisSMQ Web Server
IS_NEXT_NOTE
NPM_BADGE CODECOV_BADGE
A lightweight server that brings the RedisSMQ management ecosystem to life. It serves the official Web UI and provides the REST API through two flexible modes of operation:
- Standalone Mode: Run the Web UI and REST API in a single process for an all-in-one setup.
- Proxy Mode: Serve the Web UI and proxy API requests to a separate redis-smq-rest-api instance for distributed deployments.
Features
- Dual-Mode Operation: Standalone (UI + API in one process) or Proxy (UI + proxied API).
- Versatile Execution: Start from the CLI as a standalone server or embed as a library in your Node.js app.
- Consistent Ecosystem: Works seamlessly with
redis-smq,redis-smq-rest-api, andredis-smq-web-ui.
Installation
# Using npm
npm install redis-smq__TAG_SUFFIX__ redis-smq-common__TAG_SUFFIX__ redis-smq-rest-api__TAG_SUFFIX__ redis-smq-web-ui__TAG_SUFFIX__ redis-smq-web-server__TAG_SUFFIX__ --saveDon't forget to install a Redis client. Choose either node-redis or ioredis:
npm install @redis/client --save
# or
npm install ioredis --saveVersion 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-ui: SPA for monitoring and managing RedisSMQ
License
RedisSMQ Web Server is released under the MIT License.
