From debd509868616b15be8b0a12effefa3ccf30fc59 Mon Sep 17 00:00:00 2001 From: MrMeeb Date: Sun, 28 May 2023 10:16:53 +0000 Subject: [PATCH] add cronicle info to readme [CI SKIP] --- README.md | 34 +++++++++++++++++++++++++++++----- 1 file changed, 29 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 995a861..2946ff6 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,41 @@ # Cronicle Docker -![Drone (self-hosted) with branch](https://img.shields.io/drone/build/MrMeeb/cronicle-docker/main?label=main&server=https%3A%2F%2Fdrone.mrmeeb.stream&style=for-the-badge) ![Drone (self-hosted) with branch](https://img.shields.io/drone/build/MrMeeb/cronicle-docker/develop?label=develop&server=https%3A%2F%2Fdrone.mrmeeb.stream&style=for-the-badge) +![Drone (self-hosted) with branch](https://img.shields.io/drone/build/MrMeeb/cronicle-docker/main?label=latest&server=https%3A%2F%2Fdrone.mrmeeb.stream&style=for-the-badge) ![Drone (self-hosted) with branch](https://img.shields.io/drone/build/MrMeeb/cronicle-docker/develop?label=develop&server=https%3A%2F%2Fdrone.mrmeeb.stream&style=for-the-badge) -Dockerised Cronicle, based on the [Cronicle-Edge](https://github.com/cronicle-edge/cronicle-edge) fork. +Dockerised Cronicle, based on the [Cronicle-Edge](https://github.com/cronicle-edge/cronicle-edge) fork of [Cronicle](https://github.com/jhuckaby/Cronicle). This container was built to include features I value in containers, namely logging to `stdout` and configurable `PUID` and `PGID`. -Can function in both the **manager** and **worker** role. - -*This repo is mirrored to GitHub* +This container can function in both the **manager** and **worker** role. ## Links - :tea: [Gitea Repo (source)](https://git.mrmeeb.stream/MrMeeb/cronicle-docker) - :whale2: [Containers](https://git.mrmeeb.stream/MrMeeb/-/packages/container/cronicle/latest) - since I'm currently not also publishing them to ghcr.io - :mirror: [GitHub mirror](https://github.com/MrMeeb/cronicle-docker) +- :package: [Cronicle Repo](https://github.com/jhuckaby/Cronicle) +- :package: [Cronicle-Edge Repo](https://github.com/cronicle-edge/cronicle-edge) + +*This repo is mirrored to GitHub* + +## Overview + +[**Cronicle**](https://github.com/jhuckaby/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](https://en.wikipedia.org/wiki/Cron) replacement written in [Node.js](https://nodejs.org/). You can give it simple shell commands, or write Plugins in virtually any language. + +![Main Screenshot](https://pixlcore.com/software/cronicle/screenshots-new/job-details-complete.png) + +## 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. ## Tags