Bunnycron

Bunnycron is a job scheduling module trigged by your node.js process. Bunnycron will schedule a job based on a cron syntax textfile in your project directory, so you can keep your job scheduling definition in your git repository. With a lock machanism provided by Redis, Bunnycron will prevent the same job running multiple times within a cluster. It provides a clean user interface to monitor your jobs and their statuses.

Installation

Install via npm:

npm install bunnycron

User Interface

Schedule Overview

Bunnycron provides a clean user-interface for viewing your scheduled jobs.

Schedule Log

The logging system allows you to see how your job processed

Cronfile

First create a Cronfile file in your root directory of your project.

An example of Cronfile with the same syntax of your familiar Crontab

00 30 12 * * * node backup_database.js

*/10 * * * * * ./checkuptime.sh

00 30 11 * * 1-5 curl -o aapl.html http://www.jitta.com/stock/aapl

Available Cron Patterns

Asterisk. E.g. *
Ranges. E.g. 1-3,5
Steps. E.g. */2

Cronfile Examples

*/10 * * * * 1-2  echo "Run every 10 seconds on Monday and Tuesday"
00 */2 * * * *  echo "Run every 2 minutes everyday"
00 30 09-10 * * * echo "Run at 09:30 and 10:30 everyday"
00 30 08 10 06 * echo "Run at 08:30 on 10th June"

- 00 for Sunday or 24.00

Read more cron patterns here.

Running a Cronjob

var bunny = require('bunnycron')();
bunny.startCron();

Redis Connection Settings

var options = {
  redis: {
    port: 1234,
    host: '10.12.33.44',
    auth: 'fj2ifjeo2j'
  }
};

var bunny = require('bunnycron')(options);
bunny.startCron();

when required bunnycron module you can pass options in an object with the following possible properties.

• cronFile : the directory path to Cronfile ex. ./path/to/dir
• redis : by default, Bunnycron will connect to Redis using the client default settings (port defaults to 6379 and host defaults to 127.0.0.1, prefix defaults to bunny)
• prefix : defaults to bunny. Custom redis predix
• debug : send log data to stdout.

User-Interface

To view your scheduled jobs UI. You can use bunny.app within your existing express.js application.

var express = require('express');
var app = express();
var bunny = require('bunnycron')()
bunny.startCron();
app.use(bunny.app);
// app.use('/bunny/', bunny.app) or custom base url
app.listen(3000);

License

(The MIT License)

Copyright (c) 2014 Jitta <[email protected]>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.