Merge origin/main into feature/custom-subject

Author: crocodilestick

.gitignore

@@ -24,6 +24,8 @@ cwa-wiki/
 docs/
 .venv-activate.sh
 test_venv
+cwa.code-workspace
+
 
 
 # Test Scripts
@@ -80,6 +82,7 @@ htmlcov/
 .cache
 nosetests.xml
 coverage.xml
+coverage.md
 *.cover
 *.py,cover
 .hypothesis/
@@ -156,7 +159,7 @@ celerybeat.pid
 *.sage.py
 
 # Environments
-.env
+*.env
 .venv
 env/
 venv/
@@ -193,4 +196,7 @@ cython_debug/
 #  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
-#.idea/
+#.idea/
+
+# Dev instance files for testing in the same folder
+instance/

CONTRIBUTORS

@@ -1,7 +1,6 @@
 CONTRIBUTORS
 
 This file is automatically generated. DO NOT EDIT MANUALLY.
-Generated on: 2025-11-26T16:02:57.818004Z
 
 Upstream project: https://github.com/janeczku/calibre-web
 Fork project (Calibre-Web Automated, since 2024): https://github.com/crocodilestick/calibre-web-automated

Dockerfile

@@ -1,11 +1,5 @@
 # syntax=docker/dockerfile:1
 
-FROM ghcr.io/linuxserver/unrar:latest AS unrar
-FROM ghcr.io/linuxserver/baseimage-ubuntu:noble
-
-# Set the default shell for the following RUN instructions to bash instead of sh
-SHELL ["/bin/bash", "-c"]
-
 # Simple Example Build Command:
 # docker build \
 # --tag crocodilestick/calibre-web-automated:dev \
@@ -23,18 +17,17 @@ SHELL ["/bin/bash", "-c"]
 # --build-arg="VERSION=2.1.0" \
 # --tag crocodilestick/calibre-web-automated:latest .
 
-ARG BUILD_DATE
-ARG VERSION
-ARG CALIBREWEB_RELEASE=0.6.24
+# ============================================================================
+# STAGE 1: Dependencies - Install system packages and Python dependencies
+# ============================================================================
+FROM ghcr.io/linuxserver/baseimage-ubuntu:noble AS dependencies
+
 ARG CALIBRE_RELEASE=8.9.0
 ARG KEPUBIFY_RELEASE=v4.0.4
-LABEL build_version="Version:- ${VERSION}"
-LABEL build_date="${BUILD_DATE}"
-LABEL CW-base-version="${CALIBREWEB_RELEASE}"
-LABEL maintainer="CrocodileStick"
 
-# Copy local files into the container
-COPY --chown=abc:abc . /app/calibre-web-automated/
+# Set the default shell for the following RUN instructions to bash instead of sh
+SHELL ["/bin/bash", "-c"]
+
 # STEP 1 - Install Required Packages
 RUN \
   # STEP 1.1 - Add deadsnakes PPA for Python 3.13 and install required apt packages
@@ -67,6 +60,21 @@ RUN \
     nano \
     sqlite3 \
     zip && \
+  # STEP 1.2 - Install additional Calibre required packages
+  apt-get install -y --no-install-recommends \
+    libxtst6 \
+    libxrandr2 \
+    libxkbfile1 \
+    libxcomposite1 \
+    libopengl0 \
+    libnss3 \
+    libxkbcommon0 \
+    libegl1 \
+    libxdamage1 \
+    libgl1 \
+    libglx-mesa0 \
+    xz-utils \
+    binutils && \
   # Install lsof 4.99.5 from source to fix hanging issue with 4.95 (issue #654)
   echo "**** install lsof 4.99.5 from source ****" && \
   LSOF_VERSION="4.99.5" && \
@@ -83,53 +91,30 @@ RUN \
   # Create python3 symlink to point to python3.13
   ln -sf /usr/bin/python3.13 /usr/bin/python3 && \
   # Install pip for Python 3.13
-  curl -sS https://bootstrap.pypa.io/get-pip.py | python3.13 && \
-  # STEP 1.2 - Set up a python virtual environment and install pip and wheel packages
-  cd /app/calibre-web-automated && \
+  curl -sS https://bootstrap.pypa.io/get-pip.py | python3.13
+
+# STEP 2 - Set up Python virtual environment
+RUN \
   python3.13 -m venv /lsiopy && \
   /lsiopy/bin/pip install -U --no-cache-dir \
     pip \
-    wheel && \
-  # STEP 1.3 - Installing the required python packages listed in 'requirements.txt' and 'optional-requirements.txt'
+    wheel
+
+# STEP 3 - Copy requirements files and install Python packages
+# Copy only requirements files first to leverage Docker layer caching
+COPY --chown=abc:abc requirements.txt optional-requirements.txt /app/calibre-web-automated/
+
+RUN \
+  # STEP 3.1 - Installing the required python packages listed in 'requirements.txt' and 'optional-requirements.txt'
     # HOWEVER, they are not pulled from PyPi directly, they are pulled from linuxserver's Ubuntu Wheel Index
     # This is essentially a repository of precompiled some of the most popular packages with C/C++ source code
     # This provides the install maximum compatibility with multiple different architectures including: x86_64, armv71 and aarch64
     # You can read more about python wheels here: https://realpython.com/python-wheels/
   /lsiopy/bin/pip install -U --no-cache-dir --find-links https://wheel-index.linuxserver.io/ubuntu/ -r \
-    requirements.txt -r optional-requirements.txt && \
-# STEP 2 - Move contents of /app/calibre-web-automated/root to / and delete the /app/calibre-web-automated/root directory
-  cp -R /app/calibre-web-automated/root/* / && \
-  rm -R /app/calibre-web-automated/root/ && \
-# STEP 3 - Run CWA install script to make required dirs, set script permissions and add aliases for CLI commands  ect.
-  chmod +x /app/calibre-web-automated/scripts/setup-cwa.sh && \
-  /app/calibre-web-automated/scripts/setup-cwa.sh && \
-# STEP 4 - Create koplugin.zip from KOReader plugin folder
-  echo "~~~~ Creating koplugin.zip from KOReader plugin folder... ~~~~" && \
-  if [ -d "/app/calibre-web-automated/koreader/plugins/cwasync.koplugin" ]; then \
-    cd /app/calibre-web-automated/koreader/plugins && \
-    # Calculate digest of all files in the plugin for debugging purposes
-    echo "Calculating digest of plugin files..." && \
-    PLUGIN_DIGEST=$(find cwasync.koplugin -type f -name "*.lua" -o -name "*.json" | sort | xargs sha256sum | sha256sum | cut -d' ' -f1) && \
-    echo "Plugin digest: $PLUGIN_DIGEST" && \
-    # Create a file named after the digest inside the plugin folder
-    echo "Plugin files digest: $PLUGIN_DIGEST" > cwasync.koplugin/${PLUGIN_DIGEST}.digest && \
-    echo "Build date: $(date)" >> cwasync.koplugin/${PLUGIN_DIGEST}.digest && \
-    echo "Files included:" >> cwasync.koplugin/${PLUGIN_DIGEST}.digest && \
-    find cwasync.koplugin -type f -name "*.lua" -o -name "*.json" | sort >> cwasync.koplugin/${PLUGIN_DIGEST}.digest && \
-    zip -r koplugin.zip cwasync.koplugin/ && \
-    echo "Created koplugin.zip from cwasync.koplugin folder with digest file: ${PLUGIN_DIGEST}.digest"; \
-  else \
-    echo "Warning: cwasync.koplugin folder not found, skipping zip creation"; \
-  fi && \
-  # STEP 4.1 - Move koplugin.zip to static directory
-  if [ -f "/app/calibre-web-automated/koreader/plugins/koplugin.zip" ]; then \
-    mkdir -p /app/calibre-web-automated/cps/static && \
-    cp /app/calibre-web-automated/koreader/plugins/koplugin.zip /app/calibre-web-automated/cps/static/ && \
-    echo "Moved koplugin.zip to static directory"; \
-  else \
-    echo "Warning: koplugin.zip not found, skipping move to static directory"; \
-  fi && \
-# STEP 5 - Installs kepubify
+    /app/calibre-web-automated/requirements.txt -r /app/calibre-web-automated/optional-requirements.txt
+
+# STEP 4 - Install kepubify
+RUN \
   echo "**** install kepubify ****" && \
   if [[ $KEPUBIFY_RELEASE == 'newest' ]]; then \
     KEPUBIFY_RELEASE=$(curl -sX GET "https://api.github.com/repos/pgaskin/kepubify/releases/latest" \
@@ -144,27 +129,13 @@ RUN \
       /usr/bin/kepubify -L \
       https://github.com/pgaskin/kepubify/releases/download/${KEPUBIFY_RELEASE}/kepubify-linux-arm64; \
   fi && \
-# STEP 6 - Install Calibre
-  # STEP 6.1 - Install additional required packages
-  apt-get update && \
-  apt-get install -y --no-install-recommends \
-    libxtst6 \
-    libxrandr2 \
-    libxkbfile1 \
-    libxcomposite1 \
-    libopengl0 \
-    libnss3 \
-    libxkbcommon0 \
-    libegl1 \
-    libxdamage1 \
-    libgl1 \
-    libglx-mesa0 \
-    xz-utils \
-    binutils && \
-  # STEP 6.2 - Make the /app/calibre directory for the installed files
-  mkdir -p \
-  /app/calibre && \
-  # STEP 6.3 - Download the desired version of Calibre, determined by the CALIBRE_RELEASE variable and the architecture of the build environment
+  chmod +x /usr/bin/kepubify
+
+# STEP 5 - Install Calibre
+RUN \
+  # STEP 5.1 - Make the /app/calibre directory for the installed files
+  mkdir -p /app/calibre && \
+  # STEP 5.2 - Download the desired version of Calibre, determined by the CALIBRE_RELEASE variable and the architecture of the build environment
   if [ "$(uname -m)" == "x86_64" ]; then \
     curl -o \
       /calibre.txz -L \
@@ -174,46 +145,149 @@ RUN \
       /calibre.txz -L \
       "https://download.calibre-ebook.com/${CALIBRE_RELEASE}/calibre-${CALIBRE_RELEASE}-arm64.txz"; \
   fi && \
-  # STEP 6.4 - Extract the downloaded file to /app/calibre
+  # STEP 5.3 - Extract the downloaded file to /app/calibre
   tar xf \
       /calibre.txz -C \
       /app/calibre && \
-  # STEP 6.4.1 - Remove the ABI tag from the extracted libQt6* files to allow them to be used on older kernels
+  # STEP 5.3.1 - Remove the ABI tag from the extracted libQt6* files to allow them to be used on older kernels
     # Removed in V3.1.4 because it was breaking Calibre features that require Qt6. Replaced with a kernel check in the cwa-init service
-  # STEP 6.5 - Delete the extracted calibre.txz to save space in final image
-  rm /calibre.txz && \
-# STEP 7 - ADD files referencing the versions of the installed main packages
-  echo "$VERSION" >| /app/CWA_RELEASE && \
-  echo "$KEPUBIFY_RELEASE" >| /app/KEPUBIFY_RELEASE && \
-  echo "$CALIBRE_RELEASE" > /CALIBRE_RELEASE
+  # STEP 5.4 - Delete the extracted calibre.txz to save space in final image
+  rm /calibre.txz
+
+# ============================================================================
+# STAGE 2: Final - Build the final runtime image
+# ============================================================================
+FROM ghcr.io/linuxserver/baseimage-ubuntu:noble AS unrar-stage
+FROM ghcr.io/linuxserver/unrar:latest AS unrar
+
+FROM ghcr.io/linuxserver/baseimage-ubuntu:noble
+
+ARG BUILD_DATE
+ARG VERSION
+ARG CALIBREWEB_RELEASE=0.6.24
+ARG CALIBRE_RELEASE=8.9.0
+ARG KEPUBIFY_RELEASE=v4.0.4
+
+LABEL build_version="Version:- ${VERSION}"
+LABEL build_date="${BUILD_DATE}"
+LABEL CW-base-version="${CALIBREWEB_RELEASE}"
+LABEL maintainer="CrocodileStick"
 
-# Removes packages that are no longer required, also emptying dirs used to build the image that are no longer needed
+# Set the default shell for the following RUN instructions to bash instead of sh
+SHELL ["/bin/bash", "-c"]
+
+# Copy installed dependencies from the dependencies stage
+COPY --from=dependencies /lsiopy /lsiopy
+COPY --from=dependencies /usr/bin/kepubify /usr/bin/kepubify
+COPY --from=dependencies /app/calibre /app/calibre
+COPY --from=dependencies /usr/bin/lsof /usr/bin/lsof
+COPY --from=dependencies /usr/bin/python3.13 /usr/bin/python3.13
+COPY --from=dependencies /usr/lib/python3.13 /usr/lib/python3.13
+
+# Install only runtime packages (no build tools)
 RUN \
-  echo "**** cleanup ****" && \
-  apt-get -y purge \
-    build-essential \
-    libldap2-dev \
-    libsasl2-dev \
-    gettext \
-    python3.13-dev \
-    software-properties-common && \
+  echo "**** add deadsnakes PPA for Python 3.13 runtime ****" && \
+  apt-get update && \
+  apt-get install -y --no-install-recommends software-properties-common && \
+  add-apt-repository ppa:deadsnakes/ppa && \
+  apt-get update && \
+  echo "**** install runtime packages ****" && \
+  apt-get install -y --no-install-recommends \
+    imagemagick \
+    ghostscript \
+    libldap2 \
+    libmagic1 \
+    libsasl2-2 \
+    libxi6 \
+    libxslt1.1 \
+    xdg-utils \
+    inotify-tools \
+    python3.13 \
+    nano \
+    sqlite3 \
+    zip \
+    libxtst6 \
+    libxrandr2 \
+    libxkbfile1 \
+    libxcomposite1 \
+    libopengl0 \
+    libnss3 \
+    libxkbcommon0 \
+    libegl1 \
+    libxdamage1 \
+    libgl1 \
+    libglx-mesa0 \
+    xz-utils \
+    curl && \
+  # Create python3 symlink to point to python3.13
+  ln -sf /usr/bin/python3.13 /usr/bin/python3 && \
+  # Cleanup
+  apt-get -y purge software-properties-common && \
   apt-get -y autoremove && \
   rm -rf \
     /tmp/* \
     /var/lib/apt/lists/* \
     /var/tmp/* \
     /root/.cache
 
-# add unrar
+# STEP 6 - Copy application files
+# Copy the rest of the application code (changes most frequently)
+COPY --chown=abc:abc . /app/calibre-web-automated/
+
+# STEP 7 - Configure application
+RUN \
+  # STEP 7.1 - Move contents of /app/calibre-web-automated/root to / and delete the /app/calibre-web-automated/root directory
+  cp -R /app/calibre-web-automated/root/* / && \
+  rm -R /app/calibre-web-automated/root/ && \
+  # STEP 7.2 - Run CWA install script to make required dirs, set script permissions and add aliases for CLI commands  ect.
+  chmod +x /app/calibre-web-automated/scripts/setup-cwa.sh && \
+  /app/calibre-web-automated/scripts/setup-cwa.sh && \
+  # STEP 7.3 - Create koplugin.zip from KOReader plugin folder
+  echo "~~~~ Creating koplugin.zip from KOReader plugin folder... ~~~~" && \
+  if [ -d "/app/calibre-web-automated/koreader/plugins/cwasync.koplugin" ]; then \
+    cd /app/calibre-web-automated/koreader/plugins && \
+    # Calculate digest of all files in the plugin for debugging purposes
+    echo "Calculating digest of plugin files..." && \
+    PLUGIN_DIGEST=$(find cwasync.koplugin -type f -name "*.lua" -o -name "*.json" | sort | xargs sha256sum | sha256sum | cut -d' ' -f1) && \
+    echo "Plugin digest: $PLUGIN_DIGEST" && \
+    # Create a file named after the digest inside the plugin folder
+    echo "Plugin files digest: $PLUGIN_DIGEST" > cwasync.koplugin/${PLUGIN_DIGEST}.digest && \
+    echo "Build date: $(date)" >> cwasync.koplugin/${PLUGIN_DIGEST}.digest && \
+    echo "Files included:" >> cwasync.koplugin/${PLUGIN_DIGEST}.digest && \
+    find cwasync.koplugin -type f -name "*.lua" -o -name "*.json" | sort >> cwasync.koplugin/${PLUGIN_DIGEST}.digest && \
+    zip -r koplugin.zip cwasync.koplugin/ && \
+    echo "Created koplugin.zip from cwasync.koplugin folder with digest file: ${PLUGIN_DIGEST}.digest"; \
+  else \
+    echo "Warning: cwasync.koplugin folder not found, skipping zip creation"; \
+  fi && \
+  # STEP 7.4 - Move koplugin.zip to static directory
+  if [ -f "/app/calibre-web-automated/koreader/plugins/koplugin.zip" ]; then \
+    mkdir -p /app/calibre-web-automated/cps/static && \
+    cp /app/calibre-web-automated/koreader/plugins/koplugin.zip /app/calibre-web-automated/cps/static/ && \
+    echo "Moved koplugin.zip to static directory"; \
+  else \
+    echo "Warning: koplugin.zip not found, skipping move to static directory"; \
+  fi && \
+  # STEP 7.5 - ADD files referencing the versions of the installed main packages
+  echo "$VERSION" >| /app/CWA_RELEASE && \
+  echo "$KEPUBIFY_RELEASE" >| /app/KEPUBIFY_RELEASE && \
+  echo "$CALIBRE_RELEASE" > /CALIBRE_RELEASE
+
+# Add unrar from unrar stage
 COPY --from=unrar /usr/bin/unrar-ubuntu /usr/bin/unrar
 
-# set calibre environment variable
+# Set calibre environment variable
 ENV CALIBRE_CONFIG_DIR=/config/.config/calibre
 
-# ports and volumes
+# Ports and volumes
 WORKDIR /config
 # The default port CWA listens on. Can be overridden with the CWA_PORT_OVERRIDE environment variable.
 EXPOSE 8083
 VOLUME /config
 VOLUME /cwa-book-ingest
 VOLUME /calibre-library
+
+# Health check for container orchestration
+# Uses shell form to support environment variable substitution for CWA_PORT_OVERRIDE
+HEALTHCHECK --interval=30s --timeout=3s --start-period=120s --retries=3 \
+  CMD curl -f http://localhost:${CWA_PORT_OVERRIDE:-8083}/ || exit 1

README.md

@@ -73,7 +73,7 @@ ___
     \
     [![](https://dcbadge.limes.pink/api/server/https://discord.gg/EjgSeek94R)](https://discord.gg/EjgSeek94R)
 
-- Or alternativly make your own companion project, come hang out and or come get help if you're facing issues :)
+- Or alternatively make your own companion project, come hang out and or come get help if you're facing issues :)
 
 ## 🚨 To users planning to deploy via Network Shares (particularly NFS) 🚨
 

cps/__init__.py

@@ -43,8 +43,8 @@
 mimetypes.add_type('application/epub+zip', '.epub')
 mimetypes.add_type('application/epub+zip', '.kepub')
 mimetypes.add_type('text/xml', '.fb2')
-mimetypes.add_type('application/octet-stream', '.mobi')
-mimetypes.add_type('application/octet-stream', '.prc')
+mimetypes.add_type('application/x-mobipocket-ebook', '.mobi')
+mimetypes.add_type('application/x-mobipocket-ebook', '.prc')
 mimetypes.add_type('application/vnd.amazon.ebook', '.azw')
 mimetypes.add_type('application/x-mobi8-ebook', '.azw3')
 mimetypes.add_type('application/x-cbr', '.cbr')