40 Commits

Author SHA1 Message Date
MrMeeb 5fcb0c0e08 typo correction on readme [CI SKIP] 2023-06-05 21:18:31 +00:00
MrMeeb aace951501 Merge pull request 'fix drone release build dependency graph' (#4) from develop into main
continuous-integration/drone/push Build is passing
Reviewed-on: #4
2023-06-05 21:09:47 +00:00
MrMeeb 193f104408 fix drone release build dependency graph
continuous-integration/drone/push Build is passing
2023-06-05 21:04:42 +00:00
MrMeeb c4e8faff3b Merge pull request '1.0.2' (#3) from develop into main
continuous-integration/drone/push Build was killed
Reviewed-on: #3
2023-06-05 20:50:04 +00:00
MrMeeb 0080d188ab update readme [CI SKIP] 2023-06-05 20:49:35 +00:00
MrMeeb eefaba12cb fix drone dependency graph
continuous-integration/drone/push Build is passing
2023-06-05 20:43:23 +00:00
MrMeeb 114c87fefe drone build and public to ghcr also 2023-06-05 20:43:23 +00:00
MrMeeb a8eb04c76b expose log dir to /config volume 2023-06-05 20:43:23 +00:00
MrMeeb debd509868 add cronicle info to readme [CI SKIP] 2023-06-05 20:43:23 +00:00
MrMeeb e8d9f7c8cd add LOG_LEVEL env var 2023-06-05 20:43:23 +00:00
MrMeeb 98ab91f73f update readme [CI SKIP] 2023-06-05 20:43:23 +00:00
MrMeeb 694ba8f5ce add nano, change editor to it 2023-06-05 20:43:23 +00:00
MrMeeb c232595f36 Merge pull request '1.0.1' (#2) from develop into main
continuous-integration/drone/push Build is passing
continuous-integration/drone/tag Build is passing
Reviewed-on: #2
2023-05-27 22:10:46 +00:00
MrMeeb 6ac07ec9a0 cleanup misc files in app dir
continuous-integration/drone/push Build is passing
2023-05-27 22:05:58 +00:00
MrMeeb ab73132553 set permissions to 1000 at build
continuous-integration/drone/push Build is passing
2023-05-27 21:58:31 +00:00
MrMeeb 76cdb2640e fix to defined cronicle version 2023-05-27 21:53:40 +00:00
MrMeeb f1f322d58a rename user to cronicle 2023-05-27 18:46:23 +00:00
MrMeeb bfbc0e22d7 fix not hooking conf in if already setup
continuous-integration/drone/push Build is passing
2023-05-27 18:15:12 +00:00
MrMeeb f3dc829111 get correct s6 for architecture
continuous-integration/drone/push Build is passing
2023-05-27 17:49:19 +00:00
MrMeeb 9c3caf751e Merge pull request '1.0.0' (#1) from develop into main
continuous-integration/drone/push Build is passing
continuous-integration/drone/tag Build is passing
Reviewed-on: #1
2023-05-27 16:53:07 +00:00
MrMeeb 1ac78908ad tweak build behaviour [CI SKIP] 2023-05-27 16:49:13 +00:00
MrMeeb f990871798 updated readme [CI SKIP] 2023-05-27 16:46:47 +00:00
MrMeeb 2ecac58414 add .gitignore [CI SKIP] 2023-05-27 15:37:58 +00:00
MrMeeb 613393f328 redesign around s6-overlay
continuous-integration/drone/push Build is passing
2023-05-27 13:43:46 +00:00
MrMeeb 30026b4e17 update readme [CI SKIP] 2023-05-27 13:42:38 +00:00
MrMeeb 580845afe0 add goreleaser [CI SKIP] 2023-05-27 13:40:53 +00:00
MrMeeb d4aa8ff410 update drone behaviour [CI SKIP] 2023-05-27 13:40:44 +00:00
MrMeeb b3436f3b2c create cronicle user at build
continuous-integration/drone/push Build is passing
2022-12-29 23:49:45 +00:00
MrMeeb 4541df4c8a Merge branch 'main' of https://git.mrmeeb.stream/MrMeeb/cronicle-docker
continuous-integration/drone/push Build is passing
2022-12-29 20:36:16 +00:00
MrMeeb 26c3a15c81 logic fixes 2022-12-29 20:36:15 +00:00
MrMeeb e10acf4e46 Update '.drone.yml'
continuous-integration/drone/push Build is passing
2022-12-29 19:41:42 +00:00
MrMeeb 2d8fb52b23 Update '.drone.yml'
continuous-integration/drone/push Build is failing
2022-12-29 19:03:26 +00:00
MrMeeb 511704a90f drone notify on failure
continuous-integration/drone/push Build was killed
2022-12-29 17:51:38 +00:00
MrMeeb 70d6215ca3 Add logic to detect if config is missing as worker
continuous-integration/drone/push Build is failing
2022-12-29 17:46:57 +00:00
MrMeeb d759db2bb0 Update '.drone.yml'
continuous-integration/drone/push Build is passing
2022-12-27 11:48:39 +00:00
MrMeeb c04d6febad Merge branch 'main' of https://git.mrmeeb.stream/MrMeeb/cronicle-docker
continuous-integration/drone/push Build was killed
2022-12-27 11:44:58 +00:00
MrMeeb cad9b48ab9 add drone, add logic for init scripts 2022-12-27 11:44:51 +00:00
MrMeeb 327208391b Update 'README.md' 2022-12-26 22:31:41 +00:00
MrMeeb ee7034cba3 more dev 2022-12-26 22:30:42 +00:00
MrMeeb 78f681fb41 first commit 2022-12-26 18:21:10 +00:00
10 changed files with 203 additions and 45 deletions
+76 -5
View File
@@ -22,6 +22,8 @@ steps:
when:
ref:
- refs/tags/**
depends_on:
- clone
# Set tags for main branch
- name: make-tags
@@ -31,6 +33,9 @@ steps:
when:
ref:
- refs/heads/main
depends_on:
- get-tags
- clone
- name: make-tags-release
image: node
@@ -39,9 +44,12 @@ steps:
when:
ref:
- refs/tags/**
depends_on:
- get-tags
- clone
# Build containers from main branch
- name: build
- name: build-gitea
image: thegeeklab/drone-docker-buildx
privileged: true
settings:
@@ -55,17 +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
@@ -76,6 +120,11 @@ steps:
settings:
webhook:
from_secret: slack_webhook
depends_on:
- release-gitea
- release-github
- build-github
- build-gitea
---
kind: pipeline
@@ -100,7 +149,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 +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
@@ -123,4 +191,7 @@ steps:
- failure
settings:
webhook:
from_secret: slack_webhook
from_secret: slack_webhook
depends_on:
- build-gitea
- build-github
+2 -1
View File
@@ -1,2 +1,3 @@
dist/
dist-gitea/
dist-github/
.tags
@@ -1,3 +1,5 @@
dist: dist-gitea
build:
skip: true
+20
View File
@@ -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:'
+26 -12
View File
@@ -1,46 +1,60 @@
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
#Get required packages
RUN apk update && apk add tzdata curl shadow bash xz git procps nodejs npm
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 mrmeeb && \
usermod -G users mrmeeb
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-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
RUN git clone https://github.com/cronicle-edge/cronicle-edge.git /app/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
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
+37 -5
View File
@@ -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
```
@@ -80,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)|
+10 -9
View File
@@ -21,6 +21,7 @@ PUID=${PUID}
PGID=${PGID}
TZ=${TZ}
MODE=${MODE}
LOG_LEVEL=${LOG_LEVEL}
----------------------------------------------------------------------
"
@@ -28,26 +29,26 @@ MODE=${MODE}
if [[ ! "${PUID}" -eq 0 ]] && [[ ! "${PGID}" -eq 0 ]]; then
echo "Executing usermod..."
mkdir "/tmp/temphome"
usermod -d "/tmp/temphome" mrmeeb
usermod -o -u "${PUID}" mrmeeb
usermod -d /config mrmeeb
usermod -d "/tmp/temphome" cronicle
usermod -o -u "${PUID}" cronicle
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)."
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."
chown -R mrmeeb:mrmeeb /app
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."
chown -R mrmeeb:mrmeeb /config
echo "Fixing permissions for /config (this can take some time)."
chown -R cronicle:cronicle /config
fi
+28 -11
View File
@@ -42,9 +42,19 @@ 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/data/.setup_done ]
@@ -60,8 +70,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 +77,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" ]
@@ -89,9 +95,7 @@ then
#Removing default config.json and linking provided one back into Cronicle
rm -rf /app/cronicle/conf/config.json
ln -s /config/config.json /app/cronicle/conf/config.json
#exec node /app/cronicle/lib/main.js --color 1
ln -s /config/cronicle/conf/config.json /app/cronicle/conf/config.json
fi
@@ -101,7 +105,20 @@ else
fi
#echo "Applying permissions to /config and /app (this can take a while on first run or after PUID/PGID changes)"
#chmod "=rwx" /config
#chown -R mrmeeb:mrmeeb /config
#chown -R mrmeeb:mrmeeb /app
#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
@@ -1 +1 @@
exec s6-setuidgid mrmeeb /cronicle-prepare.sh
exec s6-setuidgid cronicle /cronicle-prepare.sh
+1 -1
View File
@@ -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}