Portainer Templates logo

Portainer Templates

Cronicle Cronicle

Stack

Automation Jobs

Cronicle, a cron replacement with a web UI: schedules, run history, chaining, retries, and alerts. Single container, two small volumes (job data + logs).

Image details

Pulls: 350k
Architecture: amd64, arm64, arm/v7
Image size: 65 MB
Latest: 0.9
User: soulteary
Created: Dec 05, 2021
Updated: 1 years ago
Status: active

Source details

Language: JavaScript
Updated: 1 years ago

Configuration

Type
Compose
Platform
linux
Image
soulteary/cronicle:0.9.80
Ports
5000:5000
Volumes
/opt/cronicle/data : crondata/opt/cronicle/logs : cronlogs
Env vars
CRONICLE_WebServer__http_port=5000CRONICLE_web_direct_connect=false
Restart
unless-stopped
Source

Standalone Install

Select an install method, to see config/commands for deploying Cronicle

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select Cronicle, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo
Original stackfile

The compose file this template deploys, straight from its repo:

name: cronicle

services:
  cronicle:
    image: soulteary/cronicle:0.9.80
    restart: unless-stopped
    hostname: cronicle
    environment:
      CRONICLE_WebServer__http_port: "5000"
      CRONICLE_web_direct_connect: "false"
    ports:
      - "5000:5000"
    volumes:
      - crondata:/opt/cronicle/data
      - cronlogs:/opt/cronicle/logs

volumes:
  crondata:
  cronlogs:

Or deploy it directly from the source:

git clone https://github.com/deployable-sh/stacks
cd stacks
docker compose -f cronicle/compose.yaml up -d

More install options in our documentation, or see soulteary/cronicle for app-specific guidance.

Docker Cronicle

Docker Image
Simple and lightweight Cronicle Docker solution.
Main Screenshot
Say goodbye to troublesome configuration and installation, and start your Scheduled Task Center with One-Click.

Get Latest Docker Images

# use the latest version
docker pull soulteary/cronicle
# or specified version
docker pull soulteary/cronicle:0.9.16

Supported Versions

DockerHub: https://hub.docker.com/r/soulteary/cronicle

Default Account

default account and password:
  • username: admin
  • password: admin

Docker

It is very simple to use, only one command is needed:
you can start a container that persists data and log files locally through Docker.
docker run \
        -v /etc/localtime:/etc/localtime:ro \
        -v /etc/timezone:/etc/timezone:ro \
        -v `pwd`/data/data:/opt/cronicle/data:rw \
        -v `pwd`/data/logs:/opt/cronicle/logs:rw \
        -v `pwd`/data/plugins:/opt/cronicle/plugins:rw \
        -p 3012:3012 \
        --hostname cronicle \
        --name cronicle \
        soulteary/cronicle

When the service is started, we can access the service in the browser: http://localhost:3012

Docker Compose

Using compose to start our service also requires only one command:
docker-compose down && docker-compose up -d

When the service is started, we can access the service in the browser: http://localhost:3012

With Traefik

You can refer to the configuration in docker-compose.traefik.yml file.

Snapshots

Home
Home Tab Screenshot
Schedule
Schedule Screenshot
Event
Edit Event Screenshot
Event Timing Screenshot
Resource Limits Screenshot
Event History Screenshot
Event Stats Screenshot
Graphs Screenshot
Completed Jobs Screenshot
Job In Progress Screenshot
Job Success Screenshot
Job Failed Screenshot
My Account Screenshot
Activity Log Screenshot
API Keys Screenshot
Editing API Key Screenshot
Categories Screenshot
Edit Category Screenshot
Plugins Screenshot

Serve Cronicle on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxying cronicle.example.com to http://cronicle:5000

Add this to your Caddyfile

cronicle.example.com {
	reverse_proxy http://cronicle:5000
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs <container>
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Port already in use

If deployment fails with "Bind for 0.0.0.0:5000 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :5000
  • Stop the other service, or pick a different host port. In 5000:5000 only the left number is yours to change, the right one belongs to the app.

Running but the page won't load

The container is up but nothing appears in your browser.

  • Use your server's real IP: http://your-server-ip:5000. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, cronicle can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 5000

Image won't pull

Test the pull directly on the host: docker pull soulteary/cronicle:0.9.80

  • "manifest unknown" means the tag no longer exists.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • This image supports: amd64, arm64, arm/v7
  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.

  • Check the logs right after a restart, the last few lines before it died are the useful ones.
  • Get the exit code with docker inspect <container> --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Stack won't deploy

Compose stacks fail fast on small mistakes, and Portainer shows the reason just above the editor.

  • YAML only accepts spaces for indentation, a single tab breaks the whole file.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A Compose stack

Cronicle is a Compose stack, a set of containers defined in one file and brought up together by Portainer, then started and stopped as a single app.

The app image

An image is the app packed up ready to go, everything Cronicle needs bundled into one download. This template pulls soulteary/cronicle:0.9.80, which Docker fetches once (about 65 MB) and then starts your own copy from.

Where the image comes from

Docker pulls its images from registries, public libraries of ready-built apps. Cronicle's comes from Docker Hub, published by soulteary.

Version tags

The bit after the colon in the image name is the version tag. This one pins 0.9.80, so every redeploy gives you that exact build until you bump it yourself.

Which machines it runs on

Every image is built for particular CPU types. This one ships for amd64, arm64, arm/v7, so it runs on both regular x86 servers and ARM boards like a Raspberry Pi.

Ports

A port is the door the app answers on. A mapping like 5000:5000 means it's reachable on port 5000 of your server, where the left number is yours to change and the right one belongs to the app. It opens:

  • 5000:5000

Volumes

A volume is where Cronicle keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /opt/cronicle/data kept in the crondata volume Docker manages
  • /opt/cronicle/logs kept in the cronlogs volume Docker manages

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Cronicle takes 2 of them, all with defaults you can leave alone or tweak:

  • CRONICLE_WebServer__http_port, defaults to 5000
  • CRONICLE_web_direct_connect, defaults to false

Restart policy

The restart policy here is unless-stopped, so Docker restarts Cronicle after a crash or reboot, but leaves it off when you stop it on purpose. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).

Networking

Nothing custom is set, so Cronicle sits on Docker's default bridge network: its own private space that reaches the outside world only through the ports it publishes.

Container name

Once it's deployed, Portainer names the container cronicle. That's what you'll spot in the containers list and use in commands like docker logs cronicle.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Cronicle up. Add the template list to Portainer once, then deploying Cronicle is a click rather than a wall of config.