expose log dir to /config volume

Reviewed-on: #1

.drone.yml

@@ -0,0 +1,126 @@
+kind: pipeline
+type: docker
+name: build-main-images
+trigger:
+  event:
+    exclude:
+    - pull_request
+  ref:
+    - refs/heads/main
+    - refs/tags/**
+
+platform:
+  os: linux
+  arch: amd64
+
+steps:
+
+- name: get-tags
+  image: docker:git
+  commands:
+    - git fetch --tags
+  when:
+    ref:
+      - refs/tags/**
+
+  # Set tags for main branch
+- name: make-tags
+  image: node
+  commands:
+    - echo -n "${DRONE_COMMIT_SHA:0:8}, latest" > .tags
+  when:
+    ref:
+      - refs/heads/main
+
+- name: make-tags-release
+  image: node
+  commands:
+    - echo -n "${DRONE_TAG}, latest" > .tags
+  when:
+    ref:
+      - refs/tags/**
+
+  # Build containers from main branch
+- name: build
+  image: thegeeklab/drone-docker-buildx
+  privileged: true
+  settings:
+    provenance: false
+    registry: git.mrmeeb.stream
+    username: 
+      from_secret: docker_username
+    password: 
+      from_secret: docker_password
+    repo: git.mrmeeb.stream/mrmeeb/cronicle
+    platforms:
+      - linux/arm64
+      - linux/amd64
+
+- name: release
+  image: goreleaser/goreleaser
+  environment:
+    GITEA_TOKEN:
+      from_secret: gitea_token
+  commands:
+    - goreleaser release
+  when:
+    ref:
+      - refs/tags/**
+
+- name: notify
+  image: plugins/slack
+  when:
+    status:
+    - success
+    - failure
+  settings:
+    webhook: 
+      from_secret: slack_webhook
+
+---
+kind: pipeline
+type: docker
+name: build-develop-images
+trigger:
+  event:
+    exclude:
+    - pull_request
+  branch:
+    - develop
+
+platform:
+  os: linux
+  arch: amd64
+
+steps:
+  # Set tags for develop branch - git commit SHA and 'develop'
+- name: make-tags
+  image: node
+  commands:
+    - echo -n "develop-${DRONE_COMMIT_SHA:0:8}, develop" > .tags
+   
+  # Build containers from develop branch
+- name: build
+  image: thegeeklab/drone-docker-buildx
+  privileged: true
+  settings:
+    provenance: false
+    registry: git.mrmeeb.stream
+    username: 
+      from_secret: docker_username
+    password: 
+      from_secret: docker_password
+    repo: git.mrmeeb.stream/mrmeeb/cronicle
+    platforms:
+      - linux/arm64
+      - linux/amd64
+
+- name: notify
+  image: plugins/slack
+  when:
+    status:
+    - success
+    - failure
+  settings:
+    webhook: 
+      from_secret: slack_webhook

.gitignore

@@ -0,0 +1,2 @@
+dist/
+.tags

.goreleaser.yaml

@@ -0,0 +1,25 @@
+build:
+  skip: true
+
+archives:
+- format: binary
+
+release:
+  draft: true
+  gitea:
+    owner: MrMeeb
+    name: cronicle-docker
+
+changelog:
+  sort: asc
+  filters:
+    exclude:
+      - '^docs:'
+      - '^test:'
+
+# .goreleaser.yaml
+gitea_urls:
+  api: https://git.mrmeeb.stream/api/v1
+  download: https://git.mrmeeb.stream
+  # set to true if you use a self-signed certificate
+  skip_tls_verify: false

Dockerfile

@@ -0,0 +1,61 @@
+FROM alpine:latest as base
+ARG TARGETARCH
+
+FROM base AS base-amd64
+ENV S6_OVERLAY_ARCH=x86_64
+
+FROM base AS base-arm64
+ENV S6_OVERLAY_ARCH=aarch64
+
+FROM base-${TARGETARCH}${TARGETVARIANT}
+
+ARG S6_OVERLAY_VERSION=3.1.5.0
+ARG CRONICLE_EDGE_VERSION=1.6.2
+
+ENV CRONICLE_foreground=1
+ENV CRONICLE_echo=1
+ENV CRONICLE_color=1
+ENV EDITOR=nano
+ENV MODE=manager
+ENV PUID=1000
+ENV PGID=1000
+ENV TZ=UTC
+ENV LOG_LEVEL=9
+
+#Get required packages
+RUN apk update && apk add tzdata curl shadow bash xz git procps nodejs npm nano
+
+#Make folders
+RUN mkdir /config && \
+    mkdir /app && \
+#Create default user
+    useradd -u 1000 -U -d /config -s /bin/false cronicle && \
+    usermod -G users cronicle
+
+#Install s6-overlay
+RUN curl -fsSL "https://github.com/just-containers/s6-overlay/releases/download/v${S6_OVERLAY_VERSION}/s6-overlay-noarch.tar.xz" | tar Jpxf - -C / && \
+    curl -fsSL "https://github.com/just-containers/s6-overlay/releases/download/v${S6_OVERLAY_VERSION}/s6-overlay-${S6_OVERLAY_ARCH}.tar.xz" | tar Jpxf - -C / && \
+    curl -fsSL "https://github.com/just-containers/s6-overlay/releases/download/v${S6_OVERLAY_VERSION}/s6-overlay-symlinks-noarch.tar.xz" | tar Jpxf - -C / && \
+    curl -fsSL "https://github.com/just-containers/s6-overlay/releases/download/v${S6_OVERLAY_VERSION}/s6-overlay-symlinks-arch.tar.xz" | tar Jpxf - -C /
+ENV S6_BEHAVIOUR_IF_STAGE2_FAILS=2 S6_CMD_WAIT_FOR_SERVICES_MAXTIME=0 S6_VERBOSITY=1
+
+#Install Cronicle
+RUN mkdir /app/cronicle && \
+    cd /app/cronicle && \
+    wget https://github.com/cronicle-edge/cronicle-edge/archive/refs/tags/v${CRONICLE_EDGE_VERSION}.tar.gz && \
+    tar -xf v${CRONICLE_EDGE_VERSION}.tar.gz --strip-components 1 && \
+    rm -rf Docker* .gitignore Readme.md .vscode && \
+    rm -rf v${CRONICLE_EDGE_VERSION}.tar.gz
+
+WORKDIR /app/cronicle
+RUN npm install && \
+    node bin/build dist
+
+COPY root/ /
+RUN chmod +x /cronicle-prepare.sh && \
+    chmod +x /container-init.sh && \
+    chown -R ${PUID}:${PGID} /app /config
+
+EXPOSE 3012
+
+ENTRYPOINT [ "/init" ]

README.md

@@ -1,3 +1,114 @@
-# cronicle-docker
+# Cronicle Docker
 
-Dockerised Cronicle, based on the Cronicle-Edge fork
+![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 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`.
+
+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
+
+|Tag    |Description|
+|-------|-----------|
+|latest |Latest image built from the main branch. Usually coincides with a tagged release.|
+|develop|Latest image built from the develop branch. Commits are made to the develop branch before being merged to main. Old versions of `develop` are removed after 14 days.|
+
+Tags relating to releases are also available, for locking in on a specific version.
+
+## Running 
+
+`config.json`, located in `/config/cronicle/conf/config.json`, is automatically generated on the first run of Cronicle in 'manager' mode. This file must be kept identical between the manager and any workers it controls.
+
+If you want to configure Cronicle before first run (e.g to use a different storage engine), download `config_sample.json` and adjust accordingly before placing in `/config/cronicle/conf/config.json`. Make sure to change the `secret`!
+
+:exclamation: You must define the hostname of the container. Cronicle expects the hostname to remain the same, so the randomly-generated container hostname can cause problems if it changes. :exclamation:
+
+### Docker CLI
+```
+docker run -d --name cronicle \
+    --hostname cronicle-manager \
+    -p 3012:3012 \
+    -e MODE=manager \
+    -e PUID=1000 \
+    -e PGID=1000 \
+    -e TZ=Europe/London \
+    -v {path on host}:/config
+    git.mrmeeb.stream/mrmeeb/cronicle:latest 
+```
+
+### Docker Compose
+
+```
+version: '3'
+services:
+  cronicle:
+    container_name: cronicle
+    image: git.mrmeeb.stream/mrmeeb/cronicle:latest
+    restart: unless-stopped
+    hostname: cronicle-manager
+    ports:
+      - 3012:3012
+    volumes:
+      - {path on host}:/config
+    environment:
+      - MODE=manager
+      - PUID=1000
+      - PGID=1000
+      - TZ=Europe/London
+```
+
+## Custom Scripts
+
+This container automatically checks for scripts in `/config/init` and runs them at startup. This could be useful if you need to install additional applications into a worker container so it can execute jobs.
+
+## Ports
+
+|Port |Description|
+|-----|-----------|
+|3012 |WebUI and communication between manager and workers|
+
+## Volumes
+
+|Mount |Description|
+|------|-----------|
+|/config |Persistent config file and job configurations|
+
+## Environment Variables
+|Variable|Options|Default|Description|
+|--------|-------|-------|-------|
+|MODE    |manager, worker|manager|Determines what mode Cronicle runs in
+|PUID    |int    |1000   |Sets the UID of the user Cronicle runs under
+|PGID    |int    |1000   |Sets the GID of the user Cronicle runs under
+|TZ      |[List of valid TZs](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List)    |UTC    |Sets the timezone of the container and by extension Cronicle
+|LOG_LEVEL|1-10  |9      |Sets log level from `1` (quietest) to `10` (loudest)|

config_sample.json

@@ -0,0 +1,149 @@
+{
+	"base_app_url": "http://localhost:3012",
+	"email_from": "admin@cronicle.com",
+	"smtp_hostname": "mailrelay.cronicle.com",
+	"smtp_port": 25,
+	"secret_key": "f5cb3d08bad903c6a12b84f666070630",
+	"ad_domain": "corp.cronicle.com",
+		
+	"log_dir": "logs",
+	"log_filename": "[component].log",
+	"log_columns": ["hires_epoch", "date", "hostname", "pid", "component", "category", "code", "msg", "data"],
+	"log_archive_path": "logs/archives/[yyyy]/[mm]/[dd]/[filename]-[yyyy]-[mm]-[dd].log.gz",
+	"log_crashes": true,
+	"pid_file": "logs/cronicled.pid",
+	"copy_job_logs_to": "",
+	"queue_dir": "queue",
+	"debug_level": 6,
+	"maintenance": "04:00",
+	"list_row_max": 10000,
+	"job_data_expire_days": 180,
+	"child_kill_timeout": 10,
+	"dead_job_timeout": 120,
+	"manager_ping_freq": 20,
+	"manager_ping_timeout": 60,
+	"udp_broadcast_port": 3014,
+	"scheduler_startup_grace": 10,
+	"universal_web_hook": "",
+	"track_manual_jobs": false,
+	"max_jobs": 0,
+	
+	"server_comm_use_hostnames": true,
+	"web_direct_connect": false,
+	"web_socket_use_hostnames": true,
+	
+	"job_memory_max": 1073741824,
+	"job_memory_sustain": 0,
+	"job_cpu_max": 0,
+	"job_cpu_sustain": 0,
+	"job_log_max_size": 0,
+	"job_env": {},
+	
+	"web_hook_text_templates": {
+		"job_start": "🚀 *[event_title]* started on [hostname] <[job_details_url] | More details>",
+		"job_complete": "✔️ *[event_title]* completed successfully on [hostname] <[job_details_url] | More details>",
+		"job_warning": "⚠️ *[event_title]* completed with warning on [hostname]:\nWarning: _*[description]*_\n <[job_details_url] | More details>",
+		"job_failure": "❌ *[event_title]* failed on [hostname]:\nError: _*[description]*_\n <[job_details_url] | More details>",
+		"job_launch_failure": "💥 Failed to launch *[event_title]*:\n*[description]*\n<[edit_event_url] | More details>"
+	  },
+	
+	"client": {
+		"name": "Cronicle",
+		"debug": 1,
+		"default_password_type": "password",
+		"privilege_list": [
+			{ "id": "admin", "title": "Administrator" },
+			{ "id": "create_events", "title": "Create Events" },
+			{ "id": "edit_events", "title": "Edit Events" },
+			{ "id": "delete_events", "title": "Delete Events" },
+			{ "id": "run_events", "title": "Run Events" },
+			{ "id": "abort_events", "title": "Abort Events" },
+			{ "id": "state_update", "title": "Toggle Scheduler" }
+		],
+		"new_event_template": { 
+			"enabled": 1, 
+			"params": {}, 
+			"timing": { "minutes": [0] },
+			"max_children": 1,
+			"timeout": 3600,
+			"catch_up": 0,
+			"queue_max": 1000
+		}
+	},
+
+	"git": {
+		"enabled": false,
+		"auto": false,
+		"user": "cronicle",
+		"email": "croncile@cronicle.com",
+		"remote": "origin",
+		"branch": "master"
+	},
+	
+	"Storage": {
+		"engine": "Filesystem",
+		"list_page_size": 50,
+		"concurrency": 4,
+		"log_event_types": { "get": 1, "put": 1, "head": 1, "delete": 1, "expire_set": 1 },
+		
+		"Filesystem": {
+			"base_dir": "data",
+			"key_namespaces": 1
+		}
+	},
+	
+	"WebServer": {
+		"http_port": 3012,
+		"http_htdocs_dir": "htdocs",
+		"http_max_upload_size": 104857600,
+		"http_static_ttl": 3600,
+		"http_static_index": "index.html",
+		"http_server_signature": "Cronicle 1.0",
+		"http_gzip_text": true,
+		"http_timeout": 30,
+		"http_regex_json": "(text|javascript|js|json)",
+		"http_response_headers": {
+			"Access-Control-Allow-Origin": "*"
+		},
+		
+		"https": false,
+		"https_port": 3013,
+		"https_cert_file": "conf/ssl.crt",
+		"https_key_file": "conf/ssl.key",
+		"https_force": false,
+		"https_timeout": 30,
+		"https_header_detect": {
+			"Front-End-Https": "^on$",
+			"X-Url-Scheme": "^https$",
+			"X-Forwarded-Protocol": "^https$",
+			"X-Forwarded-Proto": "^https$",
+			"X-Forwarded-Ssl": "^on$"
+		}
+	},
+	
+	"User": {
+		"session_expire_days": 30,
+		"max_failed_logins_per_hour": 5,
+		"max_forgot_passwords_per_hour": 3,
+		"free_accounts": false,
+		"sort_global_users": true,
+		"use_bcrypt": true,
+		
+		"email_templates": {
+			"welcome_new_user": "conf/emails/welcome_new_user.txt",
+			"changed_password": "conf/emails/changed_password.txt",
+			"recover_password": "conf/emails/recover_password.txt"
+		},
+		
+		"default_privileges": {
+			"admin": 0,
+			"create_events": 1,
+			"edit_events": 1,
+			"delete_events": 1,
+			"run_events": 0,
+			"abort_events": 0,
+			"state_update": 0
+		}
+	}
+	
+}

root/container-init.sh

@@ -0,0 +1,54 @@
+#!/command/with-contenv bash
+# shellcheck shell=bash
+
+echo ""
+echo ""
+echo "================================================"
+echo "|      __  _______  __  ___________________    |" 
+echo "|     /  |/  / __ \/  |/  / ____/ ____/ __ )   |"
+echo "|    / /|_/ / /_/ / /|_/ / __/ / __/ / __  |   |"
+echo "|   / /  / / _, _/ /  / / /___/ /___/ /_/ /    |"
+echo "|  /_/  /_/_/ |_/_/  /_/_____/_____/_____/     |"
+echo "|                                              |"
+echo "================================================"
+echo ""
+echo "Initialising container"
+echo "
+----------------------------------------------------------------------
+ENVIRONMENT
+----------------------------------------------------------------------
+PUID=${PUID}
+PGID=${PGID}
+TZ=${TZ}
+MODE=${MODE}
+LOG_LEVEL=${LOG_LEVEL}
+----------------------------------------------------------------------
+"
+
+#Setting UID and GID as configured
+if [[ ! "${PUID}" -eq 0 ]] && [[ ! "${PGID}" -eq 0 ]]; then
+    echo "Executing usermod..."
+    mkdir "/tmp/temphome"
+    usermod -d "/tmp/temphome" cronicle
+    usermod -o -u "${PUID}" cronicle
+    usermod -d /config cronicle
+    rm -rf "/tmp/temphome"
+    groupmod -o -g "${PGID}" cronicle
+else
+    echo "Running as root is not supported, please fix your PUID and PGID!"
+    exit 1
+fi
+
+echo "Checking permissions in /config and /app."
+
+if [ ! "$(stat -c %u /app)" -eq "${PUID}" ] || [ ! "$(stat -c %g /app)" -eq "${PGID}" ]
+then
+    echo "Fixing permissions for /app (this can take some time)."
+    chown -R cronicle:cronicle /app
+fi
+
+if [ ! "$(stat -c %u /config)" -eq "${PUID}" ] || [ ! "$(stat -c %g /config)" -eq "${PGID}" ]
+then
+    echo "Fixing permissions for /config (this can take some time)."
+    chown -R cronicle:cronicle /config
+fi

root/cronicle-prepare.sh

@@ -0,0 +1,124 @@
+#!/command/with-contenv bash
+# shellcheck shell=bash
+
+echo "Preparing Cronicle"
+
+#Importing and running additional scripts placed in /config/init
+if [ -d /config/init ]
+then
+	if [ "$(ls -A /config/init)" ]
+    then
+
+        echo "Running additional startup scripts."
+
+        bash /config/init/*
+	
+    else
+        
+        echo "/config/init is empty - no additional startup scripts detected."
+	
+    fi
+else
+
+	echo "Directory /config/init not found. Creating."
+
+    mkdir /config/init
+
+fi
+
+if [ ! -d /config/cronicle ]
+then
+    echo "Directory /config/cronicle not found. Creating."
+
+    mkdir /config/cronicle
+fi
+
+#Detecting what mode Cronicle should be started in
+if [ $MODE == "manager" ] 
+then
+
+    echo "Cronicle is running in 'manager' mode."
+
+    #Copying config directory to /config/cronicle/conf if not already there, then linking back into Cronicle
+    if [ ! -d /config/cronicle/conf ]
+    then
+
+        echo "Config dir is missing, creating."
+
+        cp -r /app/cronicle/conf /config/cronicle/conf
+        rm -rf /app/cronicle/conf
+        ln -s /config/cronicle/conf /app/cronicle/conf
+    else
+
+        echo "Config dir already exists. Doesn't need creating."
+        echo "Linking persistent config dir back into Cronicle."
+        rm -rf /app/cronicle/conf
+        ln -s /config/cronicle/conf /app/cronicle/conf
+
+    fi
+
+    if [ ! -f /config/cronicle/data/.setup_done ]
+    then
+
+        echo "Setup needed - running now."
+
+        /app/cronicle/bin/control.sh setup
+        touch /app/cronicle/data/.setup_done
+
+        #Moving data dir to /config, then linking it back into Cronicle
+        mv -n /app/cronicle/data /config/cronicle/data
+        rm -rf /app/cronicle/data
+        ln -s /config/cronicle/data /app/cronicle/data
+
+    else
+
+        echo "Setup already completed."
+
+        rm -rf /app/cronicle/data
+        ln -s /config/cronicle/data /app/cronicle/data
+
+    fi
+
+elif [ $MODE == "worker" ] 
+then
+
+    echo "Cronicle is running in 'worker' mode."
+
+    if [ ! -f /config/cronicle/conf/config.json ]
+    then
+
+        echo "No config found. Copy config.json from the manager server and place it in /config/cronicle/conf dir."
+        mkdir -p /config/cronicle/conf
+        exit 0
+
+    else
+
+        #Removing default config.json and linking provided one back into Cronicle
+        rm -rf /app/cronicle/conf/config.json
+        ln -s /config/cronicle/conf/config.json /app/cronicle/conf/config.json
+
+    fi
+
+else
+
+    echo "'$MODE' is not a recognised appion for the MODE environment variable. Accepted appions are 'manager' and 'worker'."
+
+fi
+
+#Expose log directory
+if [ ! -d /config/cronicle/logs ]
+then
+
+    echo "Logs dir is missing, creating."
+
+    cp -r /app/cronicle/logs /config/cronicle/logs
+    rm -rf /app/cronicle/logs
+    ln -s /config/cronicle/logs /app/cronicle/logs
+else
+
+    echo "Logs dir already exists. Doesn't need creating."
+    echo "Linking persistent logs dir back into Cronicle."
+    rm -rf /app/cronicle/logs
+    ln -s /config/cronicle/logs /app/cronicle/logs
+
+fi

root/etc/s6-overlay/s6-rc.d/container-init/type

@@ -0,0 +1 @@
+oneshot

root/etc/s6-overlay/s6-rc.d/container-init/up

@@ -0,0 +1 @@
+/container-init.sh

root/etc/s6-overlay/s6-rc.d/cronicle-prepare/type

@@ -0,0 +1 @@
+oneshot

root/etc/s6-overlay/s6-rc.d/cronicle-prepare/up

@@ -0,0 +1 @@
+exec s6-setuidgid cronicle /cronicle-prepare.sh

root/etc/s6-overlay/s6-rc.d/cronicle/finish

@@ -0,0 +1 @@
+echo "$e" > /run/s6-linux-init-container-results/exitcode

root/etc/s6-overlay/s6-rc.d/cronicle/run

@@ -0,0 +1,3 @@
+#!/command/with-contenv bash
+# shellcheck shell=bash
+exec s6-setuidgid cronicle node /app/cronicle/lib/main.js --debug_level ${LOG_LEVEL} --color ${CRONICLE_color}

root/etc/s6-overlay/s6-rc.d/cronicle/type

@@ -0,0 +1 @@
+longrun