Installation

Install the core @bull-board/api plus one adapter for your framework.

Prerequisites

Node.js 18+ or Bun 1.x
A running Redis instance
Bull or BullMQ already set up in your app

Sharing an ioredis connection?

bull-board reads your existing Bull/BullMQ queues, so it inherits their Redis connection. If you construct BullMQ with a shared ioredis instance rather than a plain { host, port }, BullMQ requires that connection to be created with maxRetriesPerRequest: null. This is a BullMQ requirement, not a bull-board one, but it's the most common setup snag. See the BullMQ connection docs.

Install

Pick the adapter that matches your framework:

Framework	Install command
Express	`npm install @bull-board/api @bull-board/express`
Fastify	`npm install @bull-board/api @bull-board/fastify`
NestJS	`npm install @bull-board/api @bull-board/nestjs`
Koa	`npm install @bull-board/api @bull-board/koa`
Hapi	`npm install @bull-board/api @bull-board/hapi`
Hono	`npm install @bull-board/api @bull-board/hono`
H3	`npm install @bull-board/api @bull-board/h3`
Elysia	`npm install @bull-board/api @bull-board/elysia`
Bun	`npm install @bull-board/api @bull-board/bun`

Next steps

Build your first dashboard for a framework-agnostic walkthrough.
Or jump to your adapter: Express, Fastify, Koa, Hapi, NestJS, Hono, H3, Elysia, Bun.

#Installation

#Prerequisites

#Install

#Next steps

Installation

Prerequisites

Install

Next steps