CleverStack Background Tasks Module
This CleverStack Module provides the ability to run multiple background processes that can run "Tasks", this free's the event loop up inside the http workers to respond to web requests while processing can take place in the background.
Documentation
See cleverstack.io for more detailed information on the Node seed or visit the Getting Started Guide
Configuration
Simply add the following config to your /config/local.json (or into your global.json for all environments, or in whatever environment you are using). See https://github.com/CleverStack/clever-background-tasks/wiki/Configuration
Grunt
grunt prompt:cleverBackgroundTasksConfig
can be used to generate your config for any environment you wantgrunt prompt:addBackgroundTask
can be used to add/edit tasks inside your config
Configuration files
{
"clever-background-tasks": {
"enabled" : true,
"interval": 2500,
"tasks":[
{ "name": "ExampleTask", "parallel": true }
],
"driver": "redis",
"redis": {
"host": "localhost",
"port": "11211"
}
}
}
Setup
Using CLI
- Run
clever install clever-background-tasks
and follow the prompts - Run
clever serve
to start your application.
Without CLI
- Clone this repo (or untar it there) into your modules folder (ie modules/clever-background-tasks)
- Add 'clever-background-tasks' to the bundledDependencies array of your app's package.json.
- Run
grunt prompt:cleverBackgroundTasksConfig
and fill in your configuration options. - Run
grunt prompt:addBackgroundTask
to add any tasks to your running configuration. - Run
grunt server
to start your application.
License
See our LICENSE