Merge pull request #934 from hvmzx/calibre-web-kcc

calibre-web-kcc: initial release of kcc mod for calibre-web for comic/manga ebook processing

.github/workflows/BuildImage.yml

@@ -5,9 +5,9 @@ on: [push, pull_request_target, workflow_dispatch]
 env:
   GITHUB_REPO: "linuxserver/docker-mods" #don't modify
   ENDPOINT: "linuxserver/mods" #don't modify
-  BASEIMAGE: "replace_baseimage" #replace
+  BASEIMAGE: "calibre-web" #replace
-  MODNAME: "replace_modname" #replace
+  MODNAME: "kcc" #replace
-  MULTI_ARCH: "true" #set to false if not needed
+  MULTI_ARCH: "false" #set to false if not needed
 
 jobs:
   set-vars:
@@ -22,7 +22,7 @@ jobs:
           echo "MODNAME=${{ env.MODNAME }}" >> $GITHUB_OUTPUT
           echo "MULTI_ARCH=${{ env.MULTI_ARCH }}" >> $GITHUB_OUTPUT
           # **** If the mod needs to be versioned, set the versioning logic below. Otherwise leave as is. ****
-          MOD_VERSION=""
+          MOD_VERSION="$(curl -s https://api.github.com/repos/ciromattia/kcc/releases/latest | jq -rc ".tag_name")"
           echo "MOD_VERSION=${MOD_VERSION}" >> $GITHUB_OUTPUT
     outputs:
       GITHUB_REPO: ${{ steps.outputs.outputs.GITHUB_REPO }}

Dockerfile

@@ -1,8 +1,38 @@
 # syntax=docker/dockerfile:1
 
+## Buildstage ##
+FROM ghcr.io/linuxserver/baseimage-alpine:3.19 AS buildstage
+
+ARG MOD_VERSION
+
+RUN curl -L https://archive.org/download/kindlegen_linux_2_6_i386_v2_9/kindlegen_linux_2.6_i386_v2_9.tar.gz > kindlegen.tar.gz
+RUN tar -zxvf kindlegen.tar.gz kindlegen
+RUN chmod +rwx 'kindlegen'
+RUN rm kindlegen.tar.gz
+
+RUN \
+  if [ -z ${MOD_VERSION} ]; then \
+    echo "MOD_VERSION is not set. Fetching from GitHub..."; \
+    MOD_VERSION=$(curl -s "https://api.github.com/repos/ciromattia/kcc/releases/latest" | jq -rc ".tag_name"); \
+  else \
+    echo "MOD_VERSION is already set to '${MOD_VERSION}'"; \
+  fi && \
+  echo "Using MOD_VERSION=${MOD_VERSION}" && \
+  curl -L https://github.com/ciromattia/kcc/archive/refs/tags/${MOD_VERSION}.tar.gz > kcc.tar.gz && \
+  tar -xzf kcc.tar.gz && \
+  mv kcc-$(echo "${MOD_VERSION}" | sed 's/^.\(.*\)/\1/') kcc && \
+  touch kcc/KCC_VERSION && \
+  echo ${MOD_VERSION} > kcc/KCC_VERSION && \
+  mkdir -p /root-layer/usr/local/bin && \
+  mv kindlegen /root-layer/usr/local/bin/ && \
+  mv kcc /root-layer/usr/local/bin/
+
+COPY root/ /root-layer/
+
+## Single layer deployed image ##
 FROM scratch
 
-LABEL maintainer="username"
+LABEL maintainer="hvmzx"
 
-# copy local files
+# Add files from buildstage
-COPY root/ /
+COPY --from=buildstage /root-layer/ /

Dockerfile.complex

@@ -1,33 +0,0 @@
-# syntax=docker/dockerfile:1
-
-## Buildstage ##
-FROM ghcr.io/linuxserver/baseimage-alpine:3.19 as buildstage
-
-RUN \
-  echo "**** install packages ****" && \
-  apk add --no-cache \
-    curl && \
-  echo "**** grab rclone ****" && \
-  mkdir -p /root-layer && \
-  if [ $(uname -m) = "x86_64" ]; then \
-    echo "Downloading x86_64 tarball" && \
-    curl -o \
-      /root-layer/rclone.deb -L \
-      "https://downloads.rclone.org/v1.47.0/rclone-v1.47.0-linux-amd64.deb"; \
-  elif [ $(uname -m) = "aarch64" ]; then \
-    echo "Downloading aarch64 tarball" && \
-    curl -o \
-      /root-layer/rclone.deb -L \
-      "https://downloads.rclone.org/v1.47.0/rclone-v1.47.0-linux-arm64.deb"; \
-  fi && \
-
-# copy local files
-COPY root/ /root-layer/
-
-## Single layer deployed image ##
-FROM scratch
-
-LABEL maintainer="username"
-
-# Add files from buildstage
-COPY --from=buildstage /root-layer/ /

README.md

@@ -1,25 +1,7 @@
-# Rsync - Docker mod for openssh-server
+# KCC (Kindle Comic Converter) - Docker mod for Calibre Web
 
-This mod adds rsync to openssh-server, to be installed/updated during container start.
+This mod adds KCC and its multitude of ebook processing (upscale, stretch, right to left for manga...) to Calibre Web, to be installed/updated during container start.
 
-In openssh-server docker arguments, set an environment variable `DOCKER_MODS=linuxserver/mods:openssh-server-rsync`
+In any container docker arguments, set an environment variable `DOCKER_MODS=linuxserver/mods:calibre-web-kcc`
 
-If adding multiple mods, enter them in an array separated by `|`, such as `DOCKER_MODS=linuxserver/mods:openssh-server-rsync|linuxserver/mods:openssh-server-mod2`
+If adding multiple mods, enter them in an array separated by `|`, such as `DOCKER_MODS=linuxserver/mods:calibre-web-kcc|linuxserver/mods:calibre-web-mod2`
-
-# Mod creation instructions
-
-* Fork the repo, create a new branch based on the branch `template`.
-* Edit the `Dockerfile` for the mod. `Dockerfile.complex` is only an example and included for reference; it should be deleted when done.
-* Inspect the `root` folder contents. Edit, add and remove as necessary.
-* After all init scripts and services are created, run `find ./  -path "./.git" -prune -o \( -name "run" -o -name "finish" -o -name "check" \) -not -perm -u=x,g=x,o=x -print -exec chmod +x {} +` to fix permissions.
-* Edit this readme with pertinent info, delete these instructions.
-* Finally edit the `.github/workflows/BuildImage.yml`. Customize the vars for `BASEIMAGE` and `MODNAME`. Set the versioning logic and `MULTI_ARCH` if needed.
-* Ask the team to create a new branch named `<baseimagename>-<modname>`. Baseimage should be the name of the image the mod will be applied to. The new branch will be based on the `template` branch.
-* Submit PR against the branch created by the team.
-
-
-## Tips and tricks
-
-* Some images have helpers built in, these images are currently:
-    * [Openvscode-server](https://github.com/linuxserver/docker-openvscode-server/pull/10/files)
-    * [Code-server](https://github.com/linuxserver/docker-code-server/pull/95)

root/etc/s6-overlay/s6-rc.d/init-mod-calibre-web-kcc-add-package/run

@@ -0,0 +1,50 @@
+#!/usr/bin/with-contenv bash
+
+echo "**** Adding kcc dependencies (repo and pip) to package install lists ****"
+if ! python3 /usr/local/bin/kcc/kcc-c2e.py > /dev/null 2>&1 ; then
+  echo "\
+    PySide6 \
+    Pillow \
+    psutil \
+    requests \
+    python-slugify \
+    raven \
+    mozjpeg-lossless-optimization \
+    natsort[fast] \
+    distro" >> /mod-pip-packages-to-install.list
+  ## Ubuntu
+  if [ -f /usr/bin/apt ]; then
+    echo "\
+      python3 \
+      python3-pip
+      python3-dev \
+      libpng-dev \
+      libjpeg-dev \
+      p7zip-full \
+      p7zip-rar \
+      unrar-free \
+      libgl1 \
+      python3-pyqt5 \
+      cmake" >> /mod-repo-packages-to-install.list
+  fi
+  # Alpine
+  if [ -f /sbin/apk ]; then
+    echo "\
+      cargo \
+      libffi-dev \
+      openssl-dev \
+      python3 \
+      python3-dev \
+      python3 \
+      py3-pip \
+      libpng-dev \
+      libjpeg \
+      p7zip \
+      unrar \
+      mesa-gl \
+      py3-qt5 \
+      cmake" >> /mod-repo-packages-to-install.list
+    fi
+else
+  echo "**** kcc dependencies already installed, skipping ****"
+fi

root/etc/s6-overlay/s6-rc.d/init-mod-calibre-web-kcc-add-package/up

@@ -0,0 +1 @@
+/etc/s6-overlay/s6-rc.d/init-mod-calibre-web-kcc-add-package/run

root/etc/s6-overlay/s6-rc.d/init-mod-imagename-modname-add-package/run

@@ -1,30 +0,0 @@
-#!/usr/bin/with-contenv bash
-
-# This is the init file used for adding os or pip packages to install lists.
-# It takes advantage of the built-in init-mods-package-install init script that comes with the baseimages.
-# If using this, we need to make sure we set this init as a dependency of init-mods-package-install so this one runs first
-
-if ! command -v apprise; then
-    echo "**** Adding apprise and its deps to package install lists ****"
-    echo "apprise" >> /mod-pip-packages-to-install.list
-    ## Ubuntu
-    if [ -f /usr/bin/apt ]; then
-        echo "\
-            python3 \
-            python3-pip \
-            runc" >> /mod-repo-packages-to-install.list
-    fi
-    # Alpine
-    if [ -f /sbin/apk ]; then
-        echo "\
-            cargo \
-            libffi-dev \
-            openssl-dev \
-            python3 \
-            python3-dev \
-            python3 \
-            py3-pip" >> /mod-repo-packages-to-install.list
-    fi
-else
-    echo "**** apprise already installed, skipping ****"
-fi

root/etc/s6-overlay/s6-rc.d/init-mod-imagename-modname-add-package/up

@@ -1 +0,0 @@
-/etc/s6-overlay/s6-rc.d/init-mod-imagename-modname-add-package/run

root/etc/s6-overlay/s6-rc.d/init-mod-imagename-modname-install/run

@@ -1,8 +0,0 @@
-#!/usr/bin/with-contenv bash
-
-# This is an install script that is designed to run after init-mods-package-install
-# so it can take advantage of packages installed
-# init-mods-end depends on this script so that later init and services wait until this script exits
-
-echo "**** Setting up apprise ****"
-apprise blah blah

root/etc/s6-overlay/s6-rc.d/init-mod-imagename-modname-install/type

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

root/etc/s6-overlay/s6-rc.d/init-mod-imagename-modname-install/up

@@ -1 +0,0 @@
-/etc/s6-overlay/s6-rc.d/init-mod-imagename-modname-install/run

root/etc/s6-overlay/s6-rc.d/svc-mod-imagename-modname/run

@@ -1,7 +0,0 @@
-#!/usr/bin/with-contenv bash
-
-# This is an example service that would run for the mod
-# It depends on init-services, the baseimage hook for start of all longrun services
-
-exec \
-    s6-setuidgid abc run my app

root/etc/s6-overlay/s6-rc.d/svc-mod-imagename-modname/type

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