Code Monkey home page Code Monkey logo

bull-board-docker's Introduction

License Project Status: Active โ€“ The project has reached a stable, usable state and is being actively developed. GitHub Workflow Status - Docker Docker Image Pulls (all-time) Docker Image Version (latest semver)

Docker image for bull-board. Allow you to monitor your bull queue without any coding!

Supports both: Bull and BullMQ.

Quick start with Docker

docker run -p 3000:3000 bsormagec/bull-board-arm64

will run bull-board interface on localhost:3000 and connect to your redis instance on localhost:6379 without password.

To configurate redis see "Environment variables" section.

Quick start with docker-compose

version: '3.5'

services:
  bullboard:
    container_name: bullboard
    image: bsormagec/bull-board-arm64
    restart: always
    ports:
      - 3000:3000

will run bull-board interface on localhost:3000 and connect to your redis instance on localhost:6379 without password.

see "Example with docker-compose" section for example with env parameters

Environment variables

  • REDIS_HOST - host to connect to redis (localhost by default)
  • REDIS_PORT - redis port (6379 by default)
  • REDIS_DB - redis db to use ('0' by default)
  • REDIS_USE_TLS - enable TLS true or false (false by default)
  • REDIS_PASSWORD - password to connect to redis (no password by default)
  • BULL_PREFIX - prefix to your bull queue name (bull by default)
  • BULL_VERSION - version of bull lib to use 'BULLMQ' or 'BULL' ('BULLMQ' by default)
  • PROXY_PATH - proxyPath for bull board, e.g. https://<server_name>/my-base-path/queues [docs] ('' by default)
  • USER_LOGIN - login to restrict access to bull-board interface (disabled by default)
  • USER_PASSWORD - password to restrict access to bull-board interface (disabled by default)

Restrict access with login and password

To restrict access to bull-board use USER_LOGIN and USER_PASSWORD env vars. Only when both USER_LOGIN and USER_PASSWORD specified, access will be restricted with login/password

Example with docker-compose

version: '3.5'

services:
  redis:
    container_name: redis
    image: redis:5.0-alpine
    restart: always
    ports:
      - 6379:6379
    volumes:
      - redis_db_data:/data

  bullboard:
    container_name: bullboard
    image: bsormagec/bull-board-arm64
    restart: always
    ports:
      - 3000:3000
    environment:
      REDIS_HOST: redis
      REDIS_PORT: 6379
      REDIS_PASSWORD: example-password
      REDIS_USE_TLS: 'false'
      BULL_PREFIX: bull
    depends_on:
      - redis

volumes:
  redis_db_data:
    external: false

bull-board-docker's People

Contributors

dependabot[bot] avatar addono avatar deadly0 avatar semantic-release-bot avatar diluka avatar bsormagec avatar soulchild avatar githubjakob avatar theodorton avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.