cbq
2.1.0
2.1.0
  • Home
  • What's New?
  • Getting Started
    • Installation
    • Walkthrough
  • Configuration
    • Module Settings
    • Config File
      • Queue Connection
      • Worker Pool
    • Providers
      • SyncProvider
      • ColdBoxAsyncProvider
      • DBProvider
  • Jobs
    • Defining a Job
    • Creating a Job
    • Dispatching a Job
    • Working a Job
    • Failed Jobs
    • Chained Jobs
    • Batched Jobs
  • cbq Model
  • Interceptors
  • Other
    • Contributing
    • Contributors
    • Prior Art
    • Dedication
Powered by GitBook
On this page
  • Requirements
  • Install via ForgeBox with CommandBox
  • Load Java Libraries
  • Additional Provider Installation Steps
  1. Getting Started

Installation

PreviousWhat's New?NextWalkthrough

Requirements

cbq requires the following:

  • Adobe ColdFusion (ACF) 2018+ OR Lucee 5+

  • ColdBox 6+

The different each have their own requirements that are listed on their individual pages.

Install via ForgeBox with CommandBox

cbq is installed via with . You can install the latest version using the command:

install cbq

Load Java Libraries

When using batches, cbq utilizes additional Java libraries included in the lib/ folder. These need to be added to your Application's javaSettings in Application.cfc.

// Java Integration
this.javaSettings = {
    loadPaths: [ expandPath( "./modules/cbq/lib" ) ],
    loadColdFusionClassPath: true,
    reloadOnChange: false
};

Feel free to use mappings to point to the cbq path, if needed.

Additional Provider Installation Steps

The you use may have additional installation steps. Check out the individual provider pages for more details.

Queue Providers
ForgeBox
CommandBox
Queue Provider