Merge pull request '1.0.2' (#3) from develop into main
Some checks reported errors
continuous-integration/drone/push Build was killed
Some checks reported errors
continuous-integration/drone/push Build was killed
Reviewed-on: #3
This commit is contained in:
commit
c4e8faff3b
75
.drone.yml
75
.drone.yml
@ -31,6 +31,8 @@ steps:
|
|||||||
when:
|
when:
|
||||||
ref:
|
ref:
|
||||||
- refs/heads/main
|
- refs/heads/main
|
||||||
|
depends_on:
|
||||||
|
- get-tags
|
||||||
|
|
||||||
- name: make-tags-release
|
- name: make-tags-release
|
||||||
image: node
|
image: node
|
||||||
@ -39,9 +41,11 @@ steps:
|
|||||||
when:
|
when:
|
||||||
ref:
|
ref:
|
||||||
- refs/tags/**
|
- refs/tags/**
|
||||||
|
depends_on:
|
||||||
|
- get-tags
|
||||||
|
|
||||||
# Build containers from main branch
|
# Build containers from main branch
|
||||||
- name: build
|
- name: build-gitea
|
||||||
image: thegeeklab/drone-docker-buildx
|
image: thegeeklab/drone-docker-buildx
|
||||||
privileged: true
|
privileged: true
|
||||||
settings:
|
settings:
|
||||||
@ -55,17 +59,53 @@ steps:
|
|||||||
platforms:
|
platforms:
|
||||||
- linux/arm64
|
- linux/arm64
|
||||||
- linux/amd64
|
- 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
|
image: goreleaser/goreleaser
|
||||||
environment:
|
environment:
|
||||||
GITEA_TOKEN:
|
GITEA_TOKEN:
|
||||||
from_secret: gitea_token
|
from_secret: gitea_token
|
||||||
commands:
|
commands:
|
||||||
- goreleaser release
|
- goreleaser release -f .goreleaser-gitea.yaml
|
||||||
when:
|
when:
|
||||||
ref:
|
ref:
|
||||||
- refs/tags/**
|
- 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
|
- name: notify
|
||||||
image: plugins/slack
|
image: plugins/slack
|
||||||
@ -76,6 +116,9 @@ steps:
|
|||||||
settings:
|
settings:
|
||||||
webhook:
|
webhook:
|
||||||
from_secret: slack_webhook
|
from_secret: slack_webhook
|
||||||
|
depends_on:
|
||||||
|
- release-gitea
|
||||||
|
- release-github
|
||||||
|
|
||||||
---
|
---
|
||||||
kind: pipeline
|
kind: pipeline
|
||||||
@ -100,7 +143,7 @@ steps:
|
|||||||
- echo -n "develop-${DRONE_COMMIT_SHA:0:8}, develop" > .tags
|
- echo -n "develop-${DRONE_COMMIT_SHA:0:8}, develop" > .tags
|
||||||
|
|
||||||
# Build containers from develop branch
|
# Build containers from develop branch
|
||||||
- name: build
|
- name: build-gitea
|
||||||
image: thegeeklab/drone-docker-buildx
|
image: thegeeklab/drone-docker-buildx
|
||||||
privileged: true
|
privileged: true
|
||||||
settings:
|
settings:
|
||||||
@ -114,6 +157,25 @@ steps:
|
|||||||
platforms:
|
platforms:
|
||||||
- linux/arm64
|
- linux/arm64
|
||||||
- linux/amd64
|
- 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
|
- name: notify
|
||||||
image: plugins/slack
|
image: plugins/slack
|
||||||
@ -123,4 +185,7 @@ steps:
|
|||||||
- failure
|
- failure
|
||||||
settings:
|
settings:
|
||||||
webhook:
|
webhook:
|
||||||
from_secret: slack_webhook
|
from_secret: slack_webhook
|
||||||
|
depends_on:
|
||||||
|
- build-gitea
|
||||||
|
- build-github
|
3
.gitignore
vendored
3
.gitignore
vendored
@ -1,2 +1,3 @@
|
|||||||
dist/
|
dist-gitea/
|
||||||
|
dist-github/
|
||||||
.tags
|
.tags
|
@ -1,3 +1,5 @@
|
|||||||
|
dist: dist-gitea
|
||||||
|
|
||||||
build:
|
build:
|
||||||
skip: true
|
skip: true
|
||||||
|
|
20
.goreleaser-github.yaml
Normal file
20
.goreleaser-github.yaml
Normal 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:'
|
@ -15,14 +15,15 @@ ARG CRONICLE_EDGE_VERSION=1.6.2
|
|||||||
ENV CRONICLE_foreground=1
|
ENV CRONICLE_foreground=1
|
||||||
ENV CRONICLE_echo=1
|
ENV CRONICLE_echo=1
|
||||||
ENV CRONICLE_color=1
|
ENV CRONICLE_color=1
|
||||||
ENV EDITOR=vi
|
ENV EDITOR=nano
|
||||||
ENV MODE=manager
|
ENV MODE=manager
|
||||||
ENV PUID=1000
|
ENV PUID=1000
|
||||||
ENV PGID=1000
|
ENV PGID=1000
|
||||||
ENV TZ=UTC
|
ENV TZ=UTC
|
||||||
|
ENV LOG_LEVEL=9
|
||||||
|
|
||||||
#Get required packages
|
#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
|
#Make folders
|
||||||
RUN mkdir /config && \
|
RUN mkdir /config && \
|
||||||
|
42
README.md
42
README.md
@ -1,10 +1,41 @@
|
|||||||
# Cronicle Docker
|
# Cronicle Docker
|
||||||
|
|
||||||
 
|
 
|
||||||
|
|
||||||
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 the 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.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
## 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
|
## 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.
|
`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
|
### 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
|
|PUID |int |1000 |Sets the UID of the user Cronicle runs under
|
||||||
|PGID |int |1000 |Sets the GID 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
|
|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)|
|
||||||
|
@ -21,6 +21,7 @@ PUID=${PUID}
|
|||||||
PGID=${PGID}
|
PGID=${PGID}
|
||||||
TZ=${TZ}
|
TZ=${TZ}
|
||||||
MODE=${MODE}
|
MODE=${MODE}
|
||||||
|
LOG_LEVEL=${LOG_LEVEL}
|
||||||
----------------------------------------------------------------------
|
----------------------------------------------------------------------
|
||||||
"
|
"
|
||||||
|
|
||||||
|
@ -103,4 +103,22 @@ 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 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
|
fi
|
@ -1,3 +1,3 @@
|
|||||||
#!/command/with-contenv bash
|
#!/command/with-contenv bash
|
||||||
# shellcheck shell=bash
|
# shellcheck shell=bash
|
||||||
exec s6-setuidgid cronicle 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}
|
Loading…
x
Reference in New Issue
Block a user