Merge pull request 'typo correction on readme [CI SKIP]' (#5) from develop into main [CI SKIP]

Reviewed-on: #5

.drone.yml

@@ -1,11 +1,12 @@
 kind: pipeline
 type: docker
-name: build-release-images
+name: build-main-images
 trigger:
   event:
     exclude:
     - pull_request
   ref:
+    - refs/heads/main
     - refs/tags/**
 
 platform:
@@ -13,14 +14,42 @@ platform:
   arch: amd64
 
 steps:
-  # Set tags for main branch - release tag and 'latest'
+
-- name: make-tags-main
+- name: get-tags
+  image: docker:git
+  commands:
+    - git fetch --tags
+  when:
+    ref:
+      - refs/tags/**
+  depends_on:
+    - clone
+
+  # 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
+  depends_on:
+    - get-tags
+    - clone
+
+- name: make-tags-release
   image: node
   commands:
     - echo -n "${DRONE_TAG}, latest" > .tags
+  when:
+    ref:
+      - refs/tags/**
+  depends_on:
+    - get-tags
+    - clone
 
-  # Build containers from main branch when released
+  # Build containers from main branch
-- name: build-main
+- name: build-gitea
   image: thegeeklab/drone-docker-buildx
   privileged: true
   settings:
@@ -34,14 +63,53 @@ steps:
     platforms:
       - linux/arm64
       - linux/amd64
+  depends_on:
+    - make-tags
+    - make-tags-release
 
-- name: release
+- name: build-github
+  image: thegeeklab/drone-docker-buildx
+  privileged: true
+  settings:
+    provenance: false
+    registry: ghcr.io
+    username: 
+      from_secret: docker_username
+    password: 
+      from_secret: github_token
+    repo: ghcr.io/mrmeeb/cronicle
+    platforms:
+      - linux/arm64
+      - linux/amd64
+  depends_on:
+    - make-tags
+    - make-tags-release
+
+- name: release-gitea
   image: goreleaser/goreleaser
   environment:
     GITEA_TOKEN:
       from_secret: gitea_token
   commands:
-    - goreleaser release
+    - goreleaser release -f .goreleaser-gitea.yaml
+  when:
+    ref:
+      - refs/tags/**
+  depends_on:
+    - build-gitea
+
+- name: release-github
+  image: goreleaser/goreleaser
+  environment:
+    GITHUB_TOKEN:
+      from_secret: github_token
+  commands:
+    - goreleaser release -f .goreleaser-github.yaml
+  when:
+    ref:
+      - refs/tags/**
+  depends_on:
+    - build-github
 
 - name: notify
   image: plugins/slack
@@ -52,6 +120,11 @@ steps:
   settings:
     webhook: 
       from_secret: slack_webhook
+  depends_on:
+    - release-gitea
+    - release-github
+    - build-github
+    - build-gitea
 
 ---
 kind: pipeline
@@ -70,13 +143,13 @@ platform:
 
 steps:
   # Set tags for develop branch - git commit SHA and 'develop'
-- name: make-tags-develop
+- name: make-tags
   image: node
   commands:
-    - echo -n "${DRONE_COMMIT_SHA:0:8}, develop" > .tags
+    - echo -n "develop-${DRONE_COMMIT_SHA:0:8}, develop" > .tags
    
   # Build containers from develop branch
-- name: build-develop
+- name: build-gitea
   image: thegeeklab/drone-docker-buildx
   privileged: true
   settings:
@@ -90,6 +163,25 @@ steps:
     platforms:
       - linux/arm64
       - linux/amd64
+  depends_on:
+    - make-tags
+
+- name: build-github
+  image: thegeeklab/drone-docker-buildx
+  privileged: true
+  settings:
+    provenance: false
+    registry: ghcr.io
+    username: 
+      from_secret: docker_username
+    password: 
+      from_secret: github_token
+    repo: ghcr.io/mrmeeb/cronicle
+    platforms:
+      - linux/arm64
+      - linux/amd64
+  depends_on:
+    - make-tags
 
 - name: notify
   image: plugins/slack
@@ -100,3 +192,6 @@ steps:
   settings:
     webhook: 
       from_secret: slack_webhook
+  depends_on:
+    - build-gitea
+    - build-github

.gitignore

@@ -0,0 +1,3 @@
+dist-gitea/
+dist-github/
+.tags

.goreleaser-gitea.yaml

@@ -1,3 +1,5 @@
+dist: dist-gitea
+
 build:
   skip: true
 

.goreleaser-github.yaml

@@ -0,0 +1,20 @@
+dist: dist-github
+
+build:
+  skip: true
+
+archives:
+- format: binary
+
+release:
+  draft: true
+  github:
+    owner: MrMeeb
+    name: cronicle-docker
+
+changelog:
+  sort: asc
+  filters:
+    exclude:
+      - '^docs:'
+      - '^test:'

Dockerfile

@@ -1,35 +1,61 @@
-FROM alpine:latest
+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=vi
+ENV EDITOR=nano
 ENV MODE=manager
+ENV PUID=1000
+ENV PGID=1000
+ENV TZ=UTC
+ENV LOG_LEVEL=9
 
-#RUN apt update && apt install -y tini curl git procps
+#Get required packages
+RUN apk update && apk add tzdata curl shadow bash xz git procps nodejs npm nano
 
-RUN apk update && apk add bash tini git procps nodejs npm
+#Make folders
+RUN mkdir /config && \
+    mkdir /app && \
+#Create default user
+    useradd -u 1000 -U -d /config -s /bin/false cronicle && \
+    usermod -G users cronicle
 
-RUN git clone https://github.com/cronicle-edge/cronicle-edge.git /opt/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
 
-WORKDIR /opt/cronicle
+#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
 
-RUN npm install
+WORKDIR /app/cronicle
+RUN npm install && \
+    node bin/build dist
 
-RUN node bin/build dist
+COPY root/ /
-
+RUN chmod +x /cronicle-prepare.sh && \
-COPY run.sh /
+    chmod +x /container-init.sh && \
-
+    chown -R ${PUID}:${PGID} /app /config
-RUN chmod +x /run.sh
-
-RUN mkdir /config
-
-RUN adduser --disabled-password --no-create-home cronicle
-
-#RUN ln -sf /dev/stdout /opt/cronicle/logs/Cronicle.log
 
 EXPOSE 3012
 
-ENTRYPOINT ["/sbin/tini", "--"]
+ENTRYPOINT [ "/init" ]
-
-CMD [ "/run.sh" ]

README.md

@@ -1,16 +1,58 @@
 # Cronicle Docker
 
-Dockerised Cronicle, based on the [Cronicle-Edge](https://github.com/cronicle-edge/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)
 
-Can function in both the **manager** and **worker** role.
+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) (also published to GHCR)
+- :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`.
+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: NOTE: 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:
+: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
 ```
@@ -69,3 +111,4 @@ This container automatically checks for scripts in `/config/init` and runs them
 |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)|

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

run.sh

@@ -1,86 +0,0 @@
-#!/bin/bash
-
-#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
-
-#Detecting what mode Cronicle should be started in
-if [ $MODE == "manager" ] 
-then
-    echo "Cronicle is running in 'manager' mode."
-    
-    #Copying config.json to /config if it isn't there already, then linking it back into Cronicle
-    mv -n /opt/cronicle/conf/config.json /config/config.json
-    rm -rf /opt/cronicle/conf/config.json
-    ln -s /config/config.json /opt/cronicle/conf/config.json
-
-    if [ ! -f /config/data/.setup_done ]
-    then
-
-        echo "Setup needed - running now."
-
-        /opt/cronicle/bin/control.sh setup
-        touch /opt/cronicle/data/.setup_done
-
-        #Moving data dir to /config, then linking it back into Cronicle
-        mv -n /opt/cronicle/data /config/data
-        rm -rf /opt/cronicle/data
-        ln -s /config/data /opt/cronicle/data
-
-        exec node /opt/cronicle/lib/main.js --color 1
-
-    else
-
-        rm -rf /opt/cronicle/data
-        ln -s /config/data /opt/cronicle/data
-
-        exec node /opt/cronicle/lib/main.js --color 1
-
-    fi
-
-elif [ $MODE == "worker" ] 
-then
-
-    echo "Cronicle is running in 'worker' mode."
-
-    if [ ! -f /config/config.json ]
-    then
-
-        echo "No config found. Copy config.json from the manager server and place it in the /config dir."
-
-        exit 0
-
-    else
-
-        #Removing default config.json and linking provided one back into Cronicle
-        rm -rf /opt/cronicle/conf/config.json
-        ln -s /config/config.json /opt/cronicle/conf/config.json
-
-        exec node /opt/cronicle/lib/main.js --color 1
-
-    fi
-
-else
-
-    echo "'$MODE' is not a recognised option for the MODE environment variable. Accepted options are 'manager' and 'worker'."
-
-fi