Merge pull request '1.0.5' (#11) from develop into main

Reviewed-on: #11

.drone.yml

@@ -1,12 +1,11 @@
 kind: pipeline
 type: docker
-name: build-main-images
+name: build-release-images
 trigger:
   event:
     exclude:
     - pull_request
   ref:
-    - refs/heads/main
     - refs/tags/**
 
 platform:
@@ -19,29 +18,17 @@ steps:
   image: docker:git
   commands:
     - git fetch --tags
-  when:
+  depends_on:
-    ref:
+    - clone
-      - 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:
+  depends_on:
-    ref:
+    - get-tags
-      - refs/tags/**
 
-  # Build containers from main branch
+- name: build-gitea
-- name: build
   image: thegeeklab/drone-docker-buildx
   privileged: true
   settings:
@@ -55,17 +42,45 @@ steps:
     platforms:
       - linux/arm64
       - linux/amd64
+  depends_on:
+    - make-tags
 
-- 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
+
+- name: release-gitea
   image: goreleaser/goreleaser
   environment:
     GITEA_TOKEN:
       from_secret: gitea_token
   commands:
-    - goreleaser release
+    - goreleaser release -f .goreleaser-gitea.yaml
-  when:
+  depends_on:
-    ref:
+    - build-gitea
-      - refs/tags/**
+
+- name: release-github
+  image: goreleaser/goreleaser
+  environment:
+    GITHUB_TOKEN:
+      from_secret: github_token
+  commands:
+    - goreleaser release -f .goreleaser-github.yaml
+  depends_on:
+    - build-github
 
 - name: notify
   image: plugins/slack
@@ -76,6 +91,83 @@ steps:
   settings:
     webhook: 
       from_secret: slack_webhook
+  depends_on:
+    - release-gitea
+    - release-github
+
+---
+kind: pipeline
+type: docker
+name: build-main-images
+trigger:
+  event:
+    exclude:
+    - pull_request
+  ref:
+    - refs/heads/main
+
+platform:
+  os: linux
+  arch: amd64
+
+steps:
+
+- name: make-tags
+  image: node
+  commands:
+    - echo -n "${DRONE_COMMIT_SHA:0:8}, latest" > .tags
+  when:
+    ref:
+      - refs/heads/main
+  depends_on:
+    - clone
+
+- name: build-gitea
+  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
+  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
+  when:
+    status:
+    - success
+    - failure
+  settings:
+    webhook: 
+      from_secret: slack_webhook
+  depends_on:
+    - build-github
+    - build-gitea
 
 ---
 kind: pipeline
@@ -100,7 +192,7 @@ steps:
     - echo -n "develop-${DRONE_COMMIT_SHA:0:8}, develop" > .tags
    
   # Build containers from develop branch
-- name: build
+- name: build-gitea
   image: thegeeklab/drone-docker-buildx
   privileged: true
   settings:
@@ -114,6 +206,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
@@ -123,4 +234,7 @@ steps:
     - failure
   settings:
     webhook: 
-      from_secret: slack_webhook
+      from_secret: slack_webhook
+  depends_on:
+    - build-gitea
+    - build-github

.gitignore

@@ -1,2 +1,3 @@
-dist/
+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,47 +1,67 @@
-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.3
 
 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
 
 #Get required packages
-RUN apk update && apk add tzdata curl shadow bash xz git procps nodejs npm
+RUN apk update && apk add --no-cache tzdata curl shadow bash xz git procps nodejs npm nano openssl ca-certificates
 
 #Make folders
 RUN mkdir /config && \
     mkdir /app && \
 #Create default user
-    useradd -u 1000 -U -d /config -s /bin/false mrmeeb && \
+    useradd -u 1000 -U -d /config -s /bin/false cronicle && \
-    usermod -G users mrmeeb
+    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-x86_64.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
+#Install Cronicle & tidy up things I don't want
-RUN git clone https://github.com/cronicle-edge/cronicle-edge.git /app/cronicle
+RUN apk add --no-cache --virtual .jq jq && \
+    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 sample_conf/examples/backup sample_conf/examples/docker.sh && \
+    jq 'del(.storage[] | select(contains(["global/conf_keys"])))' sample_conf/setup.json >> sample_conf/setup-new.json && \
+    rm sample_conf/setup.json && \
+    mv sample_conf/setup-new.json sample_conf/setup.json && \
+    rm -rf v${CRONICLE_EDGE_VERSION}.tar.gz && \
+    apk del .jq
+
 WORKDIR /app/cronicle
 RUN npm install && \
     node bin/build dist
-RUN rm -rf /app/cronicle/Docker* .vscode
-
-#Create Cronicle user, necessary for SSH plugin with default settings
-RUN adduser --disabled-password --no-create-home cronicle
 
 COPY root/ /
 RUN chmod +x /cronicle-prepare.sh && \
-    chmod +x /container-init.sh
+    chmod +x /container-init.sh && \
+    chown -R ${PUID}:${PGID} /app /config
 
 EXPOSE 3012
+EXPOSE 3013
 
 ENTRYPOINT [ "/init" ]

README.md

@@ -1,10 +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 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
 
@@ -19,9 +50,9 @@ Tags relating to releases are also available, for locking in on a specific versi
 
 `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
 ```
@@ -61,6 +92,37 @@ services:
 
 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.
 
+Note that any scripts will be run as `root` before permissions are altered in `/app` and `/config`. Anything that an init script does in either of these folders will be owned by `cronicle` when the container continues.
+
+## Reverse Proxying
+
+For a single manager behind a reverse proxy, you may need to specify a specific route for the web-socket connections.
+
+An example using nginx: 
+
+```  
+  location /socket.io/ {
+        client_max_body_size                    2048m;
+        proxy_read_timeout                      86400s;
+        proxy_send_timeout                      86400s;
+        proxy_set_header                        X-Forwarded-Host $host;
+        proxy_set_header                        X-Forwarded-Server $host;
+        proxy_set_header                        X-Real-IP $remote_addr;
+        proxy_set_header                        Host $host;
+        proxy_set_header                        X-Forwarded-For $proxy_add_x_forwarded_for;
+        proxy_http_version                      1.1;
+        proxy_redirect                          off;
+        proxy_set_header                        Upgrade $http_upgrade;
+        proxy_set_header                        Connection "upgrade"; 
+
+    proxy_pass          http://localhost:3012/socket.io/;
+  }
+  ```
+
+Source: https://github.com/jhuckaby/Cronicle/issues/535
+
+Load-balancing between multiple managers, as described [here](https://github.com/jhuckaby/Cronicle/blob/master/docs/Setup.md#load-balancers), has not been tested, and could behave strangely due to docker DNS.
+
 ## Ports
 
 |Port |Description|
@@ -80,3 +142,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

@@ -21,6 +21,7 @@ PUID=${PUID}
 PGID=${PGID}
 TZ=${TZ}
 MODE=${MODE}
+LOG_LEVEL=${LOG_LEVEL}
 ----------------------------------------------------------------------
 "
 
@@ -28,26 +29,41 @@ MODE=${MODE}
 if [[ ! "${PUID}" -eq 0 ]] && [[ ! "${PGID}" -eq 0 ]]; then
     echo "Executing usermod..."
     mkdir "/tmp/temphome"
-    usermod -d "/tmp/temphome" mrmeeb
+    usermod -d "/tmp/temphome" cronicle
-    usermod -o -u "${PUID}" mrmeeb
+    usermod -o -u "${PUID}" cronicle
-    usermod -d /config mrmeeb
+    usermod -d /config cronicle
     rm -rf "/tmp/temphome"
-    groupmod -o -g "${PGID}" mrmeeb
+    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 (this can take some time)."
+#Importing and running additional scripts placed in /config/init
-
+if [ -d /config/init ]; then
-if [ ! "$(stat -c %u /app)" -eq "${PUID}" ] || [ ! "$(stat -c %g /app)" -eq "${PGID}" ]
+	if [ "$(ls -A /config/init)" ]; then
-then
+        echo "Running additional startup scripts."
-    echo "Fixing permissions for /app."
+        for f in /config/init/*.sh; do
-    chown -R mrmeeb:mrmeeb /app
+            bash "$f" 
+        done
+    else
+        echo "/config/init is empty - no additional startup scripts detected."
+    fi
+else
+	echo "Directory /config/init not found. Creating."
+    mkdir /config/init && chown -R cronicle:cronicle /config/init
 fi
 
-if [ ! "$(stat -c %u /config)" -eq "${PUID}" ] || [ ! "$(stat -c %g /config)" -eq "${PGID}" ]
+echo "Checking permissions in /config and /app."
+
+if [ -n "$(find /app \! -user ${PUID})" ] || [ -n "$(find /app \! -group ${PGID})" ]
 then
-    echo "Fixing permissions for /config."
+    echo "Fixing permissions for /app (this can take some time)."
-    chown -R mrmeeb:mrmeeb /config
+    chown -R cronicle:cronicle /app || true
+fi
+
+if [ -n "$(find /config \! -user ${PUID})" ] || [ -n "$(find /config \! -group ${PGID})" ]
+then
+    echo "Fixing permissions for /config (this can take some time)."
+    chown -R cronicle:cronicle /config || true
 fi

root/cronicle-prepare.sh

@@ -3,34 +3,13 @@
 
 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
@@ -42,11 +21,33 @@ then
     #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/conf/ssl.crt ] || [ ! -f /config/cronicle/conf/ssl.key ]
+    then
+
+        echo "One or both SSL components are missing. Generating."
+
+        rm -f /config/cronicle/conf/ssl.crt /config/cronicle/conf/ssl.key
+        openssl req -x509 -newkey rsa:4096 -keyout /config/cronicle/conf/ssl.key -out /config/cronicle/conf/ssl.crt -sha256 -days 3650 -nodes -subj "/C=XX/ST=StateName/L=CityName/O=CompanyName/OU=CompanySectionName/CN=CommonNameOrHostname"
+
+    fi
+    
     if [ ! -f /config/cronicle/data/.setup_done ]
     then
 
@@ -60,8 +61,6 @@ then
         rm -rf /app/cronicle/data
         ln -s /config/cronicle/data /app/cronicle/data
 
-        #exec node /app/cronicle/lib/main.js --color 1
-
     else
 
         echo "Setup already completed."
@@ -69,8 +68,6 @@ then
         rm -rf /app/cronicle/data
         ln -s /config/cronicle/data /app/cronicle/data
 
-        #exec node /app/cronicle/lib/main.js --color 1
-
     fi
 
 elif [ $MODE == "worker" ] 
@@ -78,30 +75,51 @@ then
 
     echo "Cronicle is running in 'worker' mode."
 
+    #Copying config directory to /config/cronicle/conf if not already there, then linking back into Cronicle
     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
+        cp -R /app/cronicle/conf /config/cronicle/conf
-        exit 0
+        rm -rf /config/cronicle/conf/config.json
+        echo ''
+        echo ''
+        echo '*************************************'
+        exit 1
 
     else
 
-        #Removing default config.json and linking provided one back into Cronicle
+        echo "Config is present."
-        rm -rf /app/cronicle/conf/config.json
+        echo "Linking persistent config dir back into Cronicle."
-        ln -s /config/config.json /app/cronicle/conf/config.json
 
-        #exec node /app/cronicle/lib/main.js --color 1
+        rm -rf /app/cronicle/conf
+        ln -s /config/cronicle/conf /app/cronicle/conf
 
     fi
 
 else
 
-    echo "'$MODE' is not a recognised appion for the MODE environment variable. Accepted appions are 'manager' and 'worker'."
+    echo "'$MODE' is not a recognised appion for the MODE environment variable. Accepted options are 'manager' and 'worker'."
+    exit 1
 
 fi
 
-#echo "Applying permissions to /config and /app (this can take a while on first run or after PUID/PGID changes)"
+#Expose log directory
-#chmod "=rwx" /config
+if [ ! -d /config/cronicle/logs ]
-#chown -R mrmeeb:mrmeeb /config
+then
-#chown -R mrmeeb:mrmeeb /app
+
+    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/cronicle-prepare/up

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

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

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