Have ideas to improve npm?Join in the discussion! »

    bull-board
    TypeScript icon, indicating that this package has built-in type declarations

    2.0.3 • Public • Published

    bull-board 🎯

    Bull Dashboard is a UI built on top of Bull or BullMQ to help you visualize your queues and their jobs. With this library you get a beautiful UI for visualizing what's happening with each job in your queues, their status and some actions that will enable you to get the job done.

    npm downloads licence snyk

    UI Fails

    Notes

    As this library provides only the visualization for your queues, keep in mind that:

    • You must have either Bull or BullMQ installed in your projects;
    • Aside the options to retry and clean jobs, this library is not responsible for processing the jobs, reporting progress or any other thing. This must be done in your application with your own logic;
    • If you want to understand the possibilities you have with the queues please refer to Bull's docs;
    • This library doesn't hijack Bull's way of working.

    If you want to learn more about queues and Redis: https://redis.io/.

    Starting

    To add it to your project start by adding the library to your dependencies list:

    yarn add bull-board

    Or

    npm i bull-board

    Hello World

    The first step is to setup bull-board by calling createBullBoard method.

    const express = require('express')
    const Queue = require('bull')
    const QueueMQ = require('bullmq')
    const { createBullBoard } = require('bull-board')
    const { BullAdapter } = require('bull-board/bullAdapter')
    const { BullMQAdapter } = require('bull-board/bullMQAdapter')
    
    const someQueue = new Queue('someQueueName')
    const someOtherQueue = new Queue('someOtherQueueName')
    const queueMQ = new QueueMQ('queueMQName')
    
    const { router, setQueues, replaceQueues } = createBullBoard([
      new BullAdapter(someQueue),
      new BullAdapter(someOtherQueue),
      new BullMQAdapter(queueMQ),
    ])
    
    const app = express()
    
    app.use('/admin/queues', router)
    
    // other configurations of your server

    That's it! Now you can access the /admin/queues route, and you will be able to monitor everything that is happening in your queues 😁

    For more advanced usages check the examples folder, currently it contains:

    1. Basic authentication example
    2. Multiple instance of the board

    Queue options

    1. readOnlyMode (default: false) Makes the UI as read only, hides all queue & job related actions
    const Queue = require('bull')
    const QueueMQ = require('bullmq')
    const { setQueues } = require('bull-board')
    const { BullMQAdapter } = require('bull-board/bullMQAdapter')
    const { BullAdapter } = require('bull-board/bullAdapter')
    
    const someQueue = new Queue()
    const someOtherQueue = new Queue()
    const queueMQ = new QueueMQ()
    
    const { router, setQueues, replaceQueues } = createBullBoard([
      new BullAdapter(someQueue, { readOnlyMode: true }), // only this queue will be in read only mode
      new BullAdapter(someOtherQueue),
      new BullMQAdapter(queueMQ, { readOnlyMode: true }),
    ])

    Hosting router on a sub path

    If you host your express service on a different path than root (/) ie. https://<server_name>/<sub_path>/, then you can add the following code to provide the configuration to the bull-board router. In this example the sub path will be my-base-path.

    const Queue = require('bull')
    const { createBullBoard } = require('bull-board')
    const { BullAdapter } = require('bull-board/bullAdapter')
    
    const someQueue = new Queue('someQueueName')
    
    const { router } = createBullBoard([
      new BullAdapter(someQueue),
    ])
    
    // ... express server configuration
    
    let basePath = 'my-base-path';
    
    app.use(
      '/queues',
      (req, res, next) => {
        req.proxyUrl = basePath + '/queues';
        next();
      },
      router);

    You will then find the bull-board UI at the following address https://<server_name>/my-base-path/queues.

    Contributing

    First, thank you for being interested in helping out, your time is always appreciated in every way. 💯

    Remember to read the Code of Conduct so you also help maintaining a good Open source community around this project!

    Here are some tips:

    • Check the issues page for already opened issues (or maybe even closed ones) that might already address your question/bug/feature request.
    • When opening a bug report provide as much information as you can, some things might be useful for helping debugging and understading the problem
      • Node, Redis, Bull, bull-board versions
      • Sample code that reproduces the problem
      • Some of your environment details
      • Framework you're using (Express, Koa, Hapi, etc).
    • Feature requests are welcomed! Provide some details on why it would be helpful for you and others, explain how you're using bull-board and if possible even some screenshots if you are willing to mock something!

    Developing

    If you want to help us to solve the issues, be it a bug, a feature or a question, you might need to fork and clone this project.

    To fork a project means you're going to have your own version of it under your own GitHub profile, you do it by clicking the "Fork" button on the top of any project's page on GitHub.

    Cloning a project means downloading it to your local machine, you do it in the command line:

    git clone git@github.com:YOUR_GITHUB_USERNAME/bull-board.git

    That will create a bull-board folder inside the directory you executed the command, so you need to navigate inside it:

    cd bull-board

    This project requires that you have yarn installed

    Also make sure you are running Redis for this project (bull-board's example connects to Redis' default port 6379).

    Now, to try it out locally you can run:

    yarn && yarn start:dev

    Acknowledgements ❤️

    • Juan for building the first version of this library

    License

    This project is licensed under the MIT License, so it means it's completely free to use and copy, but if you do fork this project with nice additions that we could have here, remember to send a PR 👍

    Install

    npm i bull-board

    DownloadsWeekly Downloads

    38,026

    Version

    2.0.3

    License

    MIT

    Unpacked Size

    434 kB

    Total Files

    163

    Last publish

    Collaborators

    • avatar
    • avatar