![\"npm](\"https://img.shields.io/npm/v/@bull-board/nestjs\")
\n \n \n ![\"npm](\"https://img.shields.io/npm/dw/@bull-board/nestjs\")
\n \n \n ![\"licence\"](\"https://img.shields.io/github/license/felixmosh/bull-board\")
\n \n![\"@bull-board\"](\"https://raw.githubusercontent.com/felixmosh/bull-board/master/packages/ui/src/static/images/logo.svg\"){kind=logo}
@bull-board/nestjs\n\n[NestJS](https://nestjs.com/) for `bull-board`.\n\n\n\n\n\n\n## Installation\n\nInstall both @bull-board/api and this module.\n```bash\n$ npm install --save @bull-board/nestjs @bull-board/api\n```\n\nInstall the Express or Fastify adapter depending on what you use in NestJS (default is Express)\n```bash\n$ npm install --save @bull-board/express\n//or \n$ npm install --save @bull-board/fastify\n```\n\n## Register the root module\nOnce the installation is completed, we can import the `BullBoardModule` into your rootmodule e.g. `AppModule`.\n\n```typescript\nimport { Module } from '@nestjs/common';\nimport { BullBoardModule } from \"@bull-board/nestjs\";\nimport { ExpressAdapter } from \"@bull-board/express\";\n\n@Module({\n imports: [\n BullModule.forRoot({\n // your bull module config here.\n }),\n\n BullBoardModule.forRoot({\n route: '/queues',\n adapter: ExpressAdapter // Or FastifyAdapter from `@bull-board/fastify`\n }),\n ],\n})\nexport class AppModule {\n}\n```\n\nThe `forRoot()` method registers the bull-board instance and allows you to pass several options to both the instance and module.\nThe following options are available.\n- `route` the base route for the bull-board instance adapter.\n- `adapter` The routing adapter to be used, either the Express Adapter or Fastify Adapter provided by bull-board.\n- `boardOptions` options as provided by the bull-board package, such as `uiBasePath` and `uiConfig`\n- `middleware` optional middleware for the express adapter (e.g. basic authentication)\n\n\n### Express Authentication\n\nFor Express, install `express-basic-auth`:\n\n```bash\n$ npm install --save express-basic-auth\n```\n\nModify the `BullBoardModule.forRoot()` method:\n\n```typescript\nimport basicAuth from \"express-basic-auth\";\n\nBullBoardModule.forRoot({\n route: \"/queues\",\n adapter: ExpressAdapter,\n middleware: basicAuth({\n challenge: true,\n users: { admin: \"passwordhere\" },\n }),\n}),\n```\n\n### Fastify Authentication\n\nFor Fastify, you can use `fastify-basic-auth`:\n\n```bash\n$ npm install --save fastify-basic-auth\n```\n\nThen apply it using middleware:\n\n```typescript\nimport fastifyBasicAuth from \"fastify-basic-auth\";\n\nBullBoardModule.forRoot({\n route: \"/queues\",\n adapter: FastifyAdapter,\n middleware: (req, res, next) => {\n fastifyBasicAuth({\n validate: async (username, password, req, reply) => {\n if (username === \"admin\" && password === \"passwordhere\") {\n return;\n }\n throw new Error(\"Unauthorized\");\n },\n })(req, res, next);\n },\n}),\n```\n\n\n## Register your queues\nTo register a new queue, you need to register `BullBoardModule.forFeature` in the same module as where your queues are registered.\n\n```typescript\nimport { Module } from '@nestjs/common';\nimport { BullBoardModule } from \"@bull-board/nestjs\";\nimport { BullMQAdapter } from \"@bull-board/api/bullMQAdapter\";\nimport { BullModule } from \"@nestjs/bullmq\";\n\n@Module({\n imports: [\n BullModule.registerQueue(\n {\n name: 'my_awesome_queue'\n }\n ),\n \n BullBoardModule.forFeature({\n name: 'my_awesome_queue',\n adapter: BullMQAdapter, //or use BullAdapter if you're using bull instead of bullMQ\n }),\n ],\n})\nexport class FeatureModule {}\n```\n\nThe `forFeature` method registers the given queues to the bull-board instance.\nThe following options are available.\n- `name` the queue name to resolve from the Nest DI container.\n- `queue` a queue instance to register directly, instead of resolving it by `name`.\n- `adapter` either `BullAdapter` or `BullMQAdapter` depending on which package you use.\n- `options` queue adapter options as found in the bull-board package, such as `readOnlyMode`, `description` etc.\n\nProvide either `name` or `queue`.\n\n### Registering queue instances directly\n\n`@nestjs/bullmq` generates the DI token for a queue from its `name` only, ignoring the\n`prefix`. Two queues that share a name but use different prefixes therefore collapse onto a\nsingle DI token, and a `name`-based lookup cannot tell them apart. Pass the queue instances\ndirectly via `queue` to register them as distinct board entries:\n\n```typescript\n@Module({\n imports: [\n BullBoardModule.forFeature(\n { queue: emailsTenantA, adapter: BullMQAdapter, options: { prefix: 'tenant-a:' } },\n { queue: emailsTenantB, adapter: BullMQAdapter, options: { prefix: 'tenant-b:' } },\n ),\n ],\n})\nexport class FeatureModule {}\n```\n\n## Using the bull-board instance in your controllers and/or services.\nThe created bull-board instance is available via the `@InjectBullBoard()` decorator.\nFor example in a controller:\n\n```typescript\nimport { Controller, Get } from \"@nestjs/common\";\nimport { BullBoardInstance, InjectBullBoard } from \"@bull-board/nestjs\";\n\n@Controller('my-feature')\nexport class FeatureController {\n\n constructor(\n @InjectBullBoard() private readonly boardInstance: BullBoardInstance\n ) {\n }\n \n //controller methods\n}\n```\n\n# Usage examples\n1. [Simple NestJS setup](https://github.com/felixmosh/bull-board/tree/master/examples/with-nestjs)\n\nFor more info visit the main [README](https://github.com/felixmosh/bull-board#readme)\n","readmeFilename":"README.md"}