Deployment

CronLord wants to be boring to run: one binary, one SQLite file, one log directory. This page covers the setups that actually show up in production.

Single-host Docker

Fast to stand up, trivial to upgrade.

# docker-compose.yml
services:
  cronlord:
    image: ghcr.io/kdairatchi/cronlord:latest
    restart: unless-stopped
    ports: ["7070:7070"]
    environment:
      CRONLORD_ADMIN_TOKEN: "${CRONLORD_ADMIN_TOKEN}"
    volumes:
      - cronlord-data:/var/lib/cronlord
      - ./cronlord.toml:/app/cronlord.toml:ro
volumes:
  cronlord-data:

Upgrade path:

docker compose pull && docker compose up -d

SQLite WAL survives container restarts cleanly. The data volume is the only thing you ever need to back up.

Verify image signatures

Every tagged image is signed with keyless cosign via GitHub’s OIDC provider. Confirm a pull came from this repo’s release workflow before you run it:

cosign verify ghcr.io/kdairatchi/cronlord:latest \
  --certificate-identity-regexp='https://github.com/kdairatchi/CronLord/\.github/workflows/release\.yml.*' \
  --certificate-oidc-issuer='https://token.actions.githubusercontent.com'

The command exits 0 on a valid signature chain and prints the signing workflow identity on success. Wire it into your pull pipeline if you care about supply-chain integrity.

systemd (bare metal)

Either use scripts/install.sh or drop contrib/cronlord.service manually. The unit is hardened by default:

This is intentionally more locked-down than what most jobs need. If a shell job legitimately needs to write outside /var/lib/cronlord, add the path to ReadWritePaths rather than removing protections.

Upgrade

systemctl stop cronlord
curl -fsSL https://github.com/kdairatchi/CronLord/releases/latest/download/cronlord-linux-amd64.tar.gz | tar -xz -C /tmp
install -m 0755 /tmp/cronlord /usr/local/bin/cronlord
systemctl start cronlord

Migrations run automatically on boot. If a migration fails the scheduler exits before binding port 7070 - check journalctl.

Reverse proxy + TLS

CronLord binds HTTP only. Put it behind nginx/Caddy/Traefik for TLS.

Caddy

cron.example.com {
  reverse_proxy 127.0.0.1:7070
}

That’s it. Caddy fetches certs automatically. The admin token on the scheduler handles API auth; for the UI add Caddy basic-auth or your SSO provider.

nginx

server {
  server_name cron.example.com;
  listen 443 ssl http2;

  ssl_certificate     /etc/letsencrypt/live/cron.example.com/fullchain.pem;
  ssl_certificate_key /etc/letsencrypt/live/cron.example.com/privkey.pem;

  location / {
    proxy_pass http://127.0.0.1:7070;
    proxy_set_header Host $host;
    proxy_set_header X-Forwarded-For $remote_addr;
    # SSE streams for run logs - disable buffering:
    proxy_buffering off;
    proxy_cache off;
    proxy_read_timeout 1h;
  }
}

The proxy_buffering off is important - without it SSE log tailing shows nothing until the connection closes.

Cloudflare Tunnel

cloudflared tunnel --url http://127.0.0.1:7070

Add your Access policy in the Cloudflare dashboard. CronLord doesn’t need to know; it just serves HTTP to the tunnel.

Backups

Everything lives in data_dir (default /var/lib/cronlord):

A consistent snapshot is as simple as:

sqlite3 /var/lib/cronlord/cronlord.db ".backup /backup/cronlord-$(date -I).db"

Or rsync the whole directory with the service stopped (WAL is safe to copy while running, but stopping is cleaner for a full snapshot).

Running a worker

Workers are the same binary run in polling mode on a different host. They hold no state and carry no DB - one process per host is plenty for most loads, several per host if you want to run jobs in parallel.

1. Register the worker on the scheduler

From the scheduler host:

cronlord worker register runner-linux-1 --label linux
# prints:
#   id:     b1d7...
#   secret: 47caaaeb...   (shown once)

Or do it from the web UI at /workers/new - it also prints the derived HMAC key and a ready-to-paste env block.

2. Derive the HMAC key

The worker signs with sha256(plaintext_secret), not the plaintext. Hash it once on the worker host:

export CRONLORD_HMAC_KEY=$(printf '%s' "$PLAIN_SECRET" | openssl dgst -sha256 | awk '{print $2}')

The plaintext never leaves this host.

3. Start the worker

export CRONLORD_URL=https://cron.example.com
export CRONLORD_WORKER_ID=b1d7...
export CRONLORD_HMAC_KEY=...     # from step 2
cronlord worker run --name runner-linux-1

The worker polls every 5 seconds when idle, claims one run at a time, heartbeats every lease / 2 seconds while executing, and POSTs the result when done.

Supported job kinds on workers

systemd unit for a worker

Adapt contrib/cronlord.service - the safe minimum:

[Service]
Environment=CRONLORD_URL=https://cron.example.com
Environment=CRONLORD_WORKER_ID=b1d7...
EnvironmentFile=/etc/cronlord-worker.env   # holds CRONLORD_HMAC_KEY
ExecStart=/usr/local/bin/cronlord worker run
User=cronlord
Restart=on-failure

CRONLORD_HMAC_KEY belongs in a 0600 env file, never in a committed unit file.

Scaling

Jobs are handed out in FIFO order - the oldest queued run matching a worker’s labels is leased first. If two workers both advertise linux, they race for leases; whichever polls first wins. This is safe because try_lease! is a conditional UPDATE under SQLite’s serializable-writes guarantee.

If a worker crashes mid-run, the lease reaper re-queues the run after lease_expires_at passes (scheduler side; default 30 s tick). Another worker picks it up on the next poll.

High availability

The scheduler is single-node today (workers scale out, the scheduler does not). Two schedulers against one SQLite file will corrupt each other - don’t do it. If you need HA today, do active/passive with shared storage (NFS/EBS) and a watchdog that fails over on health check miss.

Multi-master (via embedded Raft or external Postgres) is on the roadmap.

Resource sizing

CronLord itself uses ~15 MB RSS idle. The expensive thing is what your jobs do. Sizing guidance:

The scheduler thread is tickless - it only wakes when the next job is due. Idle CPU is zero.

Logs

The reaper purges run logs older than 30 days on a daily tick. Override with CRONLORD_LOG_TTL_DAYS - set to 7 for aggressive trimming, or 0 to disable auto-rotation. Very large logs still count against your data volume during the retention window - size accordingly.

Troubleshooting