Cronicle

A simple, distributed task scheduler and runner with a web based UI.

README

Overview


Cronicle is a multi-server task scheduler and runner, with a web based front-end UI.  It handles both scheduled, repeating and on-demand jobs, targeting any number of worker servers, with real-time stats and live log viewer.  It's basically a fancy Cron replacement written in Node.js.  You can give it simple shell commands, or write Plugins in virtually any language.

Main Screenshot

Features at a Glance


Single or multi-server setup.
Automated failover to backup servers.
Auto-discovery of nearby servers.
Real-time job status with live log viewer.
Plugins can be written in any language.
Schedule events in multiple timezones.
Optionally queue up long-running events.
Track CPU and memory usage for each job.
Historical stats with performance graphs.
Simple JSON messaging system for Plugins.
Web hooks for external notification systems.
Simple REST API for scheduling and running events.
API Keys for authenticating remote apps.

Documentation


The Cronicle documentation is split up across these files:

- → Setup
- → Web UI
- → Plugins

Glossary


A quick introduction to some common terms used in Cronicle:

TermDescription
|------|-------------|
**PrimaryThe
**BackupA
**WorkerA
**ServerA
**APIA
**User**A
**Plugin**Any
**Schedule**The
**Category**Events
**Event**An
**Job**A

Colophon


We stand on the shoulders of giants.  Cronicle was built using these awesome Node modules:

ModuleDescriptionLicense
|-------------|-------------|---------|
[async](https://www.npmjs.com/package/async)Higher-orderMIT
[bcrypt-node](https://www.npmjs.com/package/bcrypt-node)NativeBSD
[chart.js](https://www.npmjs.com/package/chart.js)SimpleMIT
[daemon](https://www.npmjs.com/package/daemon)Add-onMIT
[errno](https://www.npmjs.com/package/errno)Node.jsMIT
[font-awesome](https://www.npmjs.com/package/font-awesome)TheOFL-1.1
[form-data](https://www.npmjs.com/package/form-data)AMIT
[formidable](https://www.npmjs.com/package/formidable)AMIT
[glob](https://www.npmjs.com/package/glob)FilesystemISC
[jstimezonedetect](https://www.npmjs.com/package/jstimezonedetect)AutomaticallyMIT
[jquery](https://www.npmjs.com/package/jquery)JavaScriptMIT
[mdi](https://www.npmjs.com/package/mdi)MaterialOFL-1.1
[mkdirp](https://www.npmjs.com/package/mkdirp)RecursivelyMIT
[moment](https://www.npmjs.com/package/moment)Parse,MIT
[moment-timezone](https://www.npmjs.com/package/moment-timezone)ParseMIT
[netmask](https://www.npmjs.com/package/netmask)ParsesMIT
[node-static](https://www.npmjs.com/package/node-static)AMIT
[nodemailer](https://www.npmjs.com/package/nodemailer)EasyMIT
[shell-quote](https://www.npmjs.com/package/shell-quote)QuoteMIT
[socket.io](https://www.npmjs.com/package/socket.io)Node.jsMIT
[socket.io-client](https://www.npmjs.com/package/socket.io-client)ClientMIT
[uglify-js](https://www.npmjs.com/package/uglify-js)JavaScriptBSD-2-Clause
[zxcvbn](https://www.npmjs.com/package/zxcvbn)RealisticMIT

Companies Using Cronicle


Cronicle is known to be in use by the following companies:


License


The MIT License (MIT)

Copyright (c) 2015 - 2023 Joseph Huckaby

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.