An open source composable commerce engine built for developers.
## Overview
Redis Event Bus module for Medusa. When installed, the events system of Medusa is powered by BullMQ and `io-redis`. BullMQ is responsible for the message queue and worker. `io-redis` is the underlying Redis client, that BullMQ connects to for events storage.
## Getting started
Install the module:
```bash
yarn add @medusajs/event-bus-redis
```
Add the module to your `medusa-config.js`:
```js
module.exports = {
// ...
modules: [
{
resolve: "@medusajs/event-bus-redis",
options: {
redisUrl: "redis:..",
},
},
],
// ...
}
```
## Configuration
The module can be configured with the following options:
| Option | Type | Description | Default |
| -------------- | --------- | ------------------------------------------------------------------------------------------------------------------------ | --------------- |
| `redisUrl` | `string` | URL of the Redis instance to connect to. | `events-worker` |
| `queueName` | `string?` | Name of the BullMQ queue. | `events-queue` |
| `queueOptions` | `object?` | Options for the BullMQ queue. See BullMQ's [documentation](https://api.docs.bullmq.io/interfaces/QueueOptions.html). | `{}` |
| `redisOptions` | `object?` | Options for the Redis instance. See `io-redis`'s [documentation](https://luin.github.io/ioredis/index.html#RedisOptions) | `{}` |
**Info**: See how the options are applied in the [RedisEventBusService](https://github.com/medusajs/medusa/blob/0c1d1d590463fa30b083c4312293348bdf6596be/packages/event-bus-redis/src/services/event-bus-redis.ts#L52) and [loader](https://github.com/medusajs/medusa/blob/0c1d1d590463fa30b083c4312293348bdf6596be/packages/event-bus-redis/src/loaders/index.ts).
If you do not provide a `redisUrl` in the module options, the server will fail to start.
