Merge pull request #682 from Stirling-Tools/ebook

Ebook

.git-blame-ignore-revs

@@ -0,0 +1,2 @@
+# Formatting
+5f771b785130154ed47952635b7acef371ffe0ec

.gitattributes

@@ -1,5 +1,8 @@
+* text=auto eol=lf
+
 # Ignore all JavaScript files in a directory
 src/main/resources/static/pdfjs/* linguist-vendored
+src/main/resources/static/pdfjs/** linguist-vendored
 src/main/resources/static/css/bootstrap-icons.css linguist-vendored
 src/main/resources/static/css/bootstrap.min.css linguist-vendored
 src/main/resources/static/css/fonts/* linguist-vendored

.github/CODEOWNERS

@@ -0,0 +1,2 @@
+# All PRs to V1 must be approved by Frooodle
+* @Frooodle

.github/FUNDING.yml

@@ -1,6 +1,6 @@
 # These are supported funding model platforms
 
-github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+github: Frooodle # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
 patreon: # Replace with a single Patreon username
 open_collective: # Replace with a single Open Collective username
 ko_fi: # Replace with a single Ko-fi username

.github/dependabot.yml

@@ -9,3 +9,7 @@ updates:
     directory: "/" # Location of package manifests
     schedule:
       interval: "weekly"
+  - package-ecosystem: "docker"
+    directory: "/" # Location of Dockerfile
+    schedule:
+      interval: "weekly"

.github/pull_request_template.md

@@ -0,0 +1,4 @@
+# License Agreement for Contributions
+By submitting this pull request, I acknowledge and agree that my contributions will be included in Stirling-PDF and that they can be relicensed in the future under MPL 2.0 (Mozilla Public License Version 2.0) license. 
+
+(This does not change the general open-source nature of Stirling-PDF, simply moving from one license to another license)

.github/workflows/build.yml

@@ -0,0 +1,34 @@
+name: "Build repo"
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    - name: Set up JDK 17
+      uses: actions/setup-java@v3
+      with:
+        java-version: '17'
+        distribution: 'temurin'
+
+    - uses: gradle/gradle-build-action@v2.4.2
+      with:
+        gradle-version: 7.6
+        arguments: build --no-build-cache

.github/workflows/codeql.yml

@@ -1,55 +0,0 @@
-# For most projects, this workflow file will not need changing; you simply need
-# to commit it to your repository.
-#
-# You may wish to alter this file to override the set of languages analyzed,
-# or to provide custom queries or build logic.
-#
-# ******** NOTE ********
-# We have attempted to detect the languages in your repository. Please check
-# the `language` matrix defined below to confirm you have the correct set of
-
-name: "Build repo"
-
-on:
-  push:
-    branches: [ "main" ]
-  pull_request:
-    # The branches below must be a subset of the branches above
-    branches: [ "main" ]
-  schedule:
-    - cron: '15 12 * * 1'
-
-jobs:
-  analyze:
-    name: Analyze
-    runs-on: ubuntu-latest
-    permissions:
-      actions: read
-      contents: read
-      security-events: write
-
-    strategy:
-      fail-fast: false
-
-    steps:
-    - name: Checkout repository
-      uses: actions/checkout@v3
-      
-    - name: Set up JDK 17
-      uses: actions/setup-java@v3
-      with:
-        java-version: '17'
-        distribution: 'temurin'
-
-   # - name: Initialize CodeQL
-   #   uses: github/codeql-action/init@v2
-   #   with:
-   #     languages: java
-
-    - uses: gradle/gradle-build-action@v2.3.3
-      with:
-        gradle-version: 7.6
-        arguments: assemble --no-build-cache
-
-    #- name: Perform CodeQL analysis
-    #  uses: github/codeql-action/analyze@v2

.github/workflows/licenses-update.yml

@@ -0,0 +1,48 @@
+name: License Report Workflow
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'build.gradle'
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  generate-license-report:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v3
+
+      - name: Set up JDK 17
+        uses: actions/setup-java@v3
+        with:
+          java-version: '17'
+          distribution: 'adopt'
+
+      - name: Run Gradle Command
+        run: ./gradlew clean generateLicenseReport
+
+      - name: Move and Rename License File
+        run: |
+          mv build/reports/dependency-license/index.json src/main/resources/static/3rdPartyLicenses.json
+
+      - name: Check for Changes
+        id: git-check
+        run: |
+          git add src/main/resources/static/3rdPartyLicenses.json
+          git diff --staged --exit-code || echo "changes=true" >> $GITHUB_ENV
+
+      - name: Commit and Push Changes
+        if: env.changes == 'true'
+        run: |
+          git config --global user.name 'Stirling-PDF-Bot'
+          git config --global user.email 'Stirling-PDF-Bot@stirlingtools.com'
+          git commit -m "Update 3rd Party Licenses"
+          git push
+

.github/workflows/pull_request_template.md

@@ -0,0 +1,3 @@
+# License Agreement for Contributions
+By submitting this pull request, I acknowledge and agree that my contributions will be included in Stirling-PDF and that they can be relicensed in the future under MPL 2.0 (Mozilla Public License Version 2.0) license. 
+(This does not change the open-source nature of Stirling-PDF, simply moving from one license to another license)

.github/workflows/push-docker.yml

@@ -1,27 +1,31 @@
 name: Push Docker Image with VersionNumber
 
 on:
+  workflow_dispatch:
   push:
     branches: 
       - master
-      - testGit
       - main
+permissions:
+  contents: read
+  packages: write
 jobs:
   push:
-
     runs-on: ubuntu-latest
     steps:
 
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v3.5.2
     
     - name: Set up JDK 17
-      uses: actions/setup-java@v3
+      uses: actions/setup-java@v3.11.0
       with:
         java-version: '17'
         distribution: 'temurin'
     
 
-    - uses: gradle/gradle-build-action@v2.3.3
+    - uses: gradle/gradle-build-action@v2.4.2
+      env:
+        DOCKER_ENABLE_SECURITY: false
       with:
         gradle-version: 7.6
         arguments: clean build
@@ -37,43 +41,111 @@ jobs:
       uses: docker/login-action@v2.1.0
       with:
         username: ${{ secrets.DOCKER_HUB_USERNAME }}
-        password: ${{ secrets.DOCKER_HUB_API }} 
-   
-  #  - name: Check if tag exists
-  #    id: checkIdExists
-  #    continue-on-error: true
-  #    run: |
-  #      response=$(curl -s https://hub.docker.com/v2/repositories/frooodle/s-pdf/tags/?name=${{ steps.versionNumber.outputs.versionNumber }})
-  #      result=$(echo $response | jq ".results")
-  #      if [ "$result" == "[]" ]; then
-  #        echo "Tag ${{ steps.versionNumber.outputs.versionNumber }} doesnt exist. Continuing with build and push."
-  #      else
-  #        echo "Tag ${{ steps.versionNumber.outputs.versionNumber }} already exists. Skipping build and push."
-  #        exit 1;
-  #      fi
+        password: ${{ secrets.DOCKER_HUB_API }}
 
-   
-   
-    - name: Setup buildx
+    - name: Login to GitHub Container Registry
+      uses: docker/login-action@v2.1.0
+      with:
+        registry: ghcr.io
+        username: ${{ github.actor }}
+        password: ${{ github.token }}
+
+    - name: Convert repository owner to lowercase
+      id: repoowner
+      run: echo "::set-output name=lowercase::$(echo ${{ github.repository_owner }} | awk '{print tolower($0)}')"
+      
+    - name: Generate tags
+      id: meta
+      uses: docker/metadata-action@v4.4.0
+      with:
+        images: |
+          ${{ secrets.DOCKER_HUB_USERNAME }}/s-pdf
+          ghcr.io/${{ steps.repoowner.outputs.lowercase }}/s-pdf
+        tags: |
+          type=raw,value=${{ steps.versionNumber.outputs.versionNumber }},enable=${{ github.ref == 'refs/heads/master' }}
+          type=raw,value=latest,enable=${{ github.ref == 'refs/heads/master' }}
+          type=raw,value=alpha,enable=${{ github.ref == 'refs/heads/main' }}
+
+    - name: Set up QEMU
+      uses: docker/setup-qemu-action@v2.1.0
+
+    - name: Set up Docker Buildx
+      uses: docker/setup-buildx-action@v2.5.0
+
+    - name: Build and push main Dockerfile
+      uses: docker/build-push-action@v4.0.0
+      with:
+        context: .
+        dockerfile: ./Dockerfile
+        push: true
+        cache-from: type=gha
+        cache-to: type=gha,mode=max
+        tags: ${{ steps.meta.outputs.tags }}
+        labels: ${{ steps.meta.outputs.labels }}
+        build-args: 
+          VERSION_TAG=${{ steps.versionNumber.outputs.versionNumber }}
+        platforms: linux/amd64,linux/arm64/v8
+
+
+
+    - name: Generate tags ultra-lite
+      id: meta2
+      uses: docker/metadata-action@v4.4.0
+      if: github.ref != 'refs/heads/main'
+      with:
+        images: |
+          ${{ secrets.DOCKER_HUB_USERNAME }}/s-pdf
+          ghcr.io/${{ steps.repoowner.outputs.lowercase }}/s-pdf
+        tags: |
+          type=raw,value=${{ steps.versionNumber.outputs.versionNumber }}-ultra-lite,enable=${{ github.ref == 'refs/heads/master' }}
+          type=raw,value=latest-ultra-lite,enable=${{ github.ref == 'refs/heads/master' }}
+          
+
+    - name: Build and push Dockerfile-ultra-lite
+      uses: docker/build-push-action@v4.0.0
+      if: github.ref != 'refs/heads/main'
+      with:
+        context: .
+        file: ./Dockerfile-ultra-lite
+        push: true
+        cache-from: type=gha
+        cache-to: type=gha,mode=max
+        tags: ${{ steps.meta2.outputs.tags }}
+        labels: ${{ steps.meta2.outputs.labels }}
+        build-args: 
+          VERSION_TAG=${{ steps.versionNumber.outputs.versionNumber }}
+        platforms: linux/amd64,linux/arm64/v8
+
+
+
+    - name: Generate tags lite
+      id: meta3
+      uses: docker/metadata-action@v4.4.0
+      if: github.ref != 'refs/heads/main'
+      with:
+        images: |
+          ${{ secrets.DOCKER_HUB_USERNAME }}/s-pdf
+          ghcr.io/${{ steps.repoowner.outputs.lowercase }}/s-pdf
+        tags: |
+          type=raw,value=${{ steps.versionNumber.outputs.versionNumber }}-lite,enable=${{ github.ref == 'refs/heads/master' }}
+          type=raw,value=latest-lite,enable=${{ github.ref == 'refs/heads/master' }}
+          
+
+    - name: Build and push Dockerfile-lite
+      uses: docker/build-push-action@v4.0.0
+      if: github.ref != 'refs/heads/main'
+      with:
+        context: .
+        file: ./Dockerfile-lite
+        push: true
+        cache-from: type=gha
+        cache-to: type=gha,mode=max
+        tags: ${{ steps.meta3.outputs.tags }}
+        labels: ${{ steps.meta3.outputs.labels }}
+        build-args: 
+          VERSION_TAG=${{ steps.versionNumber.outputs.versionNumber }}
+        platforms: linux/amd64,linux/arm64/v8
+    - name: Build and Push Helm Chart
       run: |
-        docker buildx create --name mybuilder
-        docker buildx use mybuilder
-
-    - name: Build and push versioned amd64 and v8 
-      if: github.ref == 'refs/heads/main'
-      run: | 
-        docker buildx build --platform="linux/amd64,linux/arm64/v8" --push --tag "frooodle/s-pdf:${{ steps.versionNumber.outputs.versionNumber }}-alpha" .
-
-        
-    - name: Build and push versioned amd64 and v8 
-      if: github.ref == 'refs/heads/master'
-      run: | 
-        docker buildx build --platform="linux/amd64,linux/arm64/v8" --push --tag "frooodle/s-pdf:${{ steps.versionNumber.outputs.versionNumber }}" .
-
-   
-    - name: Build and push latest amd64 and v8
-      if: github.ref == 'refs/heads/master'
-      run: | 
-        docker buildx build --platform="linux/amd64,linux/arm64/v8" --push --tag "frooodle/s-pdf:latest" .
-        
-        
+        helm package chart/stirling-pdf
+        helm push stirling-pdf-chart-1.0.0.tgz oci://registry-1.docker.io/frooodle

.github/workflows/releaseArtifacts.yml

@@ -0,0 +1,57 @@
+name: Release Artifacts
+
+on: 
+  release: 
+    types: [created]
+permissions:
+  contents: write
+  packages: write
+jobs:
+  push:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        enable_security: [true, false]
+        include:
+          - enable_security: true
+            file_suffix: '-with-login'
+          - enable_security: false
+            file_suffix: ''
+    steps:
+    - uses: actions/checkout@v3.5.2
+    
+    - name: Set up JDK 17
+      uses: actions/setup-java@v3.11.0
+      with:
+        java-version: '17'
+        distribution: 'temurin'
+        
+    - name: Grant execute permission for gradlew
+      run: chmod +x gradlew
+
+    - name: Generate jar (With Security=${{ matrix.enable_security }})
+      run: ./gradlew clean createExe
+      env:
+        DOCKER_ENABLE_SECURITY: ${{ matrix.enable_security }}
+
+    - name: Upload binaries to release
+      uses: svenstaro/upload-release-action@v2
+      with:
+        repo_token: ${{ secrets.GITHUB_TOKEN }}
+        file: ./build/launch4j/Stirling-PDF.exe
+        asset_name: Stirling-PDF${{ matrix.file_suffix }}.exe
+        tag: ${{ github.ref }}
+        overwrite: true
+    
+    - name: Get version number
+      id: versionNumber
+      run: echo "::set-output name=versionNumber::$(./gradlew printVersion --quiet | tail -1)"
+      
+    - name: Upload jar binaries to release
+      uses: svenstaro/upload-release-action@v2
+      with:
+        repo_token: ${{ secrets.GITHUB_TOKEN }}
+        file: ./build/libs/Stirling-PDF-${{ steps.versionNumber.outputs.versionNumber }}.jar
+        asset_name: Stirling-PDF${{ matrix.file_suffix }}.jar
+        tag: ${{ github.ref }}
+        overwrite: true

.github/workflows/swagger.yml

@@ -0,0 +1,37 @@
+name: Update Swagger
+
+on:
+  workflow_dispatch:
+  push:
+    branches: 
+      - master
+jobs:
+  push:
+
+    runs-on: ubuntu-latest
+    steps:
+
+    - uses: actions/checkout@v3.5.2
+    
+    - name: Set up JDK 17
+      uses: actions/setup-java@v3.11.0
+      with:
+        java-version: '17'
+        distribution: 'temurin'
+        
+    - name: Grant execute permission for gradlew
+      run: chmod +x gradlew
+
+    - name: Generate Swagger documentation
+      run: ./gradlew generateOpenApiDocs
+
+    - name: Upload Swagger Documentation to SwaggerHub
+      run: ./gradlew swaggerhubUpload
+      env:
+        SWAGGERHUB_API_KEY: ${{ secrets.SWAGGERHUB_API_KEY }}
+
+    - name: Set API version as published and default on SwaggerHub
+      run: |
+        curl -X PUT -H "Authorization: ${SWAGGERHUB_API_KEY}" "https://api.swaggerhub.com/apis/Frooodle/Stirling-PDF/${{ steps.versionNumber.outputs.versionNumber }}/settings/lifecycle" -H  "accept: application/json" -H  "Content-Type: application/json" -d "{\"published\":true,\"default\":true}"
+      env:
+        SWAGGERHUB_API_KEY: ${{ secrets.SWAGGERHUB_API_KEY }}

.github/workflows/test.yml

@@ -0,0 +1,56 @@
+name: Docker Compose Tests
+
+on:
+  pull_request:
+    paths:
+      - 'src/**'
+      - '**.gradle'
+      - '!src/main/java/resources/messages*'
+      - 'exampleYmlFiles/**'
+      - 'Dockerfile'
+      - 'Dockerfile**'
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout Repository
+      uses: actions/checkout@v2
+
+    - name: Set up Java 17
+      uses: actions/setup-java@v2
+      with:
+        java-version: '17'
+        distribution: 'adopt'
+
+    - name: Set up Docker Buildx
+      uses: docker/setup-buildx-action@v1
+
+    - name: Run Docker Compose Tests
+      run: |
+        chmod +x ./gradlew
+        
+    - name: Get version number
+      id: versionNumber
+      run: echo "::set-output name=versionNumber::$(./gradlew printVersion --quiet | tail -1)"
+
+
+    - name: Cache Docker layers
+      uses: actions/cache@v2
+      with:
+        path: /tmp/.buildx-cache
+        key: ${{ runner.os }}-buildx-${{ steps.versionNumber.outputs.versionNumber }}
+        restore-keys: |
+          ${{ runner.os }}-buildx-
+
+    - name: Install Docker Compose
+      run: |
+        sudo curl -L "https://github.com/docker/compose/releases/download/v2.6.0/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
+        sudo chmod +x /usr/local/bin/docker-compose
+
+
+    - name: Run Docker Compose Tests
+      run: |
+        chmod +x ./test.sh
+        ./test.sh

.gitignore

@@ -1,112 +1,127 @@
-
-
-### Eclipse ###
-.metadata
-bin/
-tmp/
-*.tmp
-*.bak
-*.swp
-*~.nib
-local.properties
-.settings/
-.loadpath
-.recommenders
-.classpath
-.project
-
-# Gradle
-.gradle
-.lock
-
-# External tool builders
-.externalToolBuilders/
-
-# Locally stored "Eclipse launch configurations"
-*.launch
-
-# PyDev specific (Python IDE for Eclipse)
-*.pydevproject
-
-# CDT-specific (C/C++ Development Tooling)
-.cproject
-
-# CDT- autotools
-.autotools
-
-# Java annotation processor (APT)
-.factorypath
-
-# PDT-specific (PHP Development Tools)
-.buildpath
-
-# sbteclipse plugin
-.target
-
-# Tern plugin
-.tern-project
-
-# TeXlipse plugin
-.texlipse
-
-# STS (Spring Tool Suite)
-.springBeans
-
-# Code Recommenders
-.recommenders/
-
-# Annotation Processing
-.apt_generated/
-.apt_generated_test/
-
-# Scala IDE specific (Scala & Java development for Eclipse)
-.cache-main
-.scala_dependencies
-.worksheet
-
-# Uncomment this line if you wish to ignore the project description file.
-# Typically, this file would be tracked if it contains build/dependency configurations:
-#.project
-
-### Eclipse Patch ###
-# Spring Boot Tooling
-.sts4-cache/
-
-### Git ###
-# Created by git for backups. To disable backups in Git:
-# $ git config --global mergetool.keepBackup false
-*.orig
-
-# Created by git when using merge tools for conflicts
-*.BACKUP.*
-*.BASE.*
-*.LOCAL.*
-*.REMOTE.*
-*_BACKUP_*.txt
-*_BASE_*.txt
-*_LOCAL_*.txt
-*_REMOTE_*.txt
-
-### Java ###
-# Compiled class file
-*.class
-
-# Log file
-*.log
-
-# BlueJ files
-*.ctxt
-
-# Mobile Tools for Java (J2ME)
-.mtj.tmp/
-
-# Package Files #
-*.jar
-*.war
-*.nar
-*.ear
-*.zip
-*.tar.gz
-*.rar
-
-/build
+
+
+### Eclipse ###
+.metadata
+bin/
+tmp/
+*.tmp
+*.bak
+*.swp
+*~.nib
+local.properties
+.settings/
+.loadpath
+.recommenders
+.classpath
+.project
+version.properties
+pipeline/watchedFolders/
+pipeline/finishedFolders/
+#### Stirling-PDF Files ###
+customFiles/
+configs/
+watchedFolders/
+
+
+# Gradle
+.gradle
+.lock
+
+# External tool builders
+.externalToolBuilders/
+
+# Locally stored "Eclipse launch configurations"
+*.launch
+
+# PyDev specific (Python IDE for Eclipse)
+*.pydevproject
+
+# CDT-specific (C/C++ Development Tooling)
+.cproject
+
+# CDT- autotools
+.autotools
+
+# Java annotation processor (APT)
+.factorypath
+
+# PDT-specific (PHP Development Tools)
+.buildpath
+
+# sbteclipse plugin
+.target
+
+# Tern plugin
+.tern-project
+
+# TeXlipse plugin
+.texlipse
+
+# STS (Spring Tool Suite)
+.springBeans
+
+# Code Recommenders
+.recommenders/
+
+# Annotation Processing
+.apt_generated/
+.apt_generated_test/
+
+# Scala IDE specific (Scala & Java development for Eclipse)
+.cache-main
+.scala_dependencies
+.worksheet
+
+# Uncomment this line if you wish to ignore the project description file.
+# Typically, this file would be tracked if it contains build/dependency configurations:
+#.project
+
+### Eclipse Patch ###
+# Spring Boot Tooling
+.sts4-cache/
+
+### Git ###
+# Created by git for backups. To disable backups in Git:
+# $ git config --global mergetool.keepBackup false
+*.orig
+
+# Created by git when using merge tools for conflicts
+*.BACKUP.*
+*.BASE.*
+*.LOCAL.*
+*.REMOTE.*
+*_BACKUP_*.txt
+*_BASE_*.txt
+*_LOCAL_*.txt
+*_REMOTE_*.txt
+
+### Java ###
+# Compiled class file
+*.class
+
+# Log file
+*.log
+
+# BlueJ files
+*.ctxt
+
+# Mobile Tools for Java (J2ME)
+.mtj.tmp/
+
+# Package Files #
+*.jar
+*.war
+*.nar
+*.ear
+*.zip
+*.tar.gz
+*.rar
+*.db
+/build
+
+/.vscode
+/.idea
+
+# Ignore Mac DS_Store files
+.DS_Store
+**/.DS_Store

Dockerfile

@@ -1,61 +1,47 @@
-# Build jbig2enc in a separate stage
-FROM debian:bullseye-slim as jbig2enc_builder
+# Use the base image
+FROM frooodle/stirling-pdf-base:version8
 
-RUN apt-get update && \
-    apt-get install -y --no-install-recommends \
-        git \
-        automake \
-        autoconf \
-        libtool \
-        libleptonica-dev \
-        pkg-config \
-        ca-certificates \
-        zlib1g-dev \
-		make \
-		g++
+ARG VERSION_TAG
 
-RUN git clone https://github.com/agl/jbig2enc && \
-    cd jbig2enc && \
-    ./autogen.sh && \
-    ./configure && \
-    make && \
-    make install
+# Set Environment Variables
+ENV DOCKER_ENABLE_SECURITY=false \
+    HOME=/home/stirlingpdfuser \
+    VERSION_TAG=$VERSION_TAG \
+    JAVA_TOOL_OPTIONS="$JAVA_TOOL_OPTIONS -XX:MaxRAMPercentage=75"
+#    PUID=1000 \
+#    PGID=1000 \
+#    UMASK=022 \
+    
 
-# Main stage
-FROM openjdk:17-jdk-slim
+# Create user and group
+##RUN groupadd -g $PGID stirlingpdfgroup && \
+##    useradd -u $PUID -g stirlingpdfgroup -s /bin/sh stirlingpdfuser && \
+##    mkdir -p $HOME && chown stirlingpdfuser:stirlingpdfgroup $HOME
 
-# Install necessary dependencies
-RUN apt-get update && \
-    apt-get install -y --no-install-recommends \
-        libreoffice-core \
-        libreoffice-common \
-        libreoffice-writer \
-        libreoffice-calc \
-        libreoffice-impress \
-        python3-uno \
-		python3-pip \
-        unoconv \
-		pngquant \
-		unpaper \
-        ocrmypdf && \
-	pip install --user --upgrade ocrmypdf
+# Set up necessary directories and permissions
+RUN mkdir -p /scripts /usr/share/fonts/opentype/noto /usr/share/tesseract-ocr /configs /logs /customFiles /pipeline /pipeline/defaultWebUIConfigs  /pipeline/watchedFolders /pipeline/finishedFolders
+##&& \
+##    chown -R stirlingpdfuser:stirlingpdfgroup /scripts /usr/share/fonts/opentype/noto /usr/share/tesseract-ocr /configs /customFiles && \
+##    chown -R stirlingpdfuser:stirlingpdfgroup /usr/share/tesseract-ocr-original
 
-# Copy the jbig2enc binary from the builder stage
-COPY --from=jbig2enc_builder /usr/local/bin/jbig2 /usr/local/bin/jbig2
-
-# Copy the application JAR file
+# Copy necessary files
+COPY ./scripts/* /scripts/
+COPY ./pipeline/ /pipeline/
+COPY src/main/resources/static/fonts/*.ttf /usr/share/fonts/opentype/noto/
+COPY src/main/resources/static/fonts/*.otf /usr/share/fonts/opentype/noto/
 COPY build/libs/*.jar app.jar
 
-# Expose the application port
+# Set font cache and permissions
+RUN fc-cache -f -v && chmod +x /scripts/*
+
+##&& \
+##    chown stirlingpdfuser:stirlingpdfgroup /app.jar && \
+##    chmod +x /scripts/init.sh
+
+# Expose necessary ports
 EXPOSE 8080
 
-# Set environment variables
-ENV APP_HOME_NAME="Stirling PDF"
-#ENV APP_HOME_DESCRIPTION="Personal PDF Website!"
-#ENV APP_NAVBAR_NAME="Stirling PDF"
-
-# Run the application
-ENTRYPOINT java -jar /app.jar
-
-
-
+# Set user and run command
+##USER stirlingpdfuser
+ENTRYPOINT ["/scripts/init.sh"]
+CMD ["java", "-Dfile.encoding=UTF-8", "-jar", "/app.jar"]

Dockerfile-lite

@@ -0,0 +1,65 @@
+# Build jbig2enc in a separate stage
+FROM bellsoft/liberica-openjdk-debian:17
+
+ARG VERSION_TAG
+
+RUN apt-get update && \
+    apt-get install -y --no-install-recommends \
+        libreoffice-core \
+        libreoffice-common \
+        libreoffice-writer \
+        libreoffice-calc \
+        libreoffice-impress \
+        unoconv && \
+    rm -rf /var/lib/apt/lists/*
+
+
+# Set Environment Variables
+ENV DOCKER_ENABLE_SECURITY=false \
+    HOME=/home/stirlingpdfuser \
+    VERSION_TAG=$VERSION_TAG \
+    JAVA_TOOL_OPTIONS="$JAVA_TOOL_OPTIONS -XX:MaxRAMPercentage=75"
+#	PUID=1000 \
+#   PGID=1000 \
+#   UMASK=022 \
+
+# Create user and group
+#RUN groupadd -g $PGID stirlingpdfgroup && \
+#    useradd -u $PUID -g stirlingpdfgroup -s /bin/sh stirlingpdfuser && \
+#    mkdir -p $HOME && chown stirlingpdfuser:stirlingpdfgroup $HOME
+
+# Set up necessary directories and permissions
+RUN mkdir -p /scripts /usr/share/fonts/opentype/noto /configs /customFiles /logs /pipeline /pipeline/defaultWebUIConfigs  /pipeline/watchedFolders /pipeline/finishedFolders
+
+#    chown -R stirlingpdfuser:stirlingpdfgroup /usr/share/fonts/opentype/noto /configs /customFiles
+
+# Copy necessary files
+COPY ./scripts/download-security-jar.sh /scripts/download-security-jar.sh
+COPY ./scripts/init-without-ocr.sh /scripts/init-without-ocr.sh
+COPY ./pipeline/ /pipeline/
+COPY src/main/resources/static/fonts/*.ttf /usr/share/fonts/opentype/noto/
+COPY src/main/resources/static/fonts/*.otf /usr/share/fonts/opentype/noto/
+COPY build/libs/*.jar app.jar
+
+# Set font cache and permissions
+RUN fc-cache -f -v && \
+chmod +x /scripts/init-without-ocr.sh && \
+chmod +x /scripts/download-security-jar.sh
+
+
+#    chown stirlingpdfuser:stirlingpdfgroup /app.jar
+
+
+
+
+# Expose the application port
+EXPOSE 8080
+
+# Set environment variables
+ENV ENDPOINTS_GROUPS_TO_REMOVE=Python,OpenCV,OCRmyPDF
+ENV DOCKER_ENABLE_SECURITY=false
+
+# Run the application
+#USER stirlingpdfuser
+ENTRYPOINT ["/scripts/init-without-ocr.sh"]
+CMD ["java", "-Dfile.encoding=UTF-8", "-jar", "/app.jar"]

Dockerfile-ultra-lite

@@ -0,0 +1,46 @@
+# Build jbig2enc in a separate stage
+FROM bellsoft/liberica-openjdk-alpine:17
+
+ARG VERSION_TAG
+
+# Set Environment Variables
+ENV DOCKER_ENABLE_SECURITY=false \
+    HOME=/home/stirlingpdfuser \
+    VERSION_TAG=$VERSION_TAG \
+    JAVA_TOOL_OPTIONS="$JAVA_TOOL_OPTIONS -XX:MaxRAMPercentage=75"
+#	PUID=1000 \
+#   PGID=1000 \
+#   UMASK=022 \
+
+# Create user and group using Alpine's addgroup and adduser
+#RUN addgroup -g $PGID stirlingpdfgroup && \
+#    adduser -u $PUID -G stirlingpdfgroup -s /bin/sh -D stirlingpdfuser && \
+#    mkdir -p $HOME && chown stirlingpdfuser:stirlingpdfgroup $HOME
+
+# Set up necessary directories and permissions
+#RUN mkdir -p /scripts /configs /customFiles && \
+#    chown -R stirlingpdfuser:stirlingpdfgroup /scripts /configs /customFiles /logs /pipeline /pipeline/defaultWebUIConfigs  /pipeline/watchedFolders /pipeline/finishedFolders
+ 
+RUN mkdir -p /scripts /usr/share/fonts/opentype/noto /configs /customFiles
+COPY ./scripts/download-security-jar.sh /scripts/download-security-jar.sh
+COPY ./scripts/init-without-ocr.sh /scripts/init-without-ocr.sh
+COPY ./pipeline/ /pipeline/
+COPY build/libs/*.jar app.jar
+
+# Set font cache and permissions
+#RUN chown stirlingpdfuser:stirlingpdfgroup /app.jar
+
+RUN chmod +x /scripts/init-without-ocr.sh && \
+chmod +x /scripts/download-security-jar.sh && \
+apk add --no-cache curl
+
+# Expose the application port
+EXPOSE 8080
+
+# Set environment variables
+ENV ENDPOINTS_GROUPS_TO_REMOVE=CLI
+
+ENTRYPOINT ["/scripts/init-without-ocr.sh"]
+
+# Run the application
+CMD ["java", "-Dfile.encoding=UTF-8", "-jar", "/app.jar"]

DockerfileBase

@@ -0,0 +1,43 @@
+# Main stage
+FROM ubuntu:latest AS base
+
+
+
+# JDK for app
+RUN apt-get update && \
+    apt-get install -y --no-install-recommends \
+    	openjdk-17-jre && \
+    rm -rf /var/lib/apt/lists/*
+    	
+# Doc conversion
+RUN apt-get update && \
+    apt-get install -y --no-install-recommends \
+    	libreoffice-core \
+        libreoffice-common \
+        libreoffice-writer \
+        libreoffice-calc \
+        libreoffice-impress \
+		python3-uno \
+		curl \
+		unoconv && \
+    rm -rf /var/lib/apt/lists/*
+		
+		
+# OCR MY PDF (unpaper for descew and other advanced featues)
+RUN apt-get update && apt-get install -y --no-install-recommends software-properties-common gnupg2 && \
+add-apt-repository ppa:alex-p/tesseract-ocr5 && apt install -y --no-install-recommends tesseract-ocr && \
+apt-get update && \
+    apt-get install -y --no-install-recommends \
+        ghostscript \
+        python3-pip \
+        ocrmypdf \
+        unpaper && \
+    rm -rf /var/lib/apt/lists/* && \
+    mv /usr/share/tesseract-ocr /usr/share/tesseract-ocr-original && \
+    pip install --no-cache-dir --upgrade pip && \
+    pip install --no-cache-dir --upgrade ocrmypdf && \
+    pip install --no-cache-dir --upgrade pillow==10.0.1 reportlab==3.6.13 wheel==0.38.1 setuptools==65.5.1 pyjwt==2.4.0 cryptography==39.0.1
+    
+    
+#CV and HTML   
+RUN pip install --no-cache-dir opencv-python-headless WeasyPrint 

Endpoint-groups.md

@@ -0,0 +1,46 @@
+| Operation           | PageOps | Convert | Security | Other | CLI  | Python | OpenCV | LibreOffice | OCRmyPDF | Java     | Javascript |
+|---------------------|---------|---------|----------|-------|------|--------|--------|-------------|----------|----------|------------|
+| adjust-contrast     |    ✔️    |         |          |       |      |        |        |             |          |           |    ✔️      |
+| auto-split-pdf      |    ✔️    |         |          |       |      |        |        |             |          |    ✔️     |            |
+| crop                |    ✔️    |         |          |       |      |        |        |             |          |    ✔️     |            |
+| extract-page        |    ✔️    |         |          |       |      |        |        |             |          |    ✔️     |            |
+| merge-pdfs          |    ✔️    |         |          |       |      |        |        |             |          |    ✔️     |            |
+| multi-page-layout   |    ✔️    |         |          |       |      |        |        |             |          |    ✔️     |            |
+| pdf-organizer       |    ✔️    |         |          |       |      |        |        |             |          |    ✔️     |    ✔️       |
+| pdf-to-single-page  |    ✔️    |         |          |       |      |        |        |             |          |    ✔️     |            |
+| remove-pages        |    ✔️    |         |          |       |      |        |        |             |          |    ✔️     |            |
+| rotate-pdf          |    ✔️    |         |          |       |      |        |        |             |          |    ✔️     |            |
+| scale-pages         |    ✔️    |         |          |       |      |        |        |             |          |    ✔️     |            |
+| split-pdfs          |    ✔️    |         |          |       |      |        |        |             |          |    ✔️     |            |
+| file-to-pdf         |         |    ✔️    |          |       |  ✔️   |        |        |     ✔️       |          |          |            |
+| img-to-pdf          |         |    ✔️    |          |       |      |        |        |             |          |    ✔️     |            |
+| pdf-to-html         |         |    ✔️    |          |       |  ✔️   |        |        |     ✔️       |          |          |            |
+| pdf-to-img          |         |    ✔️    |          |       |      |        |        |             |          |    ✔️     |            |
+| pdf-to-pdfa         |         |    ✔️    |          |       |  ✔️   |        |        |             |    ✔️     |          |            |
+| pdf-to-markdown     |         |    ✔️    |          |       |      |        |        |             |            |    ✔️      |            |
+| pdf-to-presentation |         |    ✔️    |          |       |  ✔️   |        |        |     ✔️       |          |          |            |
+| pdf-to-text         |         |    ✔️    |          |       |  ✔️   |        |        |     ✔️       |          |          |            |
+| pdf-to-word         |         |    ✔️    |          |       |  ✔️   |        |        |     ✔️       |          |          |            |
+| pdf-to-xml          |         |    ✔️    |          |       |  ✔️   |        |        |     ✔️       |          |          |            |
+| xlsx-to-pdf         |         |    ✔️    |          |       |  ✔️   |        |        |     ✔️       |          |          |            |
+| add-password        |         |         |    ✔️     |       |      |        |        |             |          |    ✔️     |            |
+| add-watermark       |         |         |    ✔️     |       |      |        |        |             |          |    ✔️     |            |
+| cert-sign           |         |         |    ✔️     |       |      |        |        |             |          |    ✔️     |            |
+| change-permissions  |         |         |    ✔️     |       |      |        |        |             |          |    ✔️     |            |
+| remove-password     |         |         |    ✔️     |       |      |        |        |             |          |    ✔️     |            |
+| sanitize-pdf        |         |         |    ✔️     |       |      |        |        |             |          |    ✔️     |            |
+| add-image           |         |         |          |  ✔️    |      |        |        |             |          |    ✔️     |            |
+| add-page-numbers    |         |         |          |  ✔️    |      |        |        |             |          |    ✔️     |            |
+| auto-rename         |         |         |          |  ✔️    |      |        |        |             |          |    ✔️     |            |
+| change-metadata     |         |         |          |  ✔️    |      |        |        |             |          |    ✔️     |            |
+| compare             |         |         |          |  ✔️    |      |        |        |             |          |          |    ✔️       |
+| compress-pdf        |         |         |          |  ✔️    |  ✔️   |        |        |             |    ✔️     |          |            |
+| extract-image-scans |         |         |          |  ✔️    |  ✔️   |   ✔️    |   ✔️    |             |          |          |            |
+| extract-images      |         |         |          |  ✔️    |      |        |        |             |          |    ✔️     |            |
+| flatten             |         |         |          |  ✔️    |      |        |        |             |          |          |      ✔️      |
+| get-info-on-pdf     |         |         |          |  ✔️    |      |        |        |             |          |    ✔️      |            |
+| ocr-pdf             |         |         |          |  ✔️    |  ✔️   |        |        |             |    ✔️     |          |            |
+| remove-blanks       |         |         |          |  ✔️    |  ✔️   |   ✔️    |   ✔️    |             |          |          |            |
+| repair              |         |         |          |  ✔️    |  ✔️   |        |        |     ✔️       |          |          |            |
+| show-javascript     |         |         |          |  ✔️    |      |        |        |             |          |          |    ✔️       |
+| sign                |         |         |          |  ✔️    |      |        |        |             |          |          |    ✔️       |

FolderScanning.md

@@ -0,0 +1,41 @@
+## User Guide for Local Directory Scanning and File Processing
+
+### Whilst Pipelines are in alpha...
+You must enable this alpha functionality by setting
+```
+system:
+  enableAlphaFunctionality: true
+```
+To true like in the above for your `/config/settings.yml` file, after restarting Stirling-PDF you should see both UI and folder scanning enabled.
+
+### Setting Up Watched Folders:
+- Create a folder where you want your files to be monitored. This is your 'watched folder'.
+- The default directory for this is `./pipeline/watchedFolders/`
+- Place any directories you want to be scanned into this folder, this folder should contain multiple folders each for their own tasks and pipelines.
+
+### Configuring Processing with JSON Files:
+- In each directory you want processed (e.g `./pipeline/watchedFolders/officePrinter`), include a JSON configuration file.
+- This JSON file should specify how you want the files in the directory to be handled (e.g., what operations to perform on them) which can be made, configured and downloaded from Stirling-PDF Pipeline interface.r
+
+### Automatic Scanning and Processing:
+- The system automatically checks the watched folder every minute for new directories and files to process.
+- When a directory with a valid JSON configuration file is found, it begins processing the files inside as per the configuration.
+
+### Processing Steps:
+- Files in each directory are processed according to the instructions in the JSON file.
+- This might involve file conversions, data filtering, renaming files, etc. If the output of a step is a zip, this zip will be automatically unzipped as it passes to next process.
+
+### Results and Output:
+- After processing, the results are saved in a specified output location. This could be a different folder or location as defined in the JSON file or the default location `./pipeline/finishedFolders/`.
+- Each processed file is named and organized according to the rules set in the JSON configuration.
+
+### Completion and Cleanup:
+- Once processing is complete, the original files in the watched folder's directory are removed.
+- You can find the processed files in the designated output location.
+
+### Error Handling:
+- If there's an error during processing, the system will not delete the original files, allowing you to check and retry if necessary.
+
+### User Interaction:
+- As a user, your main tasks are to set up the watched folders, place directories with files for processing, and create the corresponding JSON configuration files.
+- The system handles the rest, including scanning, processing, and outputting results.

HowToAddNewLanguage.md

@@ -1,4 +1,4 @@
-<p align="center"><img src="https://raw.githubusercontent.com/Frooodle/Stirling-PDF/main/docs/stirling.png" width="80" ><br><h1 align="center">Stirling-PDF</h1>
+<p align="center"><img src="https://raw.githubusercontent.com/Stirling-Tools/Stirling-PDF/main/docs/stirling.png" width="80" ><br><h1 align="center">Stirling-PDF</h1>
 </p>
 
 
@@ -8,17 +8,24 @@ Fork Stirling-PDF and make a new branch out of Main
 
 Then add reference to the language in the navbar by adding a new language entry to the dropdown
 
-https://github.com/Frooodle/Stirling-PDF/blob/main/src/main/resources/templates/fragments/navbar.html#L80
+https://github.com/Stirling-Tools/Stirling-PDF/blob/main/src/main/resources/templates/fragments/languages.html
+and add a flag svg file to 
+https://github.com/Stirling-Tools/Stirling-PDF/tree/main/src/main/resources/static/images/flags
+Any SVG flags are fine, i got most of mine from [here](https://flagicons.lipis.dev/)
+If your language isnt represented by a flag just find whichever closely matches it, such as for Arabic i chose Saudi Arabia
+
 
 For example to add Polish you would add 
 ```
-<a class="dropdown-item lang_dropdown-item" href="" data-language-code="pl_PL">Polish</a>
+<a class="dropdown-item lang_dropdown-item" href="" data-language-code="pl_PL">
+    <img src="images/flags/pl.svg" alt="icon" width="20" height="15"> Polski
+</a>
 ```
 The data-language-code is the code used to reference the file in the next step.
 
 Start by copying the existing english property file 
 
-[https://github.com/Frooodle/Stirling-PDF/tree/langSetup/src/main/resources/messages_en_GB.properties](https://github.com/Frooodle/Stirling-PDF/blob/main/src/main/resources/messages_en_US.properties)
+[https://github.com/Stirling-Tools/Stirling-PDF/blob/main/src/main/resources/messages_en_GB.properties](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/src/main/resources/messages_en_GB.properties)
 
 Copy and rename it to messages_{your data-language-code here}.properties, in the polish example you would set the name to messages_pl_PL.properties
 

HowToUseOCR.md

@@ -2,8 +2,11 @@
 
 This document provides instructions on how to add additional language packs for the OCR tab in Stirling-PDF, both inside and outside of Docker.
 
+## My OCR used to work and now doesnt!
+Please update your tesseract docker volume path version from 4.00 to 5
+
 ## How does the OCR Work
-Stirling-PDF uses OCRmyPDF which in turn uses tesseract for its text recognition.
+Stirling-PDF uses [OCRmyPDF](https://github.com/ocrmypdf/OCRmyPDF) which in turn uses tesseract for its text recognition.
 All credit goes to them for this awesome work! 
 
 ## Language Packs
@@ -18,7 +21,9 @@ Depending on your requirements, you can choose the appropriate language pack for
 ### Installing Language Packs
 
 1. Download the desired language pack(s) by selecting the `.traineddata` file(s) for the language(s) you need.
-2. Place the `.traineddata` files in the Tesseract tessdata directory: `/usr/share/tesseract-ocr/4.00/tessdata`
+2. Place the `.traineddata` files in the Tesseract tessdata directory: `/usr/share/tesseract-ocr/5/tessdata` (Debian) or `/usr/share/tesseract/tessdata` (Fedora)
+
+# DO NOT REMOVE EXISTING ENG.TRAINEDDATA, IT'S REQUIRED.
 
 #### Docker
 
@@ -32,18 +37,43 @@ services:
   your_service_name:
     image: your_docker_image_name
     volumes:
-      - /usr/share/tesseract-ocr/4.00/tessdata:/location/of/trainingData
+      - /location/of/trainingData:/usr/share/tesseract-ocr/5/tessdata
 ```
 
 
 #### Docker run
 Add the following to your existing docker run command
 ```bash
--v /usr/share/tesseract-ocr/4.00/tessdata:/location/of/trainingData
+-v /location/of/trainingData:/usr/share/tesseract-ocr/5/tessdata
 ```
 
 #### Non-Docker
 If you are not using Docker, you need to install the OCR components, including the ocrmypdf app.
 You can see [OCRmyPDF install guide](https://ocrmypdf.readthedocs.io/en/latest/installation.html)
 
+Debian based systems, install languages with this command:
 
+```bash
+sudo apt update &&\
+# All languages
+# sudo apt install -y 'tesseract-ocr-*'
+
+# Find languages:
+apt search tesseract-ocr-
+
+# View installed languages:
+dpkg-query -W tesseract-ocr- | sed 's/tesseract-ocr-//g'
+```
+
+Fedora:
+
+```bash
+# All languages
+# sudo dnf install -y tesseract-langpack-*
+
+# Find languages:
+dnf search -C tesseract-langpack-
+
+# View installed languages:
+rpm -qa | grep tesseract-langpack | sed 's/tesseract-langpack-//g'
+```

Jenkinsfile

@@ -22,12 +22,24 @@ pipeline {
                     def appVersion = sh(returnStdout: true, script: './gradlew printVersion -q').trim()
                     def image = "frooodle/s-pdf:$appVersion"
                     withCredentials([string(credentialsId: 'docker_hub_access_token', variable: 'DOCKER_HUB_ACCESS_TOKEN')]) {
-				sh "docker login --username frooodle --password $DOCKER_HUB_ACCESS_TOKEN"
+				        sh "docker login --username frooodle --password $DOCKER_HUB_ACCESS_TOKEN"
                         sh "docker push $image"
                     }
                 }
             }
-    	
-	}
-   }
+        }
+        stage('Helm Push') {
+            steps {
+                script {
+                    //TODO: Read chartVersion from Chart.yaml
+                    def chartVersion = '1.0.0'
+                    withCredentials([string(credentialsId: 'docker_hub_access_token', variable: 'DOCKER_HUB_ACCESS_TOKEN')]) {
+				        sh "docker login --username frooodle --password $DOCKER_HUB_ACCESS_TOKEN"
+				        sh "helm package chart/stirling-pdf"
+                        sh "helm push stirling-pdf-chart-1.0.0.tgz oci://registry-1.docker.io/frooodle"
+                    }
+                }
+            }
+        }
+    }
 }

LICENSE

@@ -1,201 +1,674 @@
-                                 Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
 
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
 
-   1. Definitions.
+                            Preamble
 
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
+  The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
 
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.  We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors.  You can apply it to
+your programs, too.
 
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
 
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
+  To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights.  Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
 
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received.  You must make sure that they, too, receive
+or can get the source code.  And you must show them these terms so they
+know their rights.
 
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
+  Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
 
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
+  For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software.  For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
 
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
+  Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so.  This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software.  The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable.  Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products.  If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
 
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
+  Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary.  To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
 
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
+  The precise terms and conditions for copying, distribution and
+modification follow.
 
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
+                       TERMS AND CONDITIONS
 
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
+  0. Definitions.
 
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
+  "This License" refers to version 3 of the GNU General Public License.
 
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
+  "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
 
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
+  "The Program" refers to any copyrightable work licensed under this
+License.  Each licensee is addressed as "you".  "Licensees" and
+"recipients" may be individuals or organizations.
 
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
+  To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy.  The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
 
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
+  A "covered work" means either the unmodified Program or a work based
+on the Program.
 
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
+  To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy.  Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
 
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
+  To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies.  Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
 
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
+  An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License.  If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
 
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
+  1. Source Code.
 
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
+  The "source code" for a work means the preferred form of the work
+for making modifications to it.  "Object code" means any non-source
+form of a work.
 
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
+  A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
 
-   END OF TERMS AND CONDITIONS
+  The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form.  A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
 
-   APPENDIX: How to apply the Apache License to your work.
+  The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities.  However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work.  For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
 
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
+  The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
 
-   Copyright [yyyy] [name of copyright owner]
+  The Corresponding Source for a work in source code form is that
+same work.
 
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
+  2. Basic Permissions.
 
-       http://www.apache.org/licenses/LICENSE-2.0
+  All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met.  This License explicitly affirms your unlimited
+permission to run the unmodified Program.  The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work.  This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
 
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.
+  You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force.  You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright.  Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+  Conveying under any other circumstances is permitted solely under
+the conditions stated below.  Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+  No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+  When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+  4. Conveying Verbatim Copies.
+
+  You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+  You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+  5. Conveying Modified Source Versions.
+
+  You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+    a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+
+    b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under section
+    7.  This requirement modifies the requirement in section 4 to
+    "keep intact all notices".
+
+    c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy.  This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged.  This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+
+    d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+  A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit.  Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+  6. Conveying Non-Source Forms.
+
+  You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+    a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+
+    b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the
+    Corresponding Source from a network server at no charge.
+
+    c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source.  This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+
+    d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge.  You need not require recipients to copy the
+    Corresponding Source along with the object code.  If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source.  Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+
+    e) Convey the object code using peer-to-peer transmission, provided
+    you inform other peers where the object code and Corresponding
+    Source of the work are being offered to the general public at no
+    charge under subsection 6d.
+
+  A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+  A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling.  In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage.  For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product.  A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+  "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source.  The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+  If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information.  But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+  The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed.  Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+  Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+  7. Additional Terms.
+
+  "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law.  If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+  When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it.  (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.)  You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+  Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+    a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+
+    b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+
+    c) Prohibiting misrepresentation of the origin of that material, or
+    requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+
+    d) Limiting the use for publicity purposes of names of licensors or
+    authors of the material; or
+
+    e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+
+    f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions of
+    it) with contractual assumptions of liability to the recipient, for
+    any liability that these contractual assumptions directly impose on
+    those licensors and authors.
+
+  All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10.  If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term.  If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+  If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+  Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+  8. Termination.
+
+  You may not propagate or modify a covered work except as expressly
+provided under this License.  Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+  However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+  Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+  Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License.  If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+  9. Acceptance Not Required for Having Copies.
+
+  You are not required to accept this License in order to receive or
+run a copy of the Program.  Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance.  However,
+nothing other than this License grants you permission to propagate or
+modify any covered work.  These actions infringe copyright if you do
+not accept this License.  Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+  10. Automatic Licensing of Downstream Recipients.
+
+  Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License.  You are not responsible
+for enforcing compliance by third parties with this License.
+
+  An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations.  If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+  You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License.  For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+  11. Patents.
+
+  A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based.  The
+work thus licensed is called the contributor's "contributor version".
+
+  A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version.  For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+  Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+  In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement).  To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+  If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients.  "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+  If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+  A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License.  You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+  Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+  12. No Surrender of Others' Freedom.
+
+  If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all.  For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+  13. Use with the GNU Affero General Public License.
+
+  Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work.  The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+  14. Revised Versions of this License.
+
+  The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+  Each version is given a distinguishing version number.  If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation.  If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+  If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+  Later license versions may give you additional or different
+permissions.  However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+  15. Disclaimer of Warranty.
+
+  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. Limitation of Liability.
+
+  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+  17. Interpretation of Sections 15 and 16.
+
+  If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+  If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+    <program>  Copyright (C) <year>  <name of author>
+    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+  You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<https://www.gnu.org/licenses/>.
+
+  The GNU General Public License does not permit incorporating your program
+into proprietary programs.  If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.  But first, please read
+<https://www.gnu.org/licenses/why-not-lgpl.html>.

LocalRunGuide.md

@@ -0,0 +1,273 @@
+
+To run the application without Docker/Podman, you will need to manually install all dependencies and build the necessary components.
+
+Note that some dependencies might not be available in the standard repositories of all Linux distributions, and may require additional steps to install.
+
+The following guide assumes you have a basic understanding of using a command line interface in your operating system.
+
+It should work on most Linux distributions and MacOS. For Windows, you might need to use Windows Subsystem for Linux (WSL) for certain steps.
+The amount of dependencies is to actually reduce overall size, ie installing LibreOffice sub components rather than full LibreOffice package.
+
+You could theoretically use a Distrobox/Toolbox, if your Distribution has old or not all Packages. But you might just as well use the Docker Container then.
+
+### Step 1: Prerequisites
+
+Install the following software, if not already installed:
+
+- Java 17 or later
+
+- Gradle 7.0 or later (included within repo so not needed on server)
+
+- Git
+
+- Python 3.8 (with pip)
+
+- Make
+
+- GCC/G++
+
+- Automake
+
+- Autoconf
+
+- libtool
+
+- pkg-config
+
+- zlib1g-dev
+
+- libleptonica-dev
+
+For Debian-based systems, you can use the following command:
+
+```bash
+sudo apt-get update
+sudo apt-get install -y git  automake  autoconf  libtool  libleptonica-dev  pkg-config zlib1g-dev make g++ java-17-openjdk python3 python3-pip
+```
+
+For Fedora-based systems use this command: 
+
+```bash
+sudo dnf install -y git automake autoconf libtool leptonica-devel pkg-config zlib-devel make gcc-c++ java-17-openjdk python3 python3-pip
+```
+
+### Step 2: Clone and Build jbig2enc (Only required for certain OCR functionality)
+
+```bash
+mkdir ~/.git
+cd ~/.git &&\
+git clone https://github.com/agl/jbig2enc.git &&\
+cd jbig2enc &&\
+./autogen.sh &&\
+./configure &&\
+make &&\
+sudo make install
+```
+
+### Step 3: Install Additional Software
+Next we need to install LibreOffice for conversions, ocrmypdf for OCR, and opencv for patern recognition functionality.
+
+Install the following software:
+
+- libreoffice-core
+
+- libreoffice-common
+
+- libreoffice-writer
+
+- libreoffice-calc
+
+- libreoffice-impress
+
+- python3-uno
+
+- unoconv
+
+- pngquant
+
+- unpaper
+
+- ocrmypdf
+
+- opencv-python-headless
+
+For Debian-based systems, you can use the following command:
+
+```bash
+sudo apt-get install -y libreoffice-writer libreoffice-calc libreoffice-impress unpaper ocrmypdf
+pip3 install uno opencv-python-headless unoconv pngquant WeasyPrint 
+```
+
+For Fedora:
+
+```bash
+sudo dnf install -y libreoffice-writer libreoffice-calc libreoffice-impress unpaper ocrmypdf
+pip3 install uno opencv-python-headless unoconv pngquant WeasyPrint 
+```
+
+### Step 4: Clone and Build Stirling-PDF
+
+```bash
+cd ~/.git &&\
+git clone https://github.com/Stirling-Tools/Stirling-PDF.git &&\
+cd Stirling-PDF &&\
+chmod +x ./gradlew &&\
+./gradlew build
+```
+
+
+### Step 5: Move jar to desired location
+
+After the build process, a `.jar` file will be generated in the `build/libs` directory.
+You can move this file to a desired location, for example, `/opt/Stirling-PDF/`.
+You must also move the Script folder within the Stirling-PDF repo that you have downloaded to this directory.
+This folder is required for the python scripts using OpenCV
+
+```bash
+sudo mkdir /opt/Stirling-PDF &&\
+sudo mv ./build/libs/Stirling-PDF-*.jar /opt/Stirling-PDF/ &&\
+sudo mv scripts /opt/Stirling-PDF/ &&\
+echo "Scripts installed."
+```
+### Step 6: Other files
+#### OCR
+If you plan to use the OCR (Optical Character Recognition) functionality, you might need to install language packs for Tesseract if running non-english scanning.
+
+##### Installing Language Packs
+Easiest is to use the langpacks provided by your repositories. Skip the other steps
+
+Manual:
+
+1. Download the desired language pack(s) by selecting the `.traineddata` file(s) for the language(s) you need.
+2. Place the `.traineddata` files in the Tesseract tessdata directory: `/usr/share/tesseract-ocr/5/tessdata`
+3. 
+Please view  [OCRmyPDF install guide](https://ocrmypdf.readthedocs.io/en/latest/installation.html) for more info.
+**IMPORTANT:** DO NOT REMOVE EXISTING `eng.traineddata`, IT'S REQUIRED.
+
+Debian based systems, install languages with this command:
+
+```bash
+sudo apt update &&\
+# All languages
+# sudo apt install -y 'tesseract-ocr-*'
+
+# Find languages:
+apt search tesseract-ocr-
+
+# View installed languages:
+dpkg-query -W tesseract-ocr- | sed 's/tesseract-ocr-//g'
+```
+
+Fedora:
+
+```bash
+# All languages
+# sudo dnf install -y tesseract-langpack-*
+
+# Find languages:
+dnf search -C tesseract-langpack-
+
+# View installed languages:
+rpm -qa | grep tesseract-langpack | sed 's/tesseract-langpack-//g'
+```
+
+### Step 7: Run Stirling-PDF
+
+```bash
+./gradlew bootRun
+or
+java -jar /opt/Stirling-PDF/Stirling-PDF-*.jar
+```
+
+### Step 8: Adding a Desktop icon
+
+This will add a modified Appstarter to your Appmenu.
+```bash
+location=$(pwd)/gradlew
+image=$(pwd)/docs/stirling-transparent.svg
+
+cat > ~/.local/share/applications/Stirling-PDF.desktop <<EOF
+[Desktop Entry]
+Name=Stirling PDF;
+GenericName=Launch StirlingPDF and open its WebGUI;
+Category=Office;
+Exec=xdg-open http://localhost:8080 && nohup $location bootRun &;
+Icon=$image;
+Keywords=pdf;
+Type=Application;
+NoDisplay=false;
+Terminal=true;
+EOF
+```
+
+Note: Currently the app will run in the background until manually closed.
+
+### Optional: Run Stirling-PDF as a service
+
+First create a .env file, where you can store environment variables:
+```
+touch /opt/Stirling-PDF/.env
+```
+In this file you can add all variables, one variable per line, as stated in the main readme (for example SYSTEM_DEFAULTLOCALE="de-DE").
+
+Create a new file where we store our service settings and open it with nano editor:
+```
+nano /etc/systemd/system/stirlingpdf.service
+```
+
+Paste this content, make sure to update the filename of the jar-file. Press Ctrl+S and Ctrl+X to save and exit the nano editor:
+```
+[Unit]
+Description=Stirling-PDF service
+After=syslog.target network.target
+
+[Service]
+SuccessExitStatus=143
+
+User=root
+Group=root
+
+Type=simple
+
+EnvironmentFile=/opt/Stirling-PDF/.env
+WorkingDirectory=/opt/Stirling-PDF
+ExecStart=/usr/bin/java -jar Stirling-PDF-0.17.2.jar
+ExecStop=/bin/kill -15 $MAINPID
+
+[Install]
+WantedBy=multi-user.target
+```
+
+Notify systemd that it has to rebuild its internal service database (you have to run this command every time you make a change in the service file):
+```
+sudo systemctl daemon-reload
+```
+
+Enable the service to tell the service to start it automatically:
+```
+sudo systemctl enable stirlingpdf.service
+```
+
+See the status of the service:
+```
+sudo systemctl status stirlingpdf.service
+```
+
+Manually start/stop/restart the service:
+```
+sudo systemctl start stirlingpdf.service
+sudo systemctl stop stirlingpdf.service
+sudo systemctl restart stirlingpdf.service
+```
+
+---
+
+Remember to set the necessary environment variables before running the project if you want to customize the application the list can be seen in the main readme.
+
+You can do this in the terminal by using the `export` command or -D arguements to java -jar command:
+
+```bash
+export APP_HOME_NAME="Stirling PDF"
+or
+-DAPP_HOME_NAME="Stirling PDF" 
+```

PipelineFeature.md

@@ -0,0 +1,42 @@
+# Pipeline Configuration and Usage Tutorial
+
+## Whilst Pipelines are in alpha...
+You must enable this alpha functionality by setting
+```
+system:
+  enableAlphaFunctionality: true
+```
+To true like in the above for your `/config/settings.yml` file, after restarting Stirling-PDF you should see both UI and folder scanning enabled.
+
+
+## Steps to Configure and Use Your Pipeline
+
+1. **Access Configuration**
+   - Upon entering the screen, click on the **Configure** button.
+
+2. **Enter Pipeline Name**
+   - Provide a name for your pipeline in the designated field.
+
+3. **Select Operations**
+   - Choose the operations for your pipeline (e.g., **Split Pages**), then click **Add Operation**.
+
+4. **Configure Operation Settings**
+   - Input the necessary settings for each added operation. Settings are highlighted in yellow if customization is needed.
+
+5. **Add More Operations**
+   - You can add and adjust the order of multiple operations. Ensure each operation's settings are customized.
+
+6. **Save Settings**
+   - Click **Save Operation Settings** after customizing settings for each operation.
+
+7. **Validate Pipeline**
+   - Use the **Validation** button to check your pipeline. A green indicator signifies correct setup; a pop-out error indicates issues.
+
+8. **Download Pipeline Configuration**
+   - To use the configuration for folder scanning (or save it for future use and reupload it), you can also download a JSON file in this menu. You can also pre-load this for future use by placing it in ``/pipeline/defaultWebUIConfigs/``. It will then appear in the dropdown menu for all users to use.
+
+9. **Submit Files for Processing**
+   - If your pipeline is correctly set up close the configure menu, input the files and hit **Submit**.
+
+10. **Note on Web UI Limitations**
+    - The current web UI version does not support operations that require multiple different types of inputs, such as adding a separate image to a PDF.

README.md

@@ -1,99 +1,278 @@
-<p align="center"><img src="https://raw.githubusercontent.com/Frooodle/Stirling-PDF/main/docs/stirling.png" width="80" ><br><h1 align="center">Stirling-PDF</h1>
+<p align="center"><img src="https://raw.githubusercontent.com/Stirling-Tools/Stirling-PDF/main/docs/stirling.png" width="80" ><br><h1 align="center">Stirling-PDF</h1>
 </p>
 
 [![Docker Pulls](https://img.shields.io/docker/pulls/frooodle/s-pdf)](https://hub.docker.com/r/frooodle/s-pdf)
 [![Discord](https://img.shields.io/discord/1068636748814483718?label=Discord)](https://discord.gg/Cn8pWhQRxZ)
-[![Docker Image Version (tag latest semver)](https://img.shields.io/docker/v/frooodle/s-pdf/latest)](https://github.com/Frooodle/Stirling-PDF/)
-[![GitHub Repo stars](https://img.shields.io/github/stars/frooodle/stirling-pdf?style=social)](https://github.com/Frooodle/stirling-pdf)
+[![Docker Image Version (tag latest semver)](https://img.shields.io/docker/v/frooodle/s-pdf/latest)](https://github.com/Stirling-Tools/Stirling-PDF/)
+[![GitHub Repo stars](https://img.shields.io/github/stars/stirling-tools/stirling-pdf?style=social)](https://github.com/Stirling-Tools/stirling-pdf)
 [![Paypal Donate](https://img.shields.io/badge/Paypal%20Donate-yellow?style=flat&logo=paypal)](https://www.paypal.com/paypalme/froodleplex)
+[![Github Sponser](https://img.shields.io/badge/Github%20Sponsor-yellow?style=flat&logo=github)](https://github.com/sponsors/Frooodle)
 
-This is a locally hosted web application that allows you to perform various operations on PDF files, such as splitting and adding images.
+[![Deploy to DO](https://www.deploytodo.com/do-btn-blue.svg)](https://cloud.digitalocean.com/apps/new?repo=https://github.com/Stirling-Tools/Stirling-PDF/tree/digitalOcean&refcode=c3210994b1af)
 
-Started off as a 100% ChatGPT made application, slowly moving away from that as more features are added
+This is a powerful locally hosted web based PDF manipulation tool using docker that allows you to perform various operations on PDF files, such as splitting merging, converting, reorganizing, adding images, rotating, compressing, and more. This locally hosted web application started as a 100% ChatGPT-made application and has evolved to include a wide range of features to handle all your PDF needs.
 
-I will support and fix/add things to this if there is a demand [Discord](https://discord.gg/Cn8pWhQRxZ)
+Stirling PDF makes no outbound calls for any record keeping or tracking.
 
+All files and PDFs exist either exclusively on the client side, reside in server memory only during task execution, or temporarily reside in a file solely for the execution of the task. Any file downloaded by the user will have been deleted from the server by that point.
+
+Please feel free to submit feature requests or report bugs either through GitHub issues or on our [Discord](https://discord.gg/Cn8pWhQRxZ)
 
 ![stirling-home](images/stirling-home.png)
 
 ## Features
-
-- Split PDFs into multiple files at specified page numbers or extract all pages as individual files.
-- Merge multiple PDFs together into a single resultant file
-- Convert PDFs to and from images
-- Reorganize PDF pages into different orders.
-- Add images to PDFs at specified locations. (WIP)
-- Rotating PDFs in 90 degree increments.
-- Compressing PDFs to decrease their filesize. (Using OCRMyPDF)
-- Add and remove passwords
-- Set PDF Permissions
-- Add watermark(s)
-- Convert Any common file to PDF (using LibreOffice)
-- Extract images from PDF
-- OCR on PDF (Using OCRMyPDF)
-- Edit metadata
 - Dark mode support.
-- Custom download options (see [here](https://github.com/Frooodle/Stirling-PDF/blob/main/images/settings.png) for example)
+- Custom download options (see [here](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/images/settings.png) for example)
 - Parallel file processing and downloads
+- API for integration with external scripts 
+- Optional Login and Authentication support (see [here](https://github.com/Stirling-Tools/Stirling-PDF/tree/main#login-authentication) for documentation)
+
+
+## **PDF Features**
+
+### **Page Operations**
+- View and modify PDFs - View multi page PDFs with custom viewing sorting and searching. Plus on page edit features like annotate, draw and adding text and images. (Using PDF.js with Joxit and Liberation.Liberation fonts)
+- Full interactive GUI for merging/splitting/rotating/moving PDFs and their pages. 
+- Merge multiple PDFs together into a single resultant file. 
+- Split PDFs into multiple files at specified page numbers or extract all pages as individual files. 
+- Reorganize PDF pages into different orders. 
+- Rotate PDFs in 90-degree increments. 
+- Remove pages. 
+- Multi-page layout (Format PDFs into a multi-paged page). 
+- Scale page contents size by set %. 
+- Adjust Contrast. 
+- Crop PDF. 
+- Auto Split PDF (With physically scanned page dividers). 
+- Extract page(s). 
+- Convert PDF to a single page. 
+
+### **Conversion Operations**
+- Convert PDFs to and from images. 
+- Convert any common file to PDF (using LibreOffice). 
+- Convert PDF to Word/Powerpoint/Others (using LibreOffice). 
+- Convert HTML to PDF. 
+- URL to PDF. 
+- Markdown to PDF. 
+
+### **Security & Permissions**
+- Add and remove passwords. 
+- Change/set PDF Permissions. 
+- Add watermark(s). 
+- Certify/sign PDFs. 
+- Sanitize PDFs. 
+- Auto-redact text. 
+
+### **Other Operations**
+- Add/Generate/Write signatures. 
+- Repair PDFs. 
+- Detect and remove blank pages. 
+- Compare 2 PDFs and show differences in text. 
+- Add images to PDFs. 
+- Compress PDFs to decrease their filesize (Using OCRMyPDF). 
+- Extract images from PDF. 
+- Extract images from Scans. 
+- Add page numbers. 
+- Auto rename file by detecting PDF header text. 
+- OCR on PDF (Using OCRMyPDF). 
+- PDF/A conversion (Using OCRMyPDF). 
+- Edit metadata. 
+- Flatten PDFs. 
+- Get all information on a PDF to view or export as JSON. 
+
+
+For a overview of the tasks and the technology each uses please view [Endpoint-groups.md](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/Endpoint-groups.md)
+Hosted instance/demo of the app can be seen [here](https://pdf.adminforge.de/) hosted by the team at adminforge.de
 
 ## Technologies used
 - Spring Boot + Thymeleaf
-- PDFBox
+- [PDFBox](https://github.com/apache/pdfbox/tree/trunk)
 - [LibreOffice](https://www.libreoffice.org/discover/libreoffice/) for advanced conversions
 - [OcrMyPdf](https://github.com/ocrmypdf/OCRmyPDF)
 - HTML, CSS, JavaScript
 - Docker
+- [PDF.js](https://github.com/mozilla/pdf.js)
+- [PDF-LIB.js](https://github.com/Hopding/pdf-lib)
 
 ## How to use
 
 ### Locally
+Please view https://github.com/Stirling-Tools/Stirling-PDF/blob/main/LocalRunGuide.md
 
-Prerequisites
-- Java 17 or later
-- Gradle 7.0 or later
-
-1. Clone or download the repository.
-2. Build the project using Gradle by running `./gradlew build`
-3. Start the application by running `./gradlew bootRun` or by calling the build jar in build/libs with java -jar jarName.jar
-
-
-### Docker
+### Docker / Podman
 https://hub.docker.com/r/frooodle/s-pdf
 
+Stirling PDF has 3 different versions, a Full version, Lite, and ultra-Lite. Depending on the types of features you use you may want a smaller image to save on space.
+To see what the different versions offer please look at our [version mapping](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/Version-groups.md)
+For people that don't mind about space optimization just use the latest tag.
+![Docker Image Size (tag)](https://img.shields.io/docker/image-size/frooodle/s-pdf/latest?label=Stirling-PDF%20Full)
+![Docker Image Size (tag)](https://img.shields.io/docker/image-size/frooodle/s-pdf/latest-lite?label=Stirling-PDF%20Lite)
+![Docker Image Size (tag)](https://img.shields.io/docker/image-size/frooodle/s-pdf/latest-ultra-lite?label=Stirling-PDF%20Ultra-Lite)
+
 Docker Run
 ```
-docker run -p 8080:8080 frooodle/s-pdf
+docker run -d \
+  -p 8080:8080 \
+  -v /location/of/trainingData:/usr/share/tesseract-ocr/5/tessdata \
+  -v /location/of/extraConfigs:/configs \
+  -v /location/of/logs:/logs \
+  -e DOCKER_ENABLE_SECURITY=false \
+  --name stirling-pdf \
+  frooodle/s-pdf:latest
+  
+  
+  Can also add these for customisation but are not required
+  
+  -v /location/of/customFiles:/customFiles \
 ```
 Docker Compose
 ```
 version: '3.3'
 services:
-    s-pdf:
-        ports:
-            - '8080:8080'
-        image: frooodle/s-pdf
+  stirling-pdf:
+    image: frooodle/s-pdf:latest
+    ports:
+      - '8080:8080'
+    volumes:
+      - /location/of/trainingData:/usr/share/tesseract-ocr/5/tessdata #Required for extra OCR languages
+      - /location/of/extraConfigs:/configs
+#      - /location/of/customFiles:/customFiles/
+#      - /location/of/logs:/logs/
+    environment:
+      - DOCKER_ENABLE_SECURITY=false
 ```
 
+Note: Podman is CLI-compatible with Docker, so simply replace "docker" with "podman".
 
 ## Enable OCR/Compression feature
-Please view https://github.com/Frooodle/Stirling-PDF/blob/main/HowToUseOCR.md
+Please view https://github.com/Stirling-Tools/Stirling-PDF/blob/main/HowToUseOCR.md
 
 ## Want to add your own language?
+Stirling PDF currently supports 26!
+- English (English) (en_GB)
+- English (US) (en_US)
+- Arabic (العربية) (ar_AR)
+- German (Deutsch) (de_DE)
+- French (Français) (fr_FR)
+- Spanish (Español) (es_ES)
+- Simplified Chinese (简体中文) (zh_CN)
+- Traditional Chinese (繁體中文) (zh_TW)
+- Catalan (Català) (ca_CA)
+- Italian (Italiano) (it_IT)
+- Swedish (Svenska) (sv_SE)
+- Polish (Polski) (pl_PL)
+- Romanian (Română) (ro_RO)
+- Korean (한국어) (ko_KR)
+- Portuguese Brazilian (Português) (pt_BR)
+- Russian (Русский) (ru_RU)
+- Basque (Euskara) (eu_ES)
+- Japanese (日本語) (ja_JP)
+- Dutch (Nederlands) (nl_NL)
+- Greek (el_GR)
+- Turkish (Türkçe) (tr_TR)
+- Indonesia (Bahasa Indonesia) (id_ID)
+- Hindi (हिंदी) (hi_IN)
+- Hungarian (Magyar) (hu_HU)
+- Bulgarian (Български) (bg_BG)
+- Sebian Latin alphabet (Srpski) (sr-Latn-RS)
+
 If you want to add your own language to Stirling-PDF please refer
-https://github.com/Frooodle/Stirling-PDF/blob/main/HowToAddNewLanguage.md
+https://github.com/Stirling-Tools/Stirling-PDF/blob/main/HowToAddNewLanguage.md
 
 And please create a PR to merge it back in so others can use it! 
 
-Also please note as i add new features i will google translate existing languages so that they dont lose support. This could mean that new features need grammer corrections as added.
-
 ## How to View
 1. Open a web browser and navigate to `http://localhost:8080/`
 2. Use the application by following the instructions on the website.
 
 
-## Customize App
-Stirling PDF allows easy customization of the visible application name.
-Simply use environment variables APP_HOME_NAME, APP_HOME_DESCRIPTION and APP_NAVBAR_NAME with Docker or Java. 
-If running Java directly, you can also pass these as properties using -D arguments.
+## Customisation
+Stirling PDF allows easy customization of the app.
+Includes things like
+- Custom application name
+- Custom slogans, icons, images, and even custom HTML (via file overrides)
 
-Using the same method you can also change the default language by providing APP_LOCALE with values like de-DE fr-FR or ar-AR to select your default language (Will always default to English on invalid locale)
+
+There are two options for this, either using the generated settings file ``settings.yml``
+This file is located in the ``/configs`` directory and follows standard YAML formatting
+
+Environment variables are also supported and would override the settings file
+For example in the settings.yml you have
+```
+system:
+  defaultLocale: 'en-US'
+```
+
+To have this via an environment variable you would have ``SYSTEM_DEFAULTLOCALE``
+
+The Current list of settings is
+```
+security:
+  enableLogin: false # set to 'true' to enable login
+  csrfDisabled: true
+
+system:
+  defaultLocale: 'en-US' # Set the default language (e.g. 'de-DE', 'fr-FR', etc)
+  googlevisibility: false # 'true' to allow Google visibility (via robots.txt), 'false' to disallow
+  customStaticFilePath: '/customFiles/static/' # Directory path for custom static files
+
+#ui:
+#  appName: exampleAppName # Application's visible name
+#  homeDescription: I am a description # Short description or tagline shown on homepage.
+#  appNameNavbar: navbarName # Name displayed on the navigation bar
+
+endpoints:
+  toRemove: [] # List endpoints to disable (e.g. ['img-to-pdf', 'remove-pages'])
+  groupsToRemove: [] # List groups to disable (e.g. ['LibreOffice'])
+
+metrics:
+  enabled: true # 'true' to enable Info APIs endpoints (view http://localhost:8080/swagger-ui/index.html#/API to learn more), 'false' to disable
+```
+### Extra notes
+- Endpoints. Currently, the endpoints ENDPOINTS_TO_REMOVE and GROUPS_TO_REMOVE can include comma separate lists of endpoints and groups to disable as example ENDPOINTS_TO_REMOVE=img-to-pdf,remove-pages would disable both image-to-pdf and remove pages, GROUPS_TO_REMOVE=LibreOffice Would disable all things that use LibreOffice. You can see a list of all endpoints and groups [here](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/Endpoint-groups.md)
+- customStaticFilePath. Customise static files such as the app logo by placing files in the /customFiles/static/ directory. An example of customising app logo is placing a /customFiles/static/favicon.svg to override current SVG. This can be used to change any images/icons/css/fonts/js etc in Stirling-PDF
+
+### Environment only parameters
+- ``SYSTEM_ROOTURIPATH`` ie set to ``/pdf-app`` to Set the application's root URI to ``localhost:8080/pdf-app``
+- ``SYSTEM_CONNECTIONTIMEOUTMINUTES`` to set custom connection timeout values
+- ``DOCKER_ENABLE_SECURITY`` to tell docker to download security jar (required as true for auth login)
+
+## API
+For those wanting to use Stirling-PDFs backend API to link with their own custom scripting to edit PDFs you can view all existing API documentation
+[here](https://app.swaggerhub.com/apis-docs/Stirling-Tools/Stirling-PDF/) or navigate to /swagger-ui/index.html of your stirling-pdf instance for your versions documentation (Or by following the API button in your settings of Stirling-PDF)
+
+
+## Login authentication
+![stirling-login](images/login-light.png)
+### Prerequisites: 
+- User must have the folder ./configs volumed within docker so that it is retained during updates.
+- Docker uses must download the security jar version by setting ``DOCKER_ENABLE_SECURITY`` to ``true`` in environment variables. 
+- Then either enable login via the settings.yml file or via setting ``SECURITY_ENABLE_LOGIN`` to ``true``
+- Now the initial user will be generated with username ``admin`` and password ``stirling``. On login you will be forced to change the password to a new one. You can also use the environment variables ``SECURITY_INITIALLOGIN_USERNAME`` and  ``SECURITY_INITIALLOGIN_PASSWORD`` to set your own straight away (Recommended to remove them after user creation).
+
+Once the above has been done, on restart, a new stirling-pdf-DB.mv.db will show if everything worked.
+
+When you login to Stirling PDF you will be redirected to /login page to login with those default credentials. After login everything should function as normal
+
+To access your account settings go to Account settings in the settings cog menu (top right in navbar) This Account settings menu is also where you find your API key.
+
+To add new users go to the bottom of Account settings and hit 'Admin Settings', here you can add new users. The different roles mentioned within this are for rate limiting. This is a Work in progress which will be expanding on more in future
+
+For API usage you must provide a header with 'X-API-Key' and the associated API key for that user.
+
+
+## FAQ
+
+### Q1: What are your planned features?
+- Progress bar/Tracking
+- Full custom logic pipelines to combine multiple operations together.
+- Folder support with auto scanning to perform operations on
+- Redact text (Via UI not just automated way) 
+- Add Forms
+- Multi page layout (Stich PDF pages together) support x rows y columns and custom page sizing 
+- Fill forms mannual and automatic 
+
+### Q2: Why is my application downloading .htm files?
+This is an issue caused commonly by your NGINX configuration. The default file upload size for NGINX is 1MB, you need to add the following in your Nginx sites-available file. ``client_max_body_size SIZE;`` Where "SIZE" is 50M for example for 50MB files.
+
+### Q3: Why is my download timing out
+NGINX has timeout values by default so if you are running Stirling-PDF behind NGINX you may need to set a timeout value such as adding the config ``proxy_read_timeout 3600;``

Version-groups.md

@@ -0,0 +1,64 @@
+|Technology      | Ultra-Lite | Lite | Full |
+|----------------|:----------:|:----:|:----:|
+| Java           |     ✔️      |  ✔️  |  ✔️  |
+| JavaScript     |     ✔️      |  ✔️  |  ✔️  |
+| Libre          |             |  ✔️  |  ✔️  |
+| Python         |             |      |  ✔️  |
+| OpenCV         |             |      |  ✔️  |
+| OCRmyPDF       |             |      |  ✔️  |
+
+
+
+
+
+Operation           | Ultra-Lite | Lite | Full
+--------------------|------------|------|-----
+add-page-numbers    |     ✔️      |  ✔️   |  ✔️
+add-password        |     ✔️      |  ✔️   |  ✔️
+add-image           |     ✔️      |  ✔️   |  ✔️
+add-watermark       |     ✔️      |  ✔️   |  ✔️
+adjust-contrast     |     ✔️      |  ✔️   |  ✔️
+auto-split-pdf      |     ✔️      |  ✔️   |  ✔️
+auto-redact         |     ✔️      |  ✔️   |  ✔️
+auto-rename         |     ✔️      |  ✔️   |  ✔️
+cert-sign           |     ✔️      |  ✔️   |  ✔️
+crop                |     ✔️      |  ✔️   |  ✔️
+change-metadata     |     ✔️      |  ✔️   |  ✔️
+change-permissions  |     ✔️      |  ✔️   |  ✔️
+compare             |     ✔️      |  ✔️   |  ✔️
+extract-page        |     ✔️      |  ✔️   |  ✔️
+extract-images      |     ✔️      |  ✔️   |  ✔️
+flatten             |     ✔️      |  ✔️   |  ✔️
+get-info-on-pdf     |     ✔️      |  ✔️   |  ✔️
+img-to-pdf          |     ✔️      |  ✔️   |  ✔️
+markdown-to-pdf     |     ✔️      |  ✔️   |  ✔️
+merge-pdfs          |     ✔️      |  ✔️   |  ✔️
+multi-page-layout   |     ✔️      |  ✔️   |  ✔️
+overlay-pdf         |     ✔️      |  ✔️   |  ✔️
+pdf-organizer       |     ✔️      |  ✔️   |  ✔️
+pdf-to-csv          |     ✔️      |  ✔️   |  ✔️
+pdf-to-img          |     ✔️      |  ✔️   |  ✔️
+pdf-to-single-page  |     ✔️      |  ✔️   |  ✔️
+remove-pages        |     ✔️      |  ✔️   |  ✔️
+remove-password     |     ✔️      |  ✔️   |  ✔️
+rotate-pdf          |     ✔️      |  ✔️   |  ✔️
+sanitize-pdf        |     ✔️      |  ✔️   |  ✔️
+scale-pages         |     ✔️      |  ✔️   |  ✔️
+sign                |     ✔️      |  ✔️   |  ✔️
+show-javascript     |     ✔️      |  ✔️   |  ✔️
+split-by-size-or-count |     ✔️      |  ✔️   |  ✔️
+split-pdf-by-sections  |     ✔️      |  ✔️   |  ✔️
+split-pdfs          |     ✔️      |  ✔️   |  ✔️
+file-to-pdf         |             |  ✔️   |  ✔️
+pdf-to-html         |             |  ✔️   |  ✔️
+pdf-to-presentation |             |  ✔️   |  ✔️
+pdf-to-text         |             |  ✔️   |  ✔️
+pdf-to-word         |             |  ✔️   |  ✔️
+pdf-to-xml          |             |  ✔️   |  ✔️
+repair              |             |  ✔️   |  ✔️
+xlsx-to-pdf         |             |  ✔️   |  ✔️
+compress-pdf        |             |       |  ✔️
+extract-image-scans |             |       |  ✔️
+ocr-pdf             |             |       |  ✔️
+pdf-to-pdfa         |             |       |  ✔️
+remove-blanks       |             |       |  ✔️

build.gradle

@@ -1,47 +1,199 @@
 plugins {
-	id 'java'
-	id 'org.springframework.boot' version '3.0.5'
-	id 'io.spring.dependency-management' version '1.1.0'
+    id 'java'
+    id 'org.springframework.boot' version '3.2.1'
+    id 'io.spring.dependency-management' version '1.1.3'
+    id 'org.springdoc.openapi-gradle-plugin' version '1.8.0'
+    id "io.swagger.swaggerhub" version "1.3.2"
+    id 'edu.sc.seis.launch4j' version '3.0.5'
+    id 'com.diffplug.spotless' version '6.23.3'
+    id 'com.github.jk1.dependency-license-report' version '2.5'
 }
 
+import com.github.jk1.license.render.*
+
 group = 'stirling.software'
-version = '0.4.7'
+version = '0.19.1'
 sourceCompatibility = '17'
 
 repositories {
-	mavenCentral()
+    mavenCentral()
+}
+
+
+
+licenseReport {
+    renderers = [new JsonReportRenderer()]
+}
+
+sourceSets {
+    main {
+        java {
+            if (System.getenv('DOCKER_ENABLE_SECURITY') == 'false') {
+                exclude 'stirling/software/SPDF/config/security/**'
+                exclude 'stirling/software/SPDF/controller/api/UserController.java'
+                exclude 'stirling/software/SPDF/controller/web/AccountWebController.java'
+                exclude 'stirling/software/SPDF/model/ApiKeyAuthenticationToken.java'
+                exclude 'stirling/software/SPDF/model/Authority.java'
+                exclude 'stirling/software/SPDF/model/PersistentLogin.java'
+                exclude 'stirling/software/SPDF/model/User.java'
+                exclude 'stirling/software/SPDF/repository/**'
+            }
+        }
+    }
+}
+
+openApi {
+    apiDocsUrl = "http://localhost:8080/v1/api-docs"
+    outputDir = file("$projectDir")
+    outputFileName = "SwaggerDoc.json"
+}
+
+
+launch4j {
+  icon = "${projectDir}/src/main/resources/static/favicon.ico"
+
+  outfile="Stirling-PDF.exe"
+  headerType="console"
+  jarTask = tasks.bootJar
+
+  errTitle="Encountered error, Do you have Java 17?"
+  downloadUrl="https://download.oracle.com/java/17/latest/jdk-17_windows-x64_bin.exe"
+  variables=["BROWSER_OPEN=true", "ENDPOINTS_GROUPS_TO_REMOVE=CLI"]
+  jreMinVersion="17"
+
+  mutexName="Stirling-PDF"
+  windowTitle="Stirling-PDF"
+
+  messagesStartupError="An error occurred while starting Stirling-PDF"
+  //messagesJreNotFoundError="This application requires a Java Runtime Environment, Please download Java 17."
+  messagesJreVersionError="You are running the wrong version of Java, Please download Java 17."
+  messagesLauncherError="Java is corrupted. Please uninstall and then install  Java 17."
+  messagesInstanceAlreadyExists="Stirling-PDF is already running."
+}
+
+spotless {
+    java {
+        target project.fileTree('src/main/java')
+
+        googleJavaFormat('1.19.1').aosp().reorderImports(false)
+
+        importOrder('java', 'javax', 'org', 'com', 'net', 'io')
+        toggleOffOn()
+        trimTrailingWhitespace()
+        indentWithSpaces()
+        endWithNewline()
+    }
 }
 
 dependencies {
-	implementation 'org.springframework.boot:spring-boot-starter-web'
-	implementation 'org.springframework.boot:spring-boot-starter-thymeleaf'
-	testImplementation 'org.springframework.boot:spring-boot-starter-test'
-	
-	implementation 'org.apache.logging.log4j:log4j-core:2.20.0'
-	
-	// https://mvnrepository.com/artifact/org.apache.pdfbox/jbig2-imageio
-	implementation group: 'org.apache.pdfbox', name: 'jbig2-imageio', version: '3.0.4'
-	
-		
-	//general PDF
-    implementation 'org.apache.pdfbox:pdfbox:2.0.27'
-        
-    implementation 'com.itextpdf:itextpdf:5.5.13.3'
-    developmentOnly("org.springframework.boot:spring-boot-devtools")
+    //security updates
+    implementation 'ch.qos.logback:logback-classic:1.4.14'
+    implementation 'ch.qos.logback:logback-core:1.4.14'
+    implementation 'org.springframework:spring-webmvc:6.1.2'
 
+    implementation 'org.yaml:snakeyaml:2.2'
+    implementation 'org.springframework.boot:spring-boot-starter-web:3.2.1'
+    implementation 'org.springframework.boot:spring-boot-starter-thymeleaf:3.2.1'
+
+    if (System.getenv('DOCKER_ENABLE_SECURITY') != 'false') {
+        implementation 'org.springframework.boot:spring-boot-starter-security:3.2.1'
+        implementation 'org.thymeleaf.extras:thymeleaf-extras-springsecurity5:3.1.2.RELEASE'
+        implementation "org.springframework.boot:spring-boot-starter-data-jpa:3.2.1"
+        
+        //2.2.x requires rebuild of DB file.. need migration path
+        implementation "com.h2database:h2:2.1.214"
+    }
+
+    testImplementation 'org.springframework.boot:spring-boot-starter-test:3.2.1'
+
+    // Batik
+    implementation 'org.apache.xmlgraphics:batik-all:1.17'
+
+    // TwelveMonkeys
+    implementation 'com.twelvemonkeys.imageio:imageio-batik:3.10.1'
+    implementation 'com.twelvemonkeys.imageio:imageio-bmp:3.10.1'
+    // implementation 'com.twelvemonkeys.imageio:imageio-hdr:3.10.1'
+    // implementation 'com.twelvemonkeys.imageio:imageio-icns:3.10.1'
+    // implementation 'com.twelvemonkeys.imageio:imageio-iff:3.10.1'
+    implementation 'com.twelvemonkeys.imageio:imageio-jpeg:3.10.1'
+    // implementation 'com.twelvemonkeys.imageio:imageio-pcx:3.10.1'
+    // implementation 'com.twelvemonkeys.imageio:imageio-pict:3.10.1'
+    // implementation 'com.twelvemonkeys.imageio:imageio-pnm:3.10.1'
+    // implementation 'com.twelvemonkeys.imageio:imageio-psd:3.10.1'
+    // implementation 'com.twelvemonkeys.imageio:imageio-sgi:3.10.1'
+    // implementation 'com.twelvemonkeys.imageio:imageio-tga:3.10.1'
+    // implementation 'com.twelvemonkeys.imageio:imageio-thumbsdb:3.10.1'
+    implementation 'com.twelvemonkeys.imageio:imageio-tiff:3.10.1'
+    implementation 'com.twelvemonkeys.imageio:imageio-webp:3.10.1'
+    // implementation 'com.twelvemonkeys.imageio:imageio-xwd:3.10.1'
+
+    implementation 'commons-io:commons-io:2.15.1'
+    implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.2.0'
+
+    //general PDF
+
+    // https://mvnrepository.com/artifact/com.opencsv/opencsv
+    implementation ('com.opencsv:opencsv:5.9') {
+        exclude group: 'commons-logging', module: 'commons-logging'
+    }
+    
+    implementation ('org.apache.pdfbox:pdfbox:2.0.30'){
+        exclude group: 'commons-logging', module: 'commons-logging'
+    }
+    
+    implementation ('org.apache.pdfbox:xmpbox:2.0.30'){
+        exclude group: 'commons-logging', module: 'commons-logging'
+    }
+    
+    implementation 'org.bouncycastle:bcprov-jdk18on:1.77'
+    implementation 'org.bouncycastle:bcpkix-jdk18on:1.77'
+    implementation 'org.springframework.boot:spring-boot-starter-actuator'
+    implementation 'io.micrometer:micrometer-core'
+    implementation group: 'com.google.zxing', name: 'core', version: '3.5.2'
+    // https://mvnrepository.com/artifact/org.commonmark/commonmark
+    implementation 'org.commonmark:commonmark:0.21.0'
+    // https://mvnrepository.com/artifact/com.github.vladimir-bukhtoyarov/bucket4j-core
+    implementation 'com.github.vladimir-bukhtoyarov:bucket4j-core:7.6.0'
+
+    developmentOnly("org.springframework.boot:spring-boot-devtools")
+    compileOnly 'org.projectlombok:lombok:1.18.30'
+    annotationProcessor 'org.projectlombok:lombok:1.18.28'
 }
 
+tasks.withType(JavaCompile) {
+    dependsOn 'spotlessApply'
+}
+
+task writeVersion {
+    def propsFile = file('src/main/resources/version.properties')
+    def props = new Properties()
+    props.setProperty('version', version)
+    props.store(propsFile.newWriter(), null)
+}
+
+swaggerhubUpload {
+    //dependsOn generateOpenApiDocs  // Depends on your task generating Swagger docs
+    api 'Stirling-PDF'  // The name of your API on SwaggerHub
+    owner 'Frooodle'  // Your SwaggerHub username (or organization name)
+    version project.version  // The version of your API
+    inputFile './SwaggerDoc.json'  // The path to your Swagger docs
+    token  "${System.getenv('SWAGGERHUB_API_KEY')}"  // Your SwaggerHub API key, passed as an environment variable
+    oas '3.0.0'  // The version of the OpenAPI Specification you're using
+}
+
+
+
 jar {
     enabled = false
     manifest {
         attributes 'Implementation-Title': 'Stirling-PDF',
                    'Implementation-Version': project.version
     }
-    
+
 }
 
 tasks.named('test') {
-	useJUnitPlatform()
+    useJUnitPlatform()
 }
 
 task printVersion {

chart/stirling-pdf/Chart.yaml

@@ -0,0 +1,15 @@
+apiVersion: v2
+appVersion: 0.14.2
+description: locally hosted web application that allows you to perform various operations on PDF files
+home: https://github.com/Stirling-Tools/Stirling-PDF
+keywords:
+- stirling-pdf
+- helm
+- charts repo
+maintainers:
+- name: Stirling-Tools
+  url: https://github.com/Stirling-Tools/Stirling-PDF
+name: stirling-pdf-chart
+sources:
+- https://github.com/Stirling-Tools/Stirling-PDF
+version: 1.0.0

chart/stirling-pdf/templates/NOTES.txt

@@ -0,0 +1,30 @@
+** Please be patient while the chart is being deployed **
+
+Get the stirlingpdf URL by running:
+
+{{- if contains "NodePort" .Values.service.type }}
+
+  export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ template "stirlingpdf.fullname" . }})
+  export NODE_IP=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}")
+  echo http://$NODE_IP:$NODE_PORT/
+
+{{- else if contains "LoadBalancer" .Values.service.type }}
+
+** Please ensure an external IP is associated to the {{ template "stirlingpdf.fullname" . }} service before proceeding **
+** Watch the status using: kubectl get svc --namespace {{ .Release.Namespace }} -w {{ template "stirlingpdf.fullname" . }} **
+
+  export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ template "stirlingpdf.fullname" . }} -o jsonpath='{.status.loadBalancer.ingress[0].ip}')
+  echo http://$SERVICE_IP:{{ .Values.service.externalPort }}/
+
+OR
+
+  export SERVICE_HOST=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ template "stirlingpdf.fullname" . }} -o jsonpath='{.status.loadBalancer.ingress[0].hostname}')
+  echo http://$SERVICE_HOST:{{ .Values.service.externalPort }}/
+
+{{- else if contains "ClusterIP"  .Values.service.type }}
+
+  export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app={{ template "stirlingpdf.name" . }}" -l "release={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}")
+  echo http://127.0.0.1:8080/
+  kubectl port-forward $POD_NAME 8080:8080 --namespace {{ .Release.Namespace }}
+
+{{- end }}

chart/stirling-pdf/templates/_helpers.tpl

@@ -0,0 +1,129 @@
+{{/*
+Expand the name of the chart.
+*/}}
+{{- define "stirlingpdf.name" -}}
+{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" }}
+{{- end }}
+
+{{/*
+Create a default fully qualified app name.
+We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec).
+If release name contains chart name it will be used as a full name.
+*/}}
+{{- define "stirlingpdf.fullname" -}}
+{{- if .Values.fullnameOverride }}
+{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" }}
+{{- else }}
+{{- $name := default .Chart.Name .Values.nameOverride }}
+{{- if contains $name .Release.Name }}
+{{- .Release.Name | trunc 63 | trimSuffix "-" }}
+{{- else }}
+{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" }}
+{{- end }}
+{{- end }}
+{{- end }}
+
+{{- /*
+Create chart name and version as used by the chart label.
+
+It does minimal escaping for use in Kubernetes labels.
+
+Example output:
+
+stirlingpdf-0.4.5
+*/ -}}
+{{- define "stirlingpdf.chart" -}}
+{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }}
+{{- end -}}
+
+{{/*
+Common labels
+*/}}
+{{- define "stirlingpdf.labels" -}}
+helm.sh/chart: {{ include "stirlingpdf.chart" . }}
+{{ include "stirlingpdf.selectorLabels" . }}
+{{- if .Chart.AppVersion }}
+app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
+{{- end }}
+{{- if .Values.commonLabels}}
+{{ toYaml .Values.commonLabels }}
+{{- end }}
+app.kubernetes.io/managed-by: {{ .Release.Service }}
+{{- end }}
+
+{{/*
+Selector labels
+*/}}
+{{- define "stirlingpdf.selectorLabels" -}}
+app.kubernetes.io/name: {{ include "stirlingpdf.name" . }}
+app.kubernetes.io/instance: {{ .Release.Name }}
+{{- end }}
+
+{{/*
+Create the name of the service account to use
+*/}}
+{{- define "stirlingpdf.serviceAccountName" -}}
+{{- if .Values.serviceAccount.create }}
+{{- default (include "stirlingpdf.fullname" .) .Values.serviceAccount.name }}
+{{- else }}
+{{- default "default" .Values.serviceAccount.name }}
+{{- end }}
+{{- end }}
+
+{{/*
+Return the proper image name to change the volume permissions
+*/}}
+{{- define "stirlingpdf.volumePermissions.image" -}}
+{{- $registryName := .Values.volumePermissions.image.registry -}}
+{{- $repositoryName := .Values.volumePermissions.image.repository -}}
+{{- $tag := .Values.volumePermissions.image.tag | toString -}}
+{{/*
+Helm 2.11 supports the assignment of a value to a variable defined in a different scope,
+but Helm 2.9 and 2.10 doesn't support it, so we need to implement this if-else logic.
+Also, we can't use a single if because lazy evaluation is not an option
+*/}}
+{{- if .Values.global }}
+    {{- if .Values.global.imageRegistry }}
+        {{- printf "%s/%s:%s" .Values.global.imageRegistry $repositoryName $tag -}}
+    {{- else -}}
+        {{- printf "%s/%s:%s" $registryName $repositoryName $tag -}}
+    {{- end -}}
+{{- else -}}
+    {{- printf "%s/%s:%s" $registryName $repositoryName $tag -}}
+{{- end -}}
+{{- end -}}
+
+{{/*
+Return the proper Docker Image Registry Secret Names
+*/}}
+{{- define "stirlingpdf.imagePullSecrets" -}}
+{{/*
+Helm 2.11 supports the assignment of a value to a variable defined in a different scope,
+but Helm 2.9 and 2.10 does not support it, so we need to implement this if-else logic.
+Also, we can not use a single if because lazy evaluation is not an option
+*/}}
+{{- if .Values.global }}
+{{- if .Values.global.imagePullSecrets }}
+imagePullSecrets:
+{{- range .Values.global.imagePullSecrets }}
+  - name: {{ . }}
+{{- end }}
+{{- else if or .Values.image.pullSecrets .Values.volumePermissions.image.pullSecrets }}
+imagePullSecrets:
+{{- range .Values.image.pullSecrets }}
+  - name: {{ . }}
+{{- end }}
+{{- range .Values.volumePermissions.image.pullSecrets }}
+  - name: {{ . }}
+{{- end }}
+{{- end -}}
+{{- else if or .Values.image.pullSecrets .Values.volumePermissions.image.pullSecrets }}
+imagePullSecrets:
+{{- range .Values.image.pullSecrets }}
+  - name: {{ . }}
+{{- end }}
+{{- range .Values.volumePermissions.image.pullSecrets }}
+  - name: {{ . }}
+{{- end }}
+{{- end -}}
+{{- end -}}

chart/stirling-pdf/templates/deployment.yaml

@@ -0,0 +1,129 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: {{ include "stirlingpdf.fullname" . }}
+  {{- with .Values.deployment.annotations }}
+  annotations:
+    {{- toYaml . | nindent 4 }}
+  {{- end }}
+  labels:
+    {{- include "stirlingpdf.labels" . | nindent 4 }}
+    {{- if .Values.deployment.labels }}
+    {{- toYaml .Values.deployment.labels | nindent 4 }}
+    {{- end }}
+spec:
+  selector:
+    matchLabels:
+      {{- include "stirlingpdf.selectorLabels" . | nindent 6 }}
+  replicas: {{ .Values.replicaCount }}
+  strategy:
+{{ toYaml .Values.strategy | indent 4 }}
+  revisionHistoryLimit: 10
+  template:
+    metadata:
+      {{- with .Values.podAnnotations }}
+      annotations:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      labels:
+        {{- include "stirlingpdf.selectorLabels" . | nindent 8 }}
+        {{- if .Values.podLabels }}
+        {{- toYaml .Values.podLabels | nindent 8 }}
+        {{- end }}
+    spec:
+      {{- if .Values.priorityClassName }}
+      priorityClassName: "{{ .Values.priorityClassName }}"
+      {{- end }}
+      {{- if .Values.securityContext.enabled }}
+      securityContext:
+        fsGroup: {{ .Values.securityContext.fsGroup }}
+        {{- if .Values.securityContext.runAsNonRoot }}
+        runAsNonRoot: {{ .Values.securityContext.runAsNonRoot }}
+        {{- end }}
+        {{- if .Values.securityContext.supplementalGroups }}
+        supplementalGroups: {{ .Values.securityContext.supplementalGroups }}
+        {{- end }}
+      {{- else if .Values.persistence.enabled }}
+      initContainers:
+      - name: volume-permissions
+        image: {{ template "stirlingpdf.volumePermissions.image" . }}
+        imagePullPolicy: "{{ .Values.volumePermissions.image.pullPolicy }}"
+        securityContext:
+          {{- toYaml .Values.containerSecurityContext | nindent 10 }}
+        command: ['sh', '-c', 'chown -R {{ .Values.securityContext.fsGroup }}:{{ .Values.securityContext.fsGroup }} {{ .Values.persistence.path }}']
+        volumeMounts:
+        - mountPath: {{ .Values.persistence.path }}
+          name: storage-volume
+      {{- end }}
+{{- include "stirlingpdf.imagePullSecrets" . | indent 6 }}
+      containers:
+      - name: {{ .Chart.Name }}
+        image: {{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}
+        imagePullPolicy: {{ .Values.image.pullPolicy }}
+        securityContext:
+          {{- toYaml .Values.containerSecurityContext | nindent 10 }}
+{{- if .Values.envs }}
+        env:
+{{ toYaml .Values.envs | indent 8 }}
+{{- end }}
+{{- if .Values.extraArgs }}
+        args:
+{{ toYaml .Values.extraArgs | indent 8 }}
+{{- end }}
+        ports:
+        - name: http
+          containerPort: 8080
+        livenessProbe:
+          httpGet:
+            path: /
+            port: http
+{{ toYaml .Values.probes.livenessHttpGetConfig | indent 12 }}
+{{ toYaml .Values.probes.liveness | indent 10 }}
+        readinessProbe:
+          httpGet:
+            path: /
+            port: http
+{{ toYaml .Values.probes.readinessHttpGetConfig | indent 12 }}
+{{ toYaml .Values.probes.readiness | indent 10 }}
+        volumeMounts:
+{{- if .Values.deployment.extraVolumeMounts }}
+        {{- toYaml .Values.deployment.extraVolumeMounts | nindent 8 }}
+{{- end }}
+{{- if .Values.deployment.sidecarContainers }}
+{{- range $name, $spec :=  .Values.deployment.sidecarContainers }}
+      - name: {{ $name }}
+{{- toYaml $spec | nindent 8 }}
+{{- end }}
+{{- end }}
+      {{- with .Values.resources }}
+        resources:
+{{ toYaml . | indent 10 }}
+      {{- end }}
+    {{- with .Values.nodeSelector }}
+      nodeSelector:
+{{ toYaml . | indent 8 }}
+    {{- end }}
+    {{- with .Values.affinity }}
+      affinity:
+{{ toYaml . | indent 8 }}
+    {{- end }}
+    {{- with .Values.tolerations }}
+      tolerations:
+{{ toYaml . | indent 8 }}
+    {{- end }}
+    {{- if .Values.schedulerName }}
+      schedulerName: {{ .Values.schedulerName }}
+    {{- end }}
+      serviceAccountName: {{ include "stirlingpdf.serviceAccountName" . }}
+      automountServiceAccountToken: {{ .Values.serviceAccount.automountServiceAccountToken }}
+      volumes:
+      {{- if .Values.deployment.extraVolumes }}
+      {{- toYaml .Values.deployment.extraVolumes | nindent 6 }}
+      {{- end }}
+      - name: storage-volume
+      {{- if .Values.persistence.enabled }}
+        persistentVolumeClaim:
+          claimName: {{ .Values.persistence.existingClaim | default (include "stirlingpdf.fullname" .) }}
+      {{- else }}
+        emptyDir: {}
+      {{- end }}

chart/stirling-pdf/templates/ingress.yaml

@@ -0,0 +1,85 @@
+{{- if .Values.ingress.enabled }}
+{{- $servicePort := .Values.service.externalPort -}}
+{{- $serviceName := include "stirlingpdf.fullname" . -}}
+{{- $ingressExtraPaths := .Values.ingress.extraPaths -}}
+---
+{{- if semverCompare "<1.14-0" .Capabilities.KubeVersion.GitVersion }}
+apiVersion: extensions/v1beta1
+{{- else if semverCompare "<1.19-0" .Capabilities.KubeVersion.GitVersion }}
+apiVersion: networking.k8s.io/v1beta1
+{{- else }}
+apiVersion: networking.k8s.io/v1
+{{- end }}
+kind: Ingress
+metadata:
+  name: {{ include "stirlingpdf.fullname" . }}
+  {{- with .Values.ingress.annotations }}
+  annotations:
+    {{- toYaml . | nindent 4 }}
+  {{- end }}
+  labels:
+    {{- include "stirlingpdf.labels" . | nindent 4 }}
+    {{- with .Values.ingress.labels }}
+    {{- toYaml . | nindent 4 }}
+    {{- end }}
+spec:
+  {{- with .Values.ingress.ingressClassName }}
+  ingressClassName: {{ . }}
+  {{- end }}
+  rules:
+  {{- range .Values.ingress.hosts }}
+  - host: {{ .name }}
+    http:
+      paths:
+      {{- range $ingressExtraPaths }}
+      - path: {{ default "/" .path | quote }}
+        backend:
+        {{- if semverCompare "<1.19-0" $.Capabilities.KubeVersion.GitVersion }}
+          {{- if $.Values.service.servicename }}
+          serviceName: {{ $.Values.service.servicename }}
+          {{- else }}
+          serviceName: {{ default $serviceName .service }}
+          {{- end }}
+          servicePort: {{ default $servicePort .port }}
+        {{- else }}
+          service:
+            {{- if $.Values.service.servicename }}
+            name: {{ $.Values.service.servicename }}
+            {{- else }}
+            name: {{ default $serviceName .service }}
+            {{- end }}
+            port:
+              number: {{ default $servicePort .port }}
+        pathType: {{ default $.Values.ingress.pathType .pathType }}
+        {{- end }}
+      {{- end }}
+      - path: {{ default "/" .path | quote }}
+        backend:
+        {{- if semverCompare "<1.19-0" $.Capabilities.KubeVersion.GitVersion }}
+          {{- if $.Values.service.servicename }}
+          serviceName: {{ $.Values.service.servicename }}
+          {{- else }}
+          serviceName: {{ default $serviceName .service }}
+          {{- end }}
+          servicePort: {{ default $servicePort .servicePort }}
+        {{- else }}
+          service:
+            {{- if $.Values.service.servicename }}
+            name: {{ $.Values.service.servicename }}
+            {{- else }}
+            name: {{ default $serviceName .service }}
+            {{- end }}
+            port:
+              number: {{ default $servicePort .port }}
+        pathType: {{ $.Values.ingress.pathType }}
+        {{- end }}
+  {{- end }}
+  tls:
+  {{- range .Values.ingress.hosts }}
+  {{- if .tls }}
+  - hosts:
+    - {{ .name }}
+    secretName: {{ .tlsSecret }}
+  {{- end }}
+  {{- end }}
+{{- end -}}

chart/stirling-pdf/templates/pv.yaml

@@ -0,0 +1,16 @@
+{{- if .Values.persistence.pv.enabled -}}
+apiVersion: v1
+kind: PersistentVolume
+metadata:
+  name: {{ .Values.persistence.pv.pvname | default (include "stirlingpdf.fullname" .) }}
+  labels:
+    {{- include "stirlingpdf.labels" . | nindent 4 }}
+spec:
+  capacity:
+    storage: {{ .Values.persistence.pv.capacity.storage }}
+  accessModes:
+    - {{ .Values.persistence.pv.accessMode | quote }}
+  nfs:
+    server: {{ .Values.persistence.pv.nfs.server }}
+    path: {{ .Values.persistence.pv.nfs.path | quote }}
+{{- end }}

chart/stirling-pdf/templates/pvc.yaml

@@ -0,0 +1,27 @@
+{{- if and .Values.persistence.enabled (not .Values.persistence.existingClaim) -}}
+kind: PersistentVolumeClaim
+apiVersion: v1
+metadata:
+  name: {{ include "stirlingpdf.fullname" . }}
+  labels:
+    {{- include "stirlingpdf.labels" . | nindent 4 }}
+    {{- with .Values.persistence.labels }}
+    {{- toYaml . | nindent 4 }}
+    {{- end }}
+spec:
+  accessModes:
+    - {{ .Values.persistence.accessMode | quote }}
+  resources:
+    requests:
+      storage: {{ .Values.persistence.size | quote }}
+{{- if .Values.persistence.storageClass }}
+{{- if (eq "-" .Values.persistence.storageClass) }}
+  storageClassName: ""
+{{- else }}
+  storageClassName: "{{ .Values.persistence.storageClass }}"
+{{- end }}
+{{- if .Values.persistence.volumeName }}
+  volumeName: "{{ .Values.persistence.volumeName }}"
+{{- end }}
+{{- end }}
+{{- end }}

chart/stirling-pdf/templates/service.yaml

@@ -0,0 +1,48 @@
+apiVersion: v1
+kind: Service
+metadata:
+  name: {{ .Values.service.servicename | default (include "stirlingpdf.fullname" .) }}
+  {{- with .Values.service.annotations }}
+  annotations:
+  {{- toYaml . | nindent 4 }}
+  {{- end }}
+  labels:
+    {{- include "stirlingpdf.labels" . | nindent 4 }}
+    {{- with .Values.service.labels }}
+    {{- toYaml . | nindent 4 }}
+    {{- end }}
+spec:
+  type: {{ .Values.service.type }}
+  {{- if (or (eq .Values.service.type "LoadBalancer") (and (eq .Values.service.type "NodePort") (not (empty .Values.service.nodePort)))) }}
+  externalTrafficPolicy: {{ .Values.service.externalTrafficPolicy }}
+  {{- end }}
+  {{- if (and (eq .Values.service.type "LoadBalancer") .Values.service.loadBalancerIP) }}
+  loadBalancerIP: {{ .Values.service.loadBalancerIP }}
+  {{- end }}
+  {{- if (and (eq .Values.service.type "LoadBalancer") .Values.service.loadBalancerSourceRanges) }}
+  loadBalancerSourceRanges:
+  {{- with .Values.service.loadBalancerSourceRanges }}
+{{ toYaml . | indent 2 }}
+  {{- end }}
+  {{- end }}
+  {{- if eq .Values.service.type "ClusterIP" }}
+  {{- if .Values.service.clusterIP }}
+  clusterIP: {{ .Values.service.clusterIP }}
+  {{- end }}
+  {{- end }}
+  ports:
+  - port: {{ .Values.service.externalPort }}
+{{- if (and (eq .Values.service.type "NodePort") (not (empty .Values.service.nodePort))) }}
+    nodePort: {{.Values.service.nodePort}}
+{{- end }}
+{{- if .Values.service.targetPort }}
+    targetPort: {{ .Values.service.targetPort }}
+    name: {{ .Values.service.targetPort }}
+{{- else }}
+    targetPort: http
+    name: http
+{{- end }}
+    protocol: TCP
+    
+  selector:
+    {{- include "stirlingpdf.selectorLabels" . | nindent 4 }}

chart/stirling-pdf/templates/serviceaccount.yaml

@@ -0,0 +1,13 @@
+{{- if .Values.serviceAccount.create -}}
+---
+apiVersion: v1
+kind: ServiceAccount
+metadata:
+  name: {{ include "stirlingpdf.serviceAccountName" . }}
+  {{- with .Values.serviceAccount.annotations }}
+  annotations:
+    {{ toYaml . | nindent 4 }}
+  {{- end }}
+  labels:
+    {{- include "stirlingpdf.labels" . | nindent 4 }}
+{{- end }}

chart/stirling-pdf/templates/servicemonitor.yaml

@@ -0,0 +1,31 @@
+{{- if and ( .Capabilities.APIVersions.Has "monitoring.coreos.com/v1" ) ( .Values.serviceMonitor.enabled ) }}
+apiVersion: monitoring.coreos.com/v1
+kind: ServiceMonitor
+metadata:
+  name: {{ include "stirlingpdf.fullname" . }}
+  namespace: {{ .Values.serviceMonitor.namespace | default .Release.Namespace }}
+  labels:
+    {{- include "stirlingpdf.labels" . | nindent 4 }}
+    {{- with .Values.serviceMonitor.labels }}
+    {{- toYaml . | nindent 4 }}
+    {{- end }}
+spec:
+  endpoints:
+  - targetPort: 8080
+{{- if .Values.serviceMonitor.interval }}
+    interval: {{ .Values.serviceMonitor.interval }}
+{{- end }}
+{{- if .Values.serviceMonitor.metricsPath }}
+    path: {{ .Values.serviceMonitor.metricsPath }}
+{{- end }}
+{{- if .Values.serviceMonitor.timeout }}
+    scrapeTimeout: {{ .Values.serviceMonitor.timeout }}
+{{- end }}
+  jobLabel: {{ include "stirlingpdf.fullname" . }}
+  namespaceSelector:
+    matchNames:
+    - {{ .Release.Namespace }}
+  selector:
+    matchLabels:
+      {{- include "stirlingpdf.selectorLabels" . | nindent 6 }}
+{{- end }}

chart/stirling-pdf/values.yaml

@@ -0,0 +1,239 @@
+extraArgs: []
+  # - --storage-timestamp-tolerance 1s
+replicaCount: 1
+strategy:
+  type: RollingUpdate
+image:
+  repository: frooodle/s-pdf
+  # took Chart appVersion by default
+  tag: ~
+  pullPolicy: IfNotPresent
+secret:
+  labels: {}
+## Labels to apply to all resources
+##
+commonLabels: {}
+# team_name: dev
+
+envs: []
+# - name: PP_HOME_NAME
+#   value: "Stirling PDF"
+# - name: APP_HOME_DESCRIPTION
+#   value: "Your locally hosted one-stop-shop for all your PDF needs."
+# - name: APP_NAVBAR_NAME
+#   value: "Stirling PDF"
+# - name: ALLOW_GOOGLE_VISIBILITY
+#   value: "true"
+# - name: APP_ROOT_PATH
+#   value: "/"
+# - name: APP_LOCALE
+#   value: "en_GB"
+
+deployment:
+  ## stirling-pdf Deployment annotations
+  annotations: {}
+  #   name: value
+  labels: {}
+  #   name: value
+  # additional volumes
+  extraVolumes: []
+  #  - name: nginx-config
+  #    secret:
+  #      secretName: nginx-config
+  # additional volumes to mount
+  extraVolumeMounts: []
+  ## sidecarContainers for the stirling-pdf
+  # Can be used to add a proxy to the pod that does
+  # scanning for secrets, signing, authentication, validation
+  # of the chart's content, send notifications...
+  sidecarContainers: {}
+  ## Example sidecarContainer which uses an extraVolume from above and
+  ## a named port that can be referenced in the service as targetPort.
+  #  proxy:
+  #    image: nginx:latest
+  #    ports:
+  #      - name: proxy
+  #        containerPort: 8081
+  #    volumeMounts:
+  #      - name: nginx-config
+  #        readOnly: true
+  #        mountPath: /etc/nginx
+
+## Pod annotations
+## ref: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/
+## Read more about kube2iam to provide access to s3 https://github.com/jtblin/kube2iam
+##
+podAnnotations: {}
+  # iam.amazonaws.com/role: role-arn
+
+## Pod labels
+## ref: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
+podLabels: {}
+  # name: value
+
+service:
+  servicename:
+  type: ClusterIP
+  externalTrafficPolicy: Local
+  ## Uses pre-assigned IP address from cloud provider
+  ## Only valid if service.type: LoadBalancer
+  loadBalancerIP:
+  ## Limits which cidr blocks can connect to service's load balancer
+  ## Only valid if service.type: LoadBalancer
+  loadBalancerSourceRanges: []
+  # clusterIP: None
+  externalPort: 8080
+  ## targetPort of the container to use. If a sidecar should handle the
+  ## requests first, use the named port from the sidecar. See sidecar example
+  ## from deployment above. Leave empty to use stirling-pdf directly.
+  targetPort:
+  nodePort:
+  annotations: {}
+  labels: {}
+
+serviceMonitor:
+  enabled: false
+  # namespace: prometheus
+  labels: {}
+  metricsPath: "/metrics"
+  # timeout: 60
+  # interval: 60
+
+resources: {}
+#  limits:
+#    cpu: 100m
+#    memory: 128Mi
+#  requests:
+#    cpu: 80m
+#    memory: 64Mi
+
+probes:
+  liveness:
+    initialDelaySeconds: 5
+    periodSeconds: 10
+    timeoutSeconds: 1
+    successThreshold: 1
+    failureThreshold: 3
+  livenessHttpGetConfig:
+    scheme: HTTP
+  readiness:
+    initialDelaySeconds: 5
+    periodSeconds: 10
+    timeoutSeconds: 1
+    successThreshold: 1
+    failureThreshold: 3
+  readinessHttpGetConfig:
+    scheme: HTTP
+
+serviceAccount:
+  create: true
+  name: ""
+  automountServiceAccountToken: false
+  ## Annotations for the Service Account
+  annotations: {}
+
+# UID/GID 1000 is the default user "stirling-pdf" used in
+# the container image starting in v0.8.0 and above. This
+# is required for local persistent storage. If your cluster
+# does not allow this, try setting securityContext: {}
+securityContext:
+  enabled: true
+  fsGroup: 1000
+  ## Optionally, specify supplementalGroups and/or
+  ## runAsNonRoot for security purposes
+  # runAsNonRoot: true
+  # supplementalGroups: [1000]
+
+containerSecurityContext: {}
+
+priorityClassName: ""
+
+nodeSelector: {}
+
+tolerations: []
+
+affinity: {}
+
+persistence:
+  enabled: false
+  accessMode: ReadWriteOnce
+  size: 8Gi
+  labels: {}
+    # name: value
+  path: /tmp
+  ## A manually managed Persistent Volume and Claim
+  ## Requires persistence.enabled: true
+  ## If defined, PVC must be created manually before volume will be bound
+  # existingClaim:
+
+  ## stirling-pdf data Persistent Volume Storage Class
+  ## If defined, storageClassName: <storageClass>
+  ## If set to "-", storageClassName: "", which disables dynamic provisioning
+  ## If undefined (the default) or set to null, no storageClassName spec is
+  ##   set, choosing the default provisioner.  (gp2 on AWS, standard on
+  ##   GKE, AWS & OpenStack)
+  ##
+  # storageClass: "-"
+  # volumeName:
+  pv:
+    enabled: false
+    pvname:
+    capacity:
+      storage: 8Gi
+    accessMode: ReadWriteOnce
+    nfs:
+      server:
+      path:
+
+## Init containers parameters:
+## volumePermissions: Change the owner of the persistent volume mountpoint to RunAsUser:fsGroup
+##
+volumePermissions:
+  image:
+    registry: docker.io
+    repository: bitnami/minideb
+    tag: buster
+    pullPolicy: Always
+    ## Optionally specify an array of imagePullSecrets.
+    ## Secrets must be manually created in the namespace.
+    ## ref: https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/
+    ##
+    # pullSecrets:
+    #   - myRegistryKeySecretName
+
+## Ingress for load balancer
+ingress:
+  enabled: false
+  pathType: "ImplementationSpecific"
+  ## stirling-pdf Ingress labels
+  ##
+  labels: {}
+    # dns: "route53"
+
+  ## stirling-pdf Ingress annotations
+  ##
+  annotations: {}
+    # kubernetes.io/ingress.class: nginx
+    # kubernetes.io/tls-acme: "true"
+
+  ## stirling-pdf Ingress hostnames
+  ## Must be provided if Ingress is enabled
+  ##
+  hosts: []
+    # - name: stirling-pdf.domain1.com
+    #   path: /
+    #   tls: false
+    # - name: stirling-pdf.domain2.com
+    #   path: /
+    #
+    #   ## Set this to true in order to enable TLS on the ingress record
+    #   tls: true
+    #
+    #   ## If TLS is set to true, you must declare what secret will store the key/certificate for TLS
+    #   ## Secrets must be added manually to the namespace
+    #   tlsSecret: stirling-pdf.domain2-tls
+
+  # For Kubernetes >= 1.18 you should specify the ingress-controller via the field ingressClassName
+  # See https://kubernetes.io/blog/2020/04/02/improvements-to-the-ingress-api-in-kubernetes-1.18/#specifying-the-class-of-an-ingress
+  ingressClassName:
+

exampleYmlFiles/docker-compose-latest-lite-security.yml

@@ -0,0 +1,31 @@
+version: '3.3'
+services:
+  stirling-pdf:
+    container_name: Stirling-PDF-Lite-Security
+    image: frooodle/s-pdf:latest-lite
+    deploy:
+      resources:
+        limits:
+          memory: 2G
+    healthcheck:
+      test: ["CMD-SHELL", "curl -f http://localhost:8080/api/v1/info/status | grep -q 'UP' && curl -fL http://localhost:8080/ | grep -q 'Please sign in'"]
+      interval: 5s
+      timeout: 10s
+      retries: 16
+    ports:
+      - 8080:8080
+    volumes:
+      - /stirling/latest/data:/usr/share/tesseract-ocr/5/tessdata:rw
+      - /stirling/latest/config:/configs:rw
+      - /stirling/latest/logs:/logs:rw
+    environment:
+      DOCKER_ENABLE_SECURITY: "true"
+      SECURITY_ENABLELOGIN: "true"
+      SYSTEM_DEFAULTLOCALE: en_US
+      UI_APPNAME: Stirling-PDF-Lite
+      UI_HOMEDESCRIPTION: Demo site for Stirling-PDF-Lite Latest with Security
+      UI_APPNAMENAVBAR: Stirling-PDF-Lite Latest
+      SYSTEM_MAXFILESIZE: "100"
+      METRICS_ENABLED: "true"
+      SYSTEM_GOOGLEVISIBILITY: "true"
+    restart: on-failure:5

exampleYmlFiles/docker-compose-latest-lite.yml

@@ -0,0 +1,30 @@
+version: '3.3'
+services:
+  stirling-pdf:
+    container_name: Stirling-PDF-Lite
+    image: frooodle/s-pdf:latest-lite
+    deploy:
+      resources:
+        limits:
+          memory: 2G
+    healthcheck:
+      test: ["CMD-SHELL", "curl -f http://localhost:8080/api/v1/info/status | grep -q 'UP' && curl -fL http://localhost:8080/ | grep -qv 'Please sign in'"]
+      interval: 5s
+      timeout: 10s
+      retries: 16
+    ports:
+      - 8080:8080
+    volumes:
+      - /stirling/latest/config:/configs:rw
+      - /stirling/latest/logs:/logs:rw
+    environment:
+      DOCKER_ENABLE_SECURITY: "false"
+      SECURITY_ENABLELOGIN: "false"
+      SYSTEM_DEFAULTLOCALE: en_US
+      UI_APPNAME: Stirling-PDF-Lite
+      UI_HOMEDESCRIPTION: Demo site for Stirling-PDF-Lite Latest
+      UI_APPNAMENAVBAR: Stirling-PDF-Lite Latest
+      SYSTEM_MAXFILESIZE: "100"
+      METRICS_ENABLED: "true"
+      SYSTEM_GOOGLEVISIBILITY: "true"
+    restart: on-failure:5

exampleYmlFiles/docker-compose-latest-security.yml

@@ -0,0 +1,31 @@
+version: '3.3'
+services:
+  stirling-pdf:
+    container_name: Stirling-PDF-Security
+    image: frooodle/s-pdf:latest
+    deploy:
+      resources:
+        limits:
+          memory: 4G
+    healthcheck:
+      test: ["CMD-SHELL", "curl -f http://localhost:8080/api/v1/info/status | grep -q 'UP' && curl -fL http://localhost:8080/ | grep -q 'Please sign in'"]
+      interval: 5s
+      timeout: 10s
+      retries: 16
+    ports:
+      - 8080:8080
+    volumes:
+      - /stirling/latest/data:/usr/share/tesseract-ocr/5/tessdata:rw
+      - /stirling/latest/config:/configs:rw
+      - /stirling/latest/logs:/logs:rw
+    environment:
+      DOCKER_ENABLE_SECURITY: "true"
+      SECURITY_ENABLELOGIN: "true"
+      SYSTEM_DEFAULTLOCALE: en_US
+      UI_APPNAME: Stirling-PDF
+      UI_HOMEDESCRIPTION: Demo site for Stirling-PDF Latest with Security
+      UI_APPNAMENAVBAR: Stirling-PDF Latest
+      SYSTEM_MAXFILESIZE: "100"
+      METRICS_ENABLED: "true"
+      SYSTEM_GOOGLEVISIBILITY: "true"
+    restart: on-failure:5

exampleYmlFiles/docker-compose-latest-ultra-lite-security.yml

@@ -0,0 +1,31 @@
+version: '3.3'
+services:
+  stirling-pdf:
+    container_name: Stirling-PDF-Ultra-Lite-Security
+    image: frooodle/s-pdf:latest-ultra-lite
+    deploy:
+      resources:
+        limits:
+          memory: 1G
+    healthcheck:
+      test: ["CMD-SHELL", "curl -f http://localhost:8080/api/v1/info/status | grep -q 'UP' && curl -fL http://localhost:8080/ | grep -q 'Please sign in'"]
+      interval: 5s
+      timeout: 10s
+      retries: 16
+    ports:
+      - 8080:8080
+    volumes:
+      - /stirling/latest/data:/usr/share/tesseract-ocr/5/tessdata:rw
+      - /stirling/latest/config:/configs:rw
+      - /stirling/latest/logs:/logs:rw
+    environment:
+      DOCKER_ENABLE_SECURITY: "true"
+      SECURITY_ENABLELOGIN: "true"
+      SYSTEM_DEFAULTLOCALE: en_US
+      UI_APPNAME: Stirling-PDF-Lite
+      UI_HOMEDESCRIPTION: Demo site for Stirling-PDF-Lite Latest with Security
+      UI_APPNAMENAVBAR: Stirling-PDF-Lite Latest
+      SYSTEM_MAXFILESIZE: "100"
+      METRICS_ENABLED: "true"
+      SYSTEM_GOOGLEVISIBILITY: "true"
+    restart: on-failure:5

exampleYmlFiles/docker-compose-latest-ultra-lite.yml

@@ -0,0 +1,30 @@
+version: '3.3'
+services:
+  stirling-pdf:
+    container_name: Stirling-PDF-Ultra-Lite
+    image: frooodle/s-pdf:latest-ultra-lite
+    deploy:
+      resources:
+        limits:
+          memory: 1G
+    healthcheck:
+      test: ["CMD-SHELL", "curl -f http://localhost:8080/api/v1/info/status | grep -q 'UP' && curl -fL http://localhost:8080/ | grep -qv 'Please sign in'"]
+      interval: 5s
+      timeout: 10s
+      retries: 16
+    ports:
+      - 8080:8080
+    volumes:
+      - /stirling/latest/config:/configs:rw
+      - /stirling/latest/logs:/logs:rw
+    environment:
+      DOCKER_ENABLE_SECURITY: "false"
+      SECURITY_ENABLELOGIN: "false"
+      SYSTEM_DEFAULTLOCALE: en_US
+      UI_APPNAME: Stirling-PDF-Ultra-lite
+      UI_HOMEDESCRIPTION: Demo site for Stirling-PDF-Ultra-lite Latest
+      UI_APPNAMENAVBAR: Stirling-PDF-Ultra-lite Latest
+      SYSTEM_MAXFILESIZE: "100"
+      METRICS_ENABLED: "true"
+      SYSTEM_GOOGLEVISIBILITY: "true"
+    restart: on-failure:5

exampleYmlFiles/docker-compose-latest.yml

@@ -0,0 +1,31 @@
+version: '3.3'
+services:
+  stirling-pdf:
+    container_name: Stirling-PDF
+    image: frooodle/s-pdf:latest
+    deploy:
+      resources:
+        limits:
+          memory: 4G
+    healthcheck:
+      test: ["CMD-SHELL", "curl -f http://localhost:8080/api/v1/info/status | grep -q 'UP' && curl -fL http://localhost:8080/ | grep -qv 'Please sign in'"]
+      interval: 5s
+      timeout: 10s
+      retries: 16
+    ports:
+      - 8080:8080
+    volumes:
+      - /stirling/latest/data:/usr/share/tesseract-ocr/5/tessdata:rw
+      - /stirling/latest/config:/configs:rw
+      - /stirling/latest/logs:/logs:rw
+    environment:
+      DOCKER_ENABLE_SECURITY: "false"
+      SECURITY_ENABLELOGIN: "false"
+      SYSTEM_DEFAULTLOCALE: en_US
+      UI_APPNAME: Stirling-PDF
+      UI_HOMEDESCRIPTION: Demo site for Stirling-PDF Latest
+      UI_APPNAMENAVBAR: Stirling-PDF Latest
+      SYSTEM_MAXFILESIZE: "100"
+      METRICS_ENABLED: "true"
+      SYSTEM_GOOGLEVISIBILITY: "true"
+    restart: on-failure:5

lauch4jConfig.xml

@@ -0,0 +1,36 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<launch4jConfig>
+  <dontWrapJar>false</dontWrapJar>
+  <headerType>console</headerType>
+  <jar>.\build\libs\S-PDF-0.10.1.jar</jar>
+  <outfile>.\Stirling-PDF.exe</outfile>
+  <errTitle>Please download Java17</errTitle>
+  <cmdLine></cmdLine>
+  <chdir>.</chdir>
+  <priority>normal</priority>
+  <downloadUrl>https://download.oracle.com/java/17/latest/jdk-17_windows-x64_bin.exe</downloadUrl>
+  <supportUrl></supportUrl>
+  <stayAlive>false</stayAlive>
+  <restartOnCrash>false</restartOnCrash>
+  <manifest></manifest>
+  <icon>./src/main/resources/static/favicon.ico</icon>
+  <var>BROWSER_OPEN=true</var>
+  <singleInstance>
+    <mutexName>Stirling-PDF</mutexName>
+    <windowTitle>Stirling-PDF</windowTitle>
+  </singleInstance>
+  <jre>
+    <path>%JAVA_HOME%;%PATH%</path>
+    <requiresJdk>false</requiresJdk>
+    <requires64Bit>false</requires64Bit>
+    <minVersion>17</minVersion>
+    <maxVersion></maxVersion>
+  </jre>
+  <messages>
+    <startupErr>An error occurred while starting Stirling-PDF</startupErr>
+    <jreNotFoundErr>This application requires a Java Runtime Environment, Please download Java 17.</jreNotFoundErr>
+    <jreVersionErr>You are running the wrong version of Java, Please download Java 17.</jreVersionErr>
+    <launcherErr>Java is corrupted. Please uninstall and then install  Java 17.</launcherErr>
+    <instanceAlreadyExistsMsg>Stirling-PDF is already running.</instanceAlreadyExistsMsg>
+  </messages>
+</launch4jConfig>

pipeline/defaultWebUIConfigs/Prepare-pdfs-for-email.json

@@ -0,0 +1,39 @@
+{
+  "name": "Prepare-pdfs-for-email",
+  "pipeline": [
+    {
+      "operation": "/api/v1/misc/repair",
+      "parameters": {}
+    },
+    {
+      "operation": "/api/v1/security/sanitize-pdf",
+      "parameters": {
+        "removeJavaScript": true,
+        "removeEmbeddedFiles": false,
+        "removeMetadata": false,
+        "removeLinks": false,
+        "removeFonts": false
+      }
+    },
+    {
+      "operation": "/api/v1/misc/compress-pdf",
+      "parameters": {
+        "optimizeLevel": 2,
+        "expectedOutputSize": ""
+      }
+    },
+    {
+      "operation": "/api/v1/general/split-by-size-or-count",
+      "parameters": {
+        "splitType": 0,
+        "splitValue": "15MB"
+      }
+    }
+  ],
+  "_examples": {
+    "outputDir": "{outputFolder}/{folderName}",
+    "outputFileName": "{filename}-{pipelineName}-{date}-{time}"
+  },
+  "outputDir": "httpWebRequest",
+  "outputFileName": "{filename}"
+}

pipeline/defaultWebUIConfigs/split-rotate-auto-rename.json

@@ -0,0 +1,33 @@
+{
+  "name": "split-rotate-auto-rename",
+  "pipeline": [
+    {
+      "operation": "/api/v1/general/split-pdf-by-sections",
+      "parameters": {
+        "horizontalDivisions": 2,
+        "verticalDivisions": 2,
+        "fileInput": "automated"
+      }
+    },
+    {
+      "operation": "/api/v1/general/rotate-pdf",
+      "parameters": {
+        "angle": 90,
+        "fileInput": "automated"
+      }
+    },
+    {
+      "operation": "/api/v1/misc/auto-rename",
+      "parameters": {
+        "useFirstTextAsFallback": false,
+        "fileInput": "automated"
+      }
+    }
+  ],
+  "_examples": {
+    "outputDir": "{outputFolder}/{folderName}",
+    "outputFileName": "{filename}-{pipelineName}-{date}-{time}"
+  },
+  "outputDir": "{outputFolder}",
+  "outputFileName": "{filename}"
+}

scripts/PropSync.java

@@ -0,0 +1,80 @@
+package stirling.software.Stirling.Stats;
+
+import java.nio.file.*;
+import java.nio.charset.MalformedInputException;
+import java.nio.charset.StandardCharsets;
+import java.io.*;
+import java.util.*;
+
+public class PropSync {
+
+    public static void main(String[] args) throws IOException {
+        File folder = new File("C:\\Users\\systo\\git\\Stirling-PDF\\src\\main\\resources");
+        File[] files = folder.listFiles((dir, name) -> name.matches("messages_.*\\.properties"));
+
+        List<String> enLines = Files.readAllLines(Paths.get(folder + "\\messages_en_GB.properties"), StandardCharsets.UTF_8);
+        Map<String, String> enProps = linesToProps(enLines);
+
+        for (File file : files) {
+            if (!file.getName().equals("messages_en_GB.properties")) {
+                System.out.println("Processing file: " + file.getName());
+                List<String> lines;
+                try {
+                    lines = Files.readAllLines(file.toPath(), StandardCharsets.UTF_8);
+                } catch (MalformedInputException e) {
+                    System.out.println("Skipping due to not UTF8 format for file: " + file.getName());
+                    continue;
+                } catch (IOException e) {
+                    throw new UncheckedIOException(e);
+                }
+
+                Map<String, String> currentProps = linesToProps(lines);
+                List<String> newLines = syncPropsWithLines(enProps, currentProps, enLines);
+
+                Files.write(file.toPath(), newLines, StandardCharsets.UTF_8);
+                System.out.println("Finished processing file: " + file.getName());
+            }
+        }
+    }
+
+    private static Map<String, String> linesToProps(List<String> lines) {
+        Map<String, String> props = new LinkedHashMap<>();
+        for (String line : lines) {
+            if (!line.trim().isEmpty() && line.contains("=")) {
+                String[] parts = line.split("=", 2);
+                props.put(parts[0].trim(), parts[1].trim());
+            }
+        }
+        return props;
+    }
+
+    private static List<String> syncPropsWithLines(Map<String, String> enProps, Map<String, String> currentProps, List<String> enLines) {
+        List<String> newLines = new ArrayList<>();
+        boolean needsTranslateComment = false; // flag to check if we need to add "TODO: Translate"
+
+        for (String line : enLines) {
+            if (line.contains("=")) {
+                String key = line.split("=", 2)[0].trim();
+
+                if (currentProps.containsKey(key)) {
+                    newLines.add(key + "=" + currentProps.get(key));
+                    needsTranslateComment = false;
+                } else {
+                    if (!needsTranslateComment) {
+                        newLines.add("##########################");
+                        newLines.add("###  TODO: Translate   ###");
+                        newLines.add("##########################");
+                        needsTranslateComment = true;
+                    }
+                    newLines.add(line);
+                }
+            } else {
+                // handle comments and other non-property lines
+                newLines.add(line);
+                needsTranslateComment = false;  // reset the flag when we encounter comments or empty lines
+            }
+        }
+
+        return newLines;
+    }
+}

scripts/detect-blank-pages.py

@@ -0,0 +1,37 @@
+import cv2
+import sys
+import argparse
+import numpy as np
+
+def is_blank_image(image_path, threshold=10, white_percent=99, white_value=255, blur_size=5):
+    image = cv2.imread(image_path, cv2.IMREAD_GRAYSCALE)
+
+    if image is None:
+        print(f"Error: Unable to read the image file: {image_path}")
+        return False
+
+    # Apply Gaussian blur to reduce noise
+    blurred_image = cv2.GaussianBlur(image, (blur_size, blur_size), 0)
+
+    _, thresholded_image = cv2.threshold(blurred_image, white_value - threshold, white_value, cv2.THRESH_BINARY)
+
+    # Calculate the percentage of white pixels in the thresholded image
+    white_pixels = np.sum(thresholded_image == white_value)
+    white_pixel_percentage = (white_pixels / thresholded_image.size) * 100
+
+    print(f"Page has white pixel percent of {white_pixel_percentage}")
+    return white_pixel_percentage >= white_percent
+
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser(description='Detect if an image is considered blank or not.')
+    parser.add_argument('image_path', help='The path to the image file.')
+    parser.add_argument('-t', '--threshold', type=int, default=10, help='Threshold for determining white pixels. The default value is 10.')
+    parser.add_argument('-w', '--white_percent', type=float, default=99, help='The percentage of white pixels for an image to be considered blank. The default value is 99.')
+    args = parser.parse_args()
+
+    blank = is_blank_image(args.image_path, args.threshold, args.white_percent)
+
+    # Return code 1: The image is considered blank.
+    # Return code 0: The image is not considered blank.
+    sys.exit(int(blank))

scripts/download-security-jar.sh

@@ -0,0 +1,19 @@
+echo "Running Stirling PDF with DOCKER_ENABLE_SECURITY=${DOCKER_ENABLE_SECURITY} and VERSION_TAG=${VERSION_TAG}"
+# Check for DOCKER_ENABLE_SECURITY and download the appropriate JAR if required
+if [ "$DOCKER_ENABLE_SECURITY" = "true" ] && [ "$VERSION_TAG" != "alpha" ]; then
+    if [ ! -f app-security.jar ]; then
+    	echo "Trying to download from: https://github.com/Stirling-Tools/Stirling-PDF/releases/download/v$VERSION_TAG/Stirling-PDF-with-login.jar"
+        curl -L -o app-security.jar https://github.com/Stirling-Tools/Stirling-PDF/releases/download/v$VERSION_TAG/Stirling-PDF-with-login.jar
+       
+        # If the first download attempt failed, try with the 'v' prefix
+        if [ $? -ne 0 ]; then
+            echo "Trying to download from: https://github.com/Stirling-Tools/Stirling-PDF/releases/download/$VERSION_TAG/Stirling-PDF-with-login.jar"
+        	curl -L -o app-security.jar https://github.com/Stirling-Tools/Stirling-PDF/releases/download/$VERSION_TAG/Stirling-PDF-with-login.jar
+        fi
+
+        if [ $? -eq 0 ]; then  # checks if curl was successful
+            rm -f app.jar
+            ln -s app-security.jar app.jar
+        fi
+    fi
+fi

scripts/init-without-ocr.sh

@@ -0,0 +1,6 @@
+#!/bin/sh
+
+/scripts/download-security-jar.sh
+
+# Run the main command
+exec "$@"

scripts/init.sh

@@ -0,0 +1,26 @@
+#!/bin/bash
+
+# Copy the original tesseract-ocr files to the volume directory without overwriting existing files
+echo "Copying original files without overwriting existing files"
+mkdir -p /usr/share/tesseract-ocr
+cp -rn /usr/share/tesseract-ocr-original/* /usr/share/tesseract-ocr 
+
+if [ -d /usr/share/tesseract-ocr/4.00/tessdata ]; then 
+	cp -r /usr/share/tesseract-ocr/4.00/tessdata/* /usr/share/tesseract-ocr/5/tessdata/ || true; 
+fi
+
+# Check if TESSERACT_LANGS environment variable is set and is not empty
+if [[ -n "$TESSERACT_LANGS" ]]; then
+  # Convert comma-separated values to a space-separated list
+  LANGS=$(echo $TESSERACT_LANGS | tr ',' ' ')
+
+  # Install each language pack
+  for LANG in $LANGS; do
+    apt-get install -y "tesseract-ocr-$LANG"
+  done
+fi
+
+/scripts/download-security-jar.sh
+
+# Run the main command
+exec "$@"

scripts/split_photos.py

@@ -0,0 +1,116 @@
+import argparse
+import sys
+import cv2
+import numpy as np
+import os 
+
+def find_photo_boundaries(image, background_color, tolerance=30, min_area=10000, min_contour_area=500):
+    mask = cv2.inRange(image, background_color - tolerance, background_color + tolerance)
+    mask = cv2.bitwise_not(mask)
+    kernel = np.ones((5,5),np.uint8)
+    mask = cv2.dilate(mask, kernel, iterations=2)
+    contours, _ = cv2.findContours(mask, cv2.RETR_EXTERNAL, cv2.CHAIN_APPROX_SIMPLE)
+
+    photo_boundaries = []
+    for contour in contours:
+        x, y, w, h = cv2.boundingRect(contour)
+        area = w * h
+        contour_area = cv2.contourArea(contour)
+        if area >= min_area and contour_area >= min_contour_area:
+            photo_boundaries.append((x, y, w, h))
+
+    return photo_boundaries
+
+def estimate_background_color(image, sample_points=5):
+    h, w, _ = image.shape
+    points = [
+        (0, 0),
+        (w - 1, 0),
+        (w - 1, h - 1),
+        (0, h - 1),
+        (w // 2, h // 2),
+    ]
+
+    colors = []
+    for x, y in points:
+        colors.append(image[y, x])
+
+    return np.median(colors, axis=0)
+
+def auto_rotate(image, angle_threshold=1):
+    gray = cv2.cvtColor(image, cv2.COLOR_BGR2GRAY)
+    edges = cv2.Canny(gray, 50, 150, apertureSize=3)
+    lines = cv2.HoughLines(edges, 1, np.pi / 180, 200)
+
+    if lines is None:
+        return image
+
+    # compute the median angle of the lines
+    angles = []
+    for rho, theta in lines[:, 0]:
+        angles.append((theta * 180) / np.pi - 90)
+    
+    angle = np.median(angles)
+    
+    if abs(angle) < angle_threshold:
+        return image
+
+    (h, w) = image.shape[:2]
+    center = (w // 2, h // 2)
+    M = cv2.getRotationMatrix2D(center, angle, 1.0)
+    return cv2.warpAffine(image, M, (w, h), flags=cv2.INTER_CUBIC, borderMode=cv2.BORDER_REPLICATE)
+
+
+
+
+def crop_borders(image, border_color, tolerance=30):
+    mask = cv2.inRange(image, border_color - tolerance, border_color + tolerance)
+    
+    contours, _ = cv2.findContours(mask, cv2.RETR_EXTERNAL, cv2.CHAIN_APPROX_SIMPLE)
+    if len(contours) == 0:
+        return image
+
+    largest_contour = max(contours, key=cv2.contourArea)
+    x, y, w, h = cv2.boundingRect(largest_contour)
+    
+    return image[y:y+h, x:x+w]
+    
+def split_photos(input_file, output_directory, tolerance=30, min_area=10000, min_contour_area=500, angle_threshold=10, border_size=0):
+    image = cv2.imread(input_file)
+    background_color = estimate_background_color(image)
+
+    # Add a constant border around the image
+    image = cv2.copyMakeBorder(image, border_size, border_size, border_size, border_size, cv2.BORDER_CONSTANT, value=background_color)
+
+    photo_boundaries = find_photo_boundaries(image, background_color, tolerance)
+
+    if not os.path.exists(output_directory):
+        os.makedirs(output_directory)
+
+    # Get the input file's base name without the extension
+    input_file_basename = os.path.splitext(os.path.basename(input_file))[0]
+
+    for idx, (x, y, w, h) in enumerate(photo_boundaries):
+        cropped_image = image[y:y+h, x:x+w]
+        cropped_image = auto_rotate(cropped_image, angle_threshold)
+
+        # Remove the added border
+        cropped_image = cropped_image[border_size:-border_size, border_size:-border_size]
+
+        output_path = os.path.join(output_directory, f"{input_file_basename}_{idx+1}.png")
+        cv2.imwrite(output_path, cropped_image)
+        print(f"Saved {output_path}")
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser(description="Split photos in an image")
+    parser.add_argument("input_file", help="The input scanned image containing multiple photos.")
+    parser.add_argument("output_directory", help="The directory where the result images should be placed.")
+    parser.add_argument("--tolerance", type=int, default=30, help="Determines the range of color variation around the estimated background color (default: 30).")
+    parser.add_argument("--min_area", type=int, default=10000, help="Sets the minimum area threshold for a photo (default: 10000).")
+    parser.add_argument("--min_contour_area", type=int, default=500, help="Sets the minimum contour area threshold for a photo (default: 500).")
+    parser.add_argument("--angle_threshold", type=int, default=10, help="Sets the minimum absolute angle required for the image to be rotated (default: 10).")
+    parser.add_argument("--border_size", type=int, default=0, help="Sets the size of the border added and removed to prevent white borders in the output (default: 0).")
+    
+    args = parser.parse_args()
+
+    split_photos(args.input_file, args.output_directory, tolerance=args.tolerance, min_area=args.min_area, min_contour_area=args.min_contour_area, angle_threshold=args.angle_threshold, border_size=args.border_size)

settings.gradle

@@ -1 +1 @@
-rootProject.name = 'S-PDF'
+rootProject.name = 'Stirling-PDF'

src/main/java/org/apache/pdfbox/examples/signature/CMSProcessableInputStream.java

@@ -0,0 +1,64 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.pdfbox.examples.signature;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.OutputStream;
+
+import org.bouncycastle.asn1.ASN1ObjectIdentifier;
+import org.bouncycastle.asn1.cms.CMSObjectIdentifiers;
+import org.bouncycastle.cms.CMSException;
+import org.bouncycastle.cms.CMSTypedData;
+
+/**
+ * Wraps a InputStream into a CMSProcessable object for bouncy castle. It's a memory saving
+ * alternative to the {@link org.bouncycastle.cms.CMSProcessableByteArray CMSProcessableByteArray}
+ * class.
+ *
+ * @author Thomas Chojecki
+ */
+class CMSProcessableInputStream implements CMSTypedData {
+    private final InputStream in;
+    private final ASN1ObjectIdentifier contentType;
+
+    CMSProcessableInputStream(InputStream is) {
+        this(new ASN1ObjectIdentifier(CMSObjectIdentifiers.data.getId()), is);
+    }
+
+    CMSProcessableInputStream(ASN1ObjectIdentifier type, InputStream is) {
+        contentType = type;
+        in = is;
+    }
+
+    @Override
+    public Object getContent() {
+        return in;
+    }
+
+    @Override
+    public void write(OutputStream out) throws IOException, CMSException {
+        // read the content only one time
+        in.transferTo(out);
+        in.close();
+    }
+
+    @Override
+    public ASN1ObjectIdentifier getContentType() {
+        return contentType;
+    }
+}

src/main/java/org/apache/pdfbox/examples/signature/CreateSignatureBase.java

@@ -0,0 +1,170 @@
+/*
+ * Copyright 2015 The Apache Software Foundation.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.pdfbox.examples.signature;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.net.URISyntaxException;
+import java.security.GeneralSecurityException;
+import java.security.KeyStore;
+import java.security.KeyStoreException;
+import java.security.NoSuchAlgorithmException;
+import java.security.PrivateKey;
+import java.security.UnrecoverableKeyException;
+import java.security.cert.Certificate;
+import java.security.cert.CertificateException;
+import java.security.cert.X509Certificate;
+import java.util.Arrays;
+import java.util.Enumeration;
+
+import org.apache.pdfbox.pdmodel.interactive.digitalsignature.SignatureInterface;
+import org.bouncycastle.cert.jcajce.JcaCertStore;
+import org.bouncycastle.cms.CMSException;
+import org.bouncycastle.cms.CMSSignedData;
+import org.bouncycastle.cms.CMSSignedDataGenerator;
+import org.bouncycastle.cms.jcajce.JcaSignerInfoGeneratorBuilder;
+import org.bouncycastle.operator.ContentSigner;
+import org.bouncycastle.operator.OperatorCreationException;
+import org.bouncycastle.operator.jcajce.JcaContentSignerBuilder;
+import org.bouncycastle.operator.jcajce.JcaDigestCalculatorProviderBuilder;
+
+public abstract class CreateSignatureBase implements SignatureInterface {
+    private PrivateKey privateKey;
+    private Certificate[] certificateChain;
+    private String tsaUrl;
+    private boolean externalSigning;
+
+    /**
+     * Initialize the signature creator with a keystore (pkcs12) and pin that should be used for the
+     * signature.
+     *
+     * @param keystore is a pkcs12 keystore.
+     * @param pin is the pin for the keystore / private key
+     * @throws KeyStoreException if the keystore has not been initialized (loaded)
+     * @throws NoSuchAlgorithmException if the algorithm for recovering the key cannot be found
+     * @throws UnrecoverableKeyException if the given password is wrong
+     * @throws CertificateException if the certificate is not valid as signing time
+     * @throws IOException if no certificate could be found
+     */
+    public CreateSignatureBase(KeyStore keystore, char[] pin)
+            throws KeyStoreException,
+                    UnrecoverableKeyException,
+                    NoSuchAlgorithmException,
+                    IOException,
+                    CertificateException {
+        // grabs the first alias from the keystore and get the private key. An
+        // alternative method or constructor could be used for setting a specific
+        // alias that should be used.
+        Enumeration<String> aliases = keystore.aliases();
+        String alias;
+        Certificate cert = null;
+        while (cert == null && aliases.hasMoreElements()) {
+            alias = aliases.nextElement();
+            setPrivateKey((PrivateKey) keystore.getKey(alias, pin));
+            Certificate[] certChain = keystore.getCertificateChain(alias);
+            if (certChain != null) {
+                setCertificateChain(certChain);
+                cert = certChain[0];
+                if (cert instanceof X509Certificate) {
+                    // avoid expired certificate
+                    ((X509Certificate) cert).checkValidity();
+
+                    //// SigUtils.checkCertificateUsage((X509Certificate) cert);
+                }
+            }
+        }
+
+        if (cert == null) {
+            throw new IOException("Could not find certificate");
+        }
+    }
+
+    public final void setPrivateKey(PrivateKey privateKey) {
+        this.privateKey = privateKey;
+    }
+
+    public final void setCertificateChain(final Certificate[] certificateChain) {
+        this.certificateChain = certificateChain;
+    }
+
+    public Certificate[] getCertificateChain() {
+        return certificateChain;
+    }
+
+    public void setTsaUrl(String tsaUrl) {
+        this.tsaUrl = tsaUrl;
+    }
+
+    /**
+     * SignatureInterface sample implementation.
+     *
+     * <p>This method will be called from inside of the pdfbox and create the PKCS #7 signature. The
+     * given InputStream contains the bytes that are given by the byte range.
+     *
+     * <p>This method is for internal use only.
+     *
+     * <p>Use your favorite cryptographic library to implement PKCS #7 signature creation. If you
+     * want to create the hash and the signature separately (e.g. to transfer only the hash to an
+     * external application), read <a href="https://stackoverflow.com/questions/41767351">this
+     * answer</a> or <a href="https://stackoverflow.com/questions/56867465">this answer</a>.
+     *
+     * @throws IOException
+     */
+    @Override
+    public byte[] sign(InputStream content) throws IOException {
+        // cannot be done private (interface)
+        try {
+            CMSSignedDataGenerator gen = new CMSSignedDataGenerator();
+            X509Certificate cert = (X509Certificate) certificateChain[0];
+            ContentSigner sha1Signer =
+                    new JcaContentSignerBuilder("SHA256WithRSA").build(privateKey);
+            gen.addSignerInfoGenerator(
+                    new JcaSignerInfoGeneratorBuilder(
+                                    new JcaDigestCalculatorProviderBuilder().build())
+                            .build(sha1Signer, cert));
+            gen.addCertificates(new JcaCertStore(Arrays.asList(certificateChain)));
+            CMSProcessableInputStream msg = new CMSProcessableInputStream(content);
+            CMSSignedData signedData = gen.generate(msg, false);
+            if (tsaUrl != null && !tsaUrl.isEmpty()) {
+                ValidationTimeStamp validation = new ValidationTimeStamp(tsaUrl);
+                signedData = validation.addSignedTimeStamp(signedData);
+            }
+            return signedData.getEncoded();
+        } catch (GeneralSecurityException
+                | CMSException
+                | OperatorCreationException
+                | URISyntaxException e) {
+            throw new IOException(e);
+        }
+    }
+
+    /**
+     * Set if external signing scenario should be used. If {@code false}, SignatureInterface would
+     * be used for signing.
+     *
+     * <p>Default: {@code false}
+     *
+     * @param externalSigning {@code true} if external signing should be performed
+     */
+    public void setExternalSigning(boolean externalSigning) {
+        this.externalSigning = externalSigning;
+    }
+
+    public boolean isExternalSigning() {
+        return externalSigning;
+    }
+}

src/main/java/org/apache/pdfbox/examples/signature/TSAClient.java

@@ -0,0 +1,176 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.pdfbox.examples.signature;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.OutputStream;
+import java.math.BigInteger;
+import java.net.URL;
+import java.net.URLConnection;
+import java.nio.charset.StandardCharsets;
+import java.security.DigestInputStream;
+import java.security.MessageDigest;
+import java.security.SecureRandom;
+import java.util.Base64;
+import java.util.Random;
+
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
+import org.bouncycastle.asn1.ASN1ObjectIdentifier;
+import org.bouncycastle.operator.DefaultDigestAlgorithmIdentifierFinder;
+import org.bouncycastle.operator.DigestAlgorithmIdentifierFinder;
+import org.bouncycastle.tsp.TSPException;
+import org.bouncycastle.tsp.TimeStampRequest;
+import org.bouncycastle.tsp.TimeStampRequestGenerator;
+import org.bouncycastle.tsp.TimeStampResponse;
+import org.bouncycastle.tsp.TimeStampToken;
+
+/**
+ * Time Stamping Authority (TSA) Client [RFC 3161].
+ *
+ * @author Vakhtang Koroghlishvili
+ * @author John Hewson
+ */
+public class TSAClient {
+    private static final Logger LOG = LogManager.getLogger(TSAClient.class);
+
+    private static final DigestAlgorithmIdentifierFinder ALGORITHM_OID_FINDER =
+            new DefaultDigestAlgorithmIdentifierFinder();
+
+    private final URL url;
+    private final String username;
+    private final String password;
+    private final MessageDigest digest;
+
+    // SecureRandom.getInstanceStrong() would be better, but sometimes blocks on Linux
+    private static final Random RANDOM = new SecureRandom();
+
+    /**
+     * @param url the URL of the TSA service
+     * @param username user name of TSA
+     * @param password password of TSA
+     * @param digest the message digest to use
+     */
+    public TSAClient(URL url, String username, String password, MessageDigest digest) {
+        this.url = url;
+        this.username = username;
+        this.password = password;
+        this.digest = digest;
+    }
+
+    /**
+     * @param content
+     * @return the time stamp token
+     * @throws IOException if there was an error with the connection or data from the TSA server, or
+     *     if the time stamp response could not be validated
+     */
+    public TimeStampToken getTimeStampToken(InputStream content) throws IOException {
+        digest.reset();
+        DigestInputStream dis = new DigestInputStream(content, digest);
+        while (dis.read() != -1) {
+            // do nothing
+        }
+        byte[] hash = digest.digest();
+
+        // 32-bit cryptographic nonce
+        int nonce = RANDOM.nextInt();
+
+        // generate TSA request
+        TimeStampRequestGenerator tsaGenerator = new TimeStampRequestGenerator();
+        tsaGenerator.setCertReq(true);
+        ASN1ObjectIdentifier oid = ALGORITHM_OID_FINDER.find(digest.getAlgorithm()).getAlgorithm();
+        TimeStampRequest request = tsaGenerator.generate(oid, hash, BigInteger.valueOf(nonce));
+
+        // get TSA response
+        byte[] tsaResponse = getTSAResponse(request.getEncoded());
+
+        TimeStampResponse response;
+        try {
+            response = new TimeStampResponse(tsaResponse);
+            response.validate(request);
+        } catch (TSPException e) {
+            throw new IOException(e);
+        }
+
+        TimeStampToken timeStampToken = response.getTimeStampToken();
+        if (timeStampToken == null) {
+            // https://www.ietf.org/rfc/rfc3161.html#section-2.4.2
+            throw new IOException(
+                    "Response from "
+                            + url
+                            + " does not have a time stamp token, status: "
+                            + response.getStatus()
+                            + " ("
+                            + response.getStatusString()
+                            + ")");
+        }
+
+        return timeStampToken;
+    }
+
+    // gets response data for the given encoded TimeStampRequest data
+    // throws IOException if a connection to the TSA cannot be established
+    private byte[] getTSAResponse(byte[] request) throws IOException {
+        LOG.debug("Opening connection to TSA server");
+
+        // todo: support proxy servers
+        URLConnection connection = url.openConnection();
+        connection.setDoOutput(true);
+        connection.setDoInput(true);
+        connection.setRequestProperty("Content-Type", "application/timestamp-query");
+
+        LOG.debug("Established connection to TSA server");
+
+        if (username != null && password != null && !username.isEmpty() && !password.isEmpty()) {
+            String contentEncoding = connection.getContentEncoding();
+            if (contentEncoding == null) {
+                contentEncoding = StandardCharsets.UTF_8.name();
+            }
+            connection.setRequestProperty(
+                    "Authorization",
+                    "Basic "
+                            + new String(
+                                    Base64.getEncoder()
+                                            .encode(
+                                                    (username + ":" + password)
+                                                            .getBytes(contentEncoding))));
+        }
+
+        // read response
+        try (OutputStream output = connection.getOutputStream()) {
+            output.write(request);
+        } catch (IOException ex) {
+            LOG.error("Exception when writing to {}", this.url, ex);
+            throw ex;
+        }
+
+        LOG.debug("Waiting for response from TSA server");
+
+        byte[] response;
+        try (InputStream input = connection.getInputStream()) {
+            response = input.readAllBytes();
+        } catch (IOException ex) {
+            LOG.error("Exception when reading from {}", this.url, ex);
+            throw ex;
+        }
+
+        LOG.debug("Received response from TSA server");
+
+        return response;
+    }
+}

src/main/java/org/apache/pdfbox/examples/signature/ValidationTimeStamp.java

@@ -0,0 +1,134 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.pdfbox.examples.signature;
+
+import java.io.ByteArrayInputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.net.MalformedURLException;
+import java.net.URI;
+import java.net.URISyntaxException;
+import java.security.MessageDigest;
+import java.security.NoSuchAlgorithmException;
+import java.util.ArrayList;
+import java.util.List;
+
+import org.bouncycastle.asn1.ASN1Encodable;
+import org.bouncycastle.asn1.ASN1EncodableVector;
+import org.bouncycastle.asn1.ASN1ObjectIdentifier;
+import org.bouncycastle.asn1.ASN1Primitive;
+import org.bouncycastle.asn1.DERSet;
+import org.bouncycastle.asn1.cms.Attribute;
+import org.bouncycastle.asn1.cms.AttributeTable;
+import org.bouncycastle.asn1.cms.Attributes;
+import org.bouncycastle.asn1.pkcs.PKCSObjectIdentifiers;
+import org.bouncycastle.cms.CMSSignedData;
+import org.bouncycastle.cms.SignerInformation;
+import org.bouncycastle.cms.SignerInformationStore;
+import org.bouncycastle.tsp.TimeStampToken;
+
+/**
+ * This class wraps the TSAClient and the work that has to be done with it. Like Adding Signed
+ * TimeStamps to a signature, or creating a CMS timestamp attribute (with a signed timestamp)
+ *
+ * @author Others
+ * @author Alexis Suter
+ */
+public class ValidationTimeStamp {
+    private TSAClient tsaClient;
+
+    /**
+     * @param tsaUrl The url where TS-Request will be done.
+     * @throws NoSuchAlgorithmException
+     * @throws MalformedURLException
+     * @throws java.net.URISyntaxException
+     */
+    public ValidationTimeStamp(String tsaUrl)
+            throws NoSuchAlgorithmException, MalformedURLException, URISyntaxException {
+        if (tsaUrl != null) {
+            MessageDigest digest = MessageDigest.getInstance("SHA-256");
+            this.tsaClient = new TSAClient(new URI(tsaUrl).toURL(), null, null, digest);
+        }
+    }
+
+    /**
+     * Creates a signed timestamp token by the given input stream.
+     *
+     * @param content InputStream of the content to sign
+     * @return the byte[] of the timestamp token
+     * @throws IOException
+     */
+    public byte[] getTimeStampToken(InputStream content) throws IOException {
+        TimeStampToken timeStampToken = tsaClient.getTimeStampToken(content);
+        return timeStampToken.getEncoded();
+    }
+
+    /**
+     * Extend cms signed data with TimeStamp first or to all signers
+     *
+     * @param signedData Generated CMS signed data
+     * @return CMSSignedData Extended CMS signed data
+     * @throws IOException
+     */
+    public CMSSignedData addSignedTimeStamp(CMSSignedData signedData) throws IOException {
+        SignerInformationStore signerStore = signedData.getSignerInfos();
+        List<SignerInformation> newSigners = new ArrayList<>();
+
+        for (SignerInformation signer : signerStore.getSigners()) {
+            // This adds a timestamp to every signer (into his unsigned attributes) in the
+            // signature.
+            newSigners.add(signTimeStamp(signer));
+        }
+
+        // Because new SignerInformation is created, new SignerInfoStore has to be created
+        // and also be replaced in signedData. Which creates a new signedData object.
+        return CMSSignedData.replaceSigners(signedData, new SignerInformationStore(newSigners));
+    }
+
+    /**
+     * Extend CMS Signer Information with the TimeStampToken into the unsigned Attributes.
+     *
+     * @param signer information about signer
+     * @return information about SignerInformation
+     * @throws IOException
+     */
+    private SignerInformation signTimeStamp(SignerInformation signer) throws IOException {
+        AttributeTable unsignedAttributes = signer.getUnsignedAttributes();
+
+        ASN1EncodableVector vector = new ASN1EncodableVector();
+        if (unsignedAttributes != null) {
+            vector = unsignedAttributes.toASN1EncodableVector();
+        }
+
+        TimeStampToken timeStampToken =
+                tsaClient.getTimeStampToken(new ByteArrayInputStream(signer.getSignature()));
+        byte[] token = timeStampToken.getEncoded();
+        ASN1ObjectIdentifier oid = PKCSObjectIdentifiers.id_aa_signatureTimeStampToken;
+        ASN1Encodable signatureTimeStamp =
+                new Attribute(oid, new DERSet(ASN1Primitive.fromByteArray(token)));
+
+        vector.add(signatureTimeStamp);
+        Attributes signedAttributes = new Attributes(vector);
+
+        // There is no other way changing the unsigned attributes of the signer information.
+        // result is never null, new SignerInformation always returned,
+        // see source code of replaceUnsignedAttributes
+        return SignerInformation.replaceUnsignedAttributes(
+                signer, new AttributeTable(signedAttributes));
+    }
+}

src/main/java/org/apache/pdfbox/examples/util/ConnectedInputStream.java

@@ -0,0 +1,82 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.pdfbox.examples.util;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.net.HttpURLConnection;
+
+/**
+ * Delegate class to close the connection when the class gets closed.
+ *
+ * @author Tilman Hausherr
+ */
+public class ConnectedInputStream extends InputStream {
+    HttpURLConnection con;
+    InputStream is;
+
+    public ConnectedInputStream(HttpURLConnection con, InputStream is) {
+        this.con = con;
+        this.is = is;
+    }
+
+    @Override
+    public int read() throws IOException {
+        return is.read();
+    }
+
+    @Override
+    public int read(byte[] b) throws IOException {
+        return is.read(b);
+    }
+
+    @Override
+    public int read(byte[] b, int off, int len) throws IOException {
+        return is.read(b, off, len);
+    }
+
+    @Override
+    public long skip(long n) throws IOException {
+        return is.skip(n);
+    }
+
+    @Override
+    public int available() throws IOException {
+        return is.available();
+    }
+
+    @Override
+    public synchronized void mark(int readlimit) {
+        is.mark(readlimit);
+    }
+
+    @Override
+    public synchronized void reset() throws IOException {
+        is.reset();
+    }
+
+    @Override
+    public boolean markSupported() {
+        return is.markSupported();
+    }
+
+    @Override
+    public void close() throws IOException {
+        is.close();
+        con.disconnect();
+    }
+}

src/main/java/stirling/software/SPDF/LibreOfficeListener.java

@@ -1,4 +1,5 @@
 package stirling.software.SPDF;
+
 import java.io.IOException;
 import java.net.InetSocketAddress;
 import java.net.Socket;
@@ -6,89 +7,90 @@ import java.util.concurrent.ExecutorService;
 import java.util.concurrent.Executors;
 
 public class LibreOfficeListener {
-    
-    private static final LibreOfficeListener INSTANCE = new LibreOfficeListener();
-    
+
     private static final long ACTIVITY_TIMEOUT = 20 * 60 * 1000; // 20 minutes
+
+    private static final LibreOfficeListener INSTANCE = new LibreOfficeListener();
     private static final int LISTENER_PORT = 2002;
-    
-    private ExecutorService executorService;
-    private Process process;
-    private long lastActivityTime;
-    
-    private LibreOfficeListener() {}
-    
+
     public static LibreOfficeListener getInstance() {
         return INSTANCE;
     }
-    
-    public void start() throws IOException {
-        // Check if the listener is already running
-        if (process != null && process.isAlive()) {
-            return;
-        }
-        
-        // Start the listener process
-        process = Runtime.getRuntime().exec("unoconv --listener");
-        lastActivityTime = System.currentTimeMillis();
-        
-        // Start a background thread to monitor the activity timeout
-        executorService = Executors.newSingleThreadExecutor();
-        executorService.submit(() -> {
-            while (true) {
-                long idleTime = System.currentTimeMillis() - lastActivityTime;
-                if (idleTime >= ACTIVITY_TIMEOUT) {
-                    // If there has been no activity for too long, tear down the listener
-                    process.destroy();
-                    break;
-                }
-                try {
-                    Thread.sleep(5000); // Check for inactivity every 5 seconds
-                } catch (InterruptedException e) {
-                    break;
-                }
-            }
-        });
-        
-        
-     // Wait for the listener to start up
-        long startTime = System.currentTimeMillis();
-        long timeout = 30000; // Timeout after 30 seconds
-        while (System.currentTimeMillis() - startTime < timeout) {
-            if (isListenerRunning()) {
-            	
-                lastActivityTime = System.currentTimeMillis();
-                return;
-            }
-            try {
-				Thread.sleep(1000);
-			} catch (InterruptedException e) {
-				// TODO Auto-generated catch block
-				e.printStackTrace();
-			} // Check every 1 second
-        }
-    }
-    
+
+    private ExecutorService executorService;
+    private long lastActivityTime;
+
+    private Process process;
+
+    private LibreOfficeListener() {}
+
     private boolean isListenerRunning() {
         try {
-        	System.out.println("waiting for listener to start");
+            System.out.println("waiting for listener to start");
             Socket socket = new Socket();
-            socket.connect(new InetSocketAddress("localhost", 2002), 1000); // Timeout after 1 second
+            socket.connect(
+                    new InetSocketAddress("localhost", 2002), 1000); // Timeout after 1 second
             socket.close();
             return true;
         } catch (IOException e) {
             return false;
         }
     }
-    
+
+    public void start() throws IOException {
+        // Check if the listener is already running
+        if (process != null && process.isAlive()) {
+            return;
+        }
+
+        // Start the listener process
+        process = Runtime.getRuntime().exec("unoconv --listener");
+        lastActivityTime = System.currentTimeMillis();
+
+        // Start a background thread to monitor the activity timeout
+        executorService = Executors.newSingleThreadExecutor();
+        executorService.submit(
+                () -> {
+                    while (true) {
+                        long idleTime = System.currentTimeMillis() - lastActivityTime;
+                        if (idleTime >= ACTIVITY_TIMEOUT) {
+                            // If there has been no activity for too long, tear down the listener
+                            process.destroy();
+                            break;
+                        }
+                        try {
+                            Thread.sleep(5000); // Check for inactivity every 5 seconds
+                        } catch (InterruptedException e) {
+                            break;
+                        }
+                    }
+                });
+
+        // Wait for the listener to start up
+        long startTime = System.currentTimeMillis();
+        long timeout = 30000; // Timeout after 30 seconds
+        while (System.currentTimeMillis() - startTime < timeout) {
+            if (isListenerRunning()) {
+
+                lastActivityTime = System.currentTimeMillis();
+                return;
+            }
+            try {
+                Thread.sleep(1000);
+            } catch (InterruptedException e) {
+                // TODO Auto-generated catch block
+                e.printStackTrace();
+            } // Check every 1 second
+        }
+    }
+
     public synchronized void stop() {
         // Stop the activity timeout monitor thread
         executorService.shutdownNow();
-        
+
         // Stop the listener process
         if (process != null && process.isAlive()) {
             process.destroy();
         }
     }
-    
 }

src/main/java/stirling/software/SPDF/SPdfApplication.java

@@ -1,11 +1,81 @@
 package stirling.software.SPDF;
 
+import java.nio.file.Files;
+import java.nio.file.Paths;
+import java.util.Collections;
+
+import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.core.env.Environment;
+import org.springframework.scheduling.annotation.EnableScheduling;
+
+import jakarta.annotation.PostConstruct;
+import stirling.software.SPDF.config.ConfigInitializer;
+import stirling.software.SPDF.utils.GeneralUtils;
 
 @SpringBootApplication
+@EnableScheduling
 public class SPdfApplication {
-    public static void main(String[] args) {
-        SpringApplication.run(SPdfApplication.class, args);     
+
+    @Autowired private Environment env;
+
+    @PostConstruct
+    public void init() {
+        // Check if the BROWSER_OPEN environment variable is set to true
+        String browserOpenEnv = env.getProperty("BROWSER_OPEN");
+        boolean browserOpen = browserOpenEnv != null && browserOpenEnv.equalsIgnoreCase("true");
+
+        if (browserOpen) {
+            try {
+                String url = "http://localhost:" + getPort();
+
+                String os = System.getProperty("os.name").toLowerCase();
+                Runtime rt = Runtime.getRuntime();
+                if (os.contains("win")) {
+                    // For Windows
+                    rt.exec("rundll32 url.dll,FileProtocolHandler " + url);
+                }
+            } catch (Exception e) {
+                e.printStackTrace();
+            }
+        }
     }
-}
+
+    public static void main(String[] args) {
+        SpringApplication app = new SpringApplication(SPdfApplication.class);
+        app.addInitializers(new ConfigInitializer());
+        if (Files.exists(Paths.get("configs/settings.yml"))) {
+            app.setDefaultProperties(
+                    Collections.singletonMap(
+                            "spring.config.additional-location", "file:configs/settings.yml"));
+        } else {
+            System.out.println(
+                    "External configuration file 'configs/settings.yml' does not exist. Using default configuration and environment configuration instead.");
+        }
+        app.run(args);
+
+        try {
+            Thread.sleep(1000);
+        } catch (InterruptedException e) {
+            // TODO Auto-generated catch block
+            e.printStackTrace();
+        }
+
+        GeneralUtils.createDir("customFiles/static/");
+        GeneralUtils.createDir("customFiles/templates/");
+
+        System.out.println("Stirling-PDF Started.");
+
+        String url = "http://localhost:" + getPort();
+        System.out.println("Navigate to " + url);
+    }
+
+    public static String getPort() {
+        String port = System.getProperty("local.server.port");
+        if (port == null || port.isEmpty()) {
+            port = "8080";
+        }
+        return port;
+    }
+}

src/main/java/stirling/software/SPDF/config/AppConfig.java

@@ -1,43 +1,81 @@
 package stirling.software.SPDF.config;
 
+import java.nio.file.Files;
+import java.nio.file.Paths;
+
+import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 
+import stirling.software.SPDF.model.ApplicationProperties;
 
 @Configuration
-public class AppConfig { 
+public class AppConfig {
+
+    @Autowired ApplicationProperties applicationProperties;
+
+    @Bean(name = "loginEnabled")
+    public boolean loginEnabled() {
+        return applicationProperties.getSecurity().getEnableLogin();
+    }
+
+    @Bean(name = "appName")
+    public String appName() {
+        String homeTitle = applicationProperties.getUi().getAppName();
+        return (homeTitle != null) ? homeTitle : "Stirling PDF";
+    }
+
     @Bean(name = "appVersion")
     public String appVersion() {
         String version = getClass().getPackage().getImplementationVersion();
-        return (version != null) ? version : "0.3.3";
+        return (version != null) ? version : "0.0.0";
     }
-    
-    @Bean(name = "appName")
-    public String appName() {
-        String appName = System.getProperty("APP_HOME_NAME");
-        if(appName == null)
-            appName = System.getenv("APP_HOME_NAME");
-        return (appName != null) ? appName : "Stirling PDF";
-    }
-    
-    @Bean(name = "navBarText")
-    public String navBarText() {
-        String navBarText = System.getProperty("APP_NAVBAR_NAME");
-        if(navBarText == null)
-        	navBarText = System.getenv("APP_NAVBAR_NAME");
-        if(navBarText == null)
-        	navBarText = System.getProperty("APP_HOME_NAME");
-        if(navBarText == null)
-        	navBarText = System.getenv("APP_HOME_NAME");
-        
-        return (navBarText != null) ? navBarText : "Stirling PDF";
-    }
-    
+
     @Bean(name = "homeText")
     public String homeText() {
-        String homeText = System.getProperty("APP_HOME_DESCRIPTION");
-        if(homeText == null)
-        	homeText = System.getenv("APP_HOME_DESCRIPTION");
-        return (homeText != null) ? homeText : "null";
+        return (applicationProperties.getUi().getHomeDescription() != null)
+                ? applicationProperties.getUi().getHomeDescription()
+                : "null";
     }
-}
+
+    @Bean(name = "navBarText")
+    public String navBarText() {
+        String defaultNavBar =
+                applicationProperties.getUi().getAppNameNavbar() != null
+                        ? applicationProperties.getUi().getAppNameNavbar()
+                        : applicationProperties.getUi().getAppName();
+        return (defaultNavBar != null) ? defaultNavBar : "Stirling PDF";
+    }
+
+    @Bean(name = "enableAlphaFunctionality")
+    public boolean enableAlphaFunctionality() {
+        return applicationProperties.getSystem().getEnableAlphaFunctionality() != null
+                ? applicationProperties.getSystem().getEnableAlphaFunctionality()
+                : false;
+    }
+
+    @Bean(name = "rateLimit")
+    public boolean rateLimit() {
+        String appName = System.getProperty("rateLimit");
+        if (appName == null) appName = System.getenv("rateLimit");
+        return (appName != null) ? Boolean.valueOf(appName) : false;
+    }
+
+    @Bean(name = "RunningInDocker")
+    public boolean runningInDocker() {
+        return Files.exists(Paths.get("/.dockerenv"));
+    }
+
+    @Bean(name = "bookFormatsInstalled")
+    public boolean bookFormatsInstalled() {
+        return applicationProperties.getSystem().getCustomApplications().isInstallBookFormats();
+    }
+
+    @Bean(name = "htmlFormatsInstalled")
+    public boolean htmlFormatsInstalled() {
+        return applicationProperties
+                .getSystem()
+                .getCustomApplications()
+                .isInstallAdvancedHtmlToPDF();
+    }
+}

src/main/java/stirling/software/SPDF/config/Beans.java

@@ -2,6 +2,7 @@ package stirling.software.SPDF.config;
 
 import java.util.Locale;
 
+import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.web.servlet.LocaleResolver;
@@ -10,31 +11,17 @@ import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
 import org.springframework.web.servlet.i18n.LocaleChangeInterceptor;
 import org.springframework.web.servlet.i18n.SessionLocaleResolver;
 
+import stirling.software.SPDF.model.ApplicationProperties;
+
 @Configuration
 public class Beans implements WebMvcConfigurer {
 
-    @Bean
-    public LocaleResolver localeResolver() {
-        SessionLocaleResolver slr = new SessionLocaleResolver();
+    @Autowired ApplicationProperties applicationProperties;
 
-        String appLocaleEnv = System.getProperty("APP_LOCALE");
-        if(appLocaleEnv == null)
-            appLocaleEnv = System.getenv("APP_LOCALE");
-        Locale defaultLocale = Locale.UK; // Fallback to UK locale if environment variable is not set
-
-        if (appLocaleEnv != null && !appLocaleEnv.isEmpty()) {
-            Locale tempLocale = Locale.forLanguageTag(appLocaleEnv);
-            String tempLanguageTag = tempLocale.toLanguageTag();
-
-            if (appLocaleEnv.equalsIgnoreCase(tempLanguageTag)) {
-                defaultLocale = tempLocale;
-            } else {
-                System.err.println("Invalid APP_LOCALE environment variable value. Falling back to default Locale.UK.");
-            }
-        }
-
-        slr.setDefaultLocale(defaultLocale);
-        return slr;
+    @Override
+    public void addInterceptors(InterceptorRegistry registry) {
+        registry.addInterceptor(localeChangeInterceptor());
+        registry.addInterceptor(new CleanUrlInterceptor());
     }
 
     @Bean
@@ -44,9 +31,34 @@ public class Beans implements WebMvcConfigurer {
         return lci;
     }
 
-    @Override
-    public void addInterceptors(InterceptorRegistry registry) {
-        registry.addInterceptor(localeChangeInterceptor());
-    }
+    @Bean
+    public LocaleResolver localeResolver() {
+        SessionLocaleResolver slr = new SessionLocaleResolver();
 
+        String appLocaleEnv = applicationProperties.getSystem().getDefaultLocale();
+        Locale defaultLocale =
+                Locale.UK; // Fallback to UK locale if environment variable is not set
+
+        if (appLocaleEnv != null && !appLocaleEnv.isEmpty()) {
+            Locale tempLocale = Locale.forLanguageTag(appLocaleEnv);
+            String tempLanguageTag = tempLocale.toLanguageTag();
+
+            if (appLocaleEnv.equalsIgnoreCase(tempLanguageTag)) {
+                defaultLocale = tempLocale;
+            } else {
+                tempLocale = Locale.forLanguageTag(appLocaleEnv.replace("_", "-"));
+                tempLanguageTag = tempLocale.toLanguageTag();
+
+                if (appLocaleEnv.equalsIgnoreCase(tempLanguageTag)) {
+                    defaultLocale = tempLocale;
+                } else {
+                    System.err.println(
+                            "Invalid APP_LOCALE environment variable value. Falling back to default Locale.UK.");
+                }
+            }
+        }
+
+        slr.setDefaultLocale(defaultLocale);
+        return slr;
+    }
 }

src/main/java/stirling/software/SPDF/config/CleanUrlInterceptor.java

@@ -0,0 +1,74 @@
+package stirling.software.SPDF.config;
+
+import java.util.Arrays;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+import org.springframework.web.servlet.HandlerInterceptor;
+import org.springframework.web.servlet.ModelAndView;
+
+import jakarta.servlet.http.HttpServletRequest;
+import jakarta.servlet.http.HttpServletResponse;
+
+public class CleanUrlInterceptor implements HandlerInterceptor {
+
+    private static final List<String> ALLOWED_PARAMS =
+            Arrays.asList(
+                    "lang", "endpoint", "endpoints", "logout", "error", "file", "messageType");
+
+    @Override
+    public boolean preHandle(
+            HttpServletRequest request, HttpServletResponse response, Object handler)
+            throws Exception {
+        String queryString = request.getQueryString();
+        if (queryString != null && !queryString.isEmpty()) {
+            String requestURI = request.getRequestURI();
+            Map<String, String> parameters = new HashMap<>();
+
+            // Keep only the allowed parameters
+            String[] queryParameters = queryString.split("&");
+            for (String param : queryParameters) {
+                String[] keyValue = param.split("=");
+                if (keyValue.length != 2) {
+                    continue;
+                }
+                if (ALLOWED_PARAMS.contains(keyValue[0])) {
+                    parameters.put(keyValue[0], keyValue[1]);
+                }
+            }
+
+            // If there are any parameters that are not allowed
+            if (parameters.size() != queryParameters.length) {
+                // Construct new query string
+                StringBuilder newQueryString = new StringBuilder();
+                for (Map.Entry<String, String> entry : parameters.entrySet()) {
+                    if (newQueryString.length() > 0) {
+                        newQueryString.append("&");
+                    }
+                    newQueryString.append(entry.getKey()).append("=").append(entry.getValue());
+                }
+
+                // Redirect to the URL with only allowed query parameters
+                String redirectUrl = requestURI + "?" + newQueryString;
+                response.sendRedirect(redirectUrl);
+                return false;
+            }
+        }
+        return true;
+    }
+
+    @Override
+    public void postHandle(
+            HttpServletRequest request,
+            HttpServletResponse response,
+            Object handler,
+            ModelAndView modelAndView) {}
+
+    @Override
+    public void afterCompletion(
+            HttpServletRequest request,
+            HttpServletResponse response,
+            Object handler,
+            Exception ex) {}
+}

src/main/java/stirling/software/SPDF/config/ConfigInitializer.java

@@ -0,0 +1,143 @@
+package stirling.software.SPDF.config;
+
+import java.io.BufferedReader;
+import java.io.FileNotFoundException;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.InputStreamReader;
+import java.nio.charset.StandardCharsets;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Optional;
+import java.util.Set;
+import java.util.function.Function;
+import java.util.stream.Collectors;
+
+import org.springframework.context.ApplicationContextInitializer;
+import org.springframework.context.ConfigurableApplicationContext;
+
+public class ConfigInitializer
+        implements ApplicationContextInitializer<ConfigurableApplicationContext> {
+
+    @Override
+    public void initialize(ConfigurableApplicationContext applicationContext) {
+        try {
+            ensureConfigExists();
+        } catch (IOException e) {
+            throw new RuntimeException("Failed to initialize application configuration", e);
+        }
+    }
+
+    public void ensureConfigExists() throws IOException {
+        // Define the path to the external config directory
+        Path destPath = Paths.get("configs", "settings.yml");
+
+        // Check if the file already exists
+        if (Files.notExists(destPath)) {
+            // Ensure the destination directory exists
+            Files.createDirectories(destPath.getParent());
+
+            // Copy the resource from classpath to the external directory
+            try (InputStream in =
+                    getClass().getClassLoader().getResourceAsStream("settings.yml.template")) {
+                if (in != null) {
+                    Files.copy(in, destPath);
+                } else {
+                    throw new FileNotFoundException(
+                            "Resource file not found: settings.yml.template");
+                }
+            }
+        } else {
+            // If user file exists, we need to merge it with the template from the classpath
+            List<String> templateLines;
+            try (InputStream in =
+                    getClass().getClassLoader().getResourceAsStream("settings.yml.template")) {
+                templateLines =
+                        new BufferedReader(new InputStreamReader(in, StandardCharsets.UTF_8))
+                                .lines()
+                                .collect(Collectors.toList());
+            }
+
+            mergeYamlFiles(templateLines, destPath, destPath);
+        }
+    }
+
+    public void mergeYamlFiles(List<String> templateLines, Path userFilePath, Path outputPath)
+            throws IOException {
+        List<String> userLines = Files.readAllLines(userFilePath);
+        List<String> mergedLines = new ArrayList<>();
+        boolean insideAutoGenerated = false;
+        boolean beforeFirstKey = true;
+
+        Function<String, Boolean> isCommented = line -> line.trim().startsWith("#");
+        Function<String, String> extractKey =
+                line -> {
+                    String[] parts = line.split(":");
+                    return parts.length > 0 ? parts[0].trim().replace("#", "").trim() : "";
+                };
+
+        Set<String> userKeys = userLines.stream().map(extractKey).collect(Collectors.toSet());
+
+        for (String line : templateLines) {
+            String key = extractKey.apply(line);
+
+            if (line.trim().equalsIgnoreCase("AutomaticallyGenerated:")) {
+                insideAutoGenerated = true;
+                mergedLines.add(line);
+                continue;
+            } else if (insideAutoGenerated && line.trim().isEmpty()) {
+                insideAutoGenerated = false;
+                mergedLines.add(line);
+                continue;
+            }
+
+            if (beforeFirstKey && (isCommented.apply(line) || line.trim().isEmpty())) {
+                // Handle top comments and empty lines before the first key.
+                mergedLines.add(line);
+                continue;
+            }
+
+            if (!key.isEmpty()) beforeFirstKey = false;
+
+            if (userKeys.contains(key)) {
+                // If user has any version (commented or uncommented) of this key, skip the
+                // template line
+                Optional<String> userValue =
+                        userLines.stream()
+                                .filter(
+                                        l ->
+                                                extractKey.apply(l).equalsIgnoreCase(key)
+                                                        && !isCommented.apply(l))
+                                .findFirst();
+                if (userValue.isPresent()) mergedLines.add(userValue.get());
+                continue;
+            }
+
+            if (isCommented.apply(line) || line.trim().isEmpty() || !userKeys.contains(key)) {
+                mergedLines.add(
+                        line); // If line is commented, empty or key not present in user's file,
+                // retain the
+                // template line
+                continue;
+            }
+        }
+
+        // Add any additional uncommented user lines that are not present in the
+        // template
+        for (String userLine : userLines) {
+            String userKey = extractKey.apply(userLine);
+            boolean isPresentInTemplate =
+                    templateLines.stream()
+                            .map(extractKey)
+                            .anyMatch(templateKey -> templateKey.equalsIgnoreCase(userKey));
+            if (!isPresentInTemplate && !isCommented.apply(userLine)) {
+                mergedLines.add(userLine);
+            }
+        }
+
+        Files.write(outputPath, mergedLines, StandardCharsets.UTF_8);
+    }
+}

src/main/java/stirling/software/SPDF/config/EndpointConfiguration.java

@@ -0,0 +1,247 @@
+package stirling.software.SPDF.config;
+
+import java.util.HashSet;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+import java.util.concurrent.ConcurrentHashMap;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.beans.factory.annotation.Qualifier;
+import org.springframework.context.annotation.DependsOn;
+import org.springframework.stereotype.Service;
+
+import stirling.software.SPDF.model.ApplicationProperties;
+
+@Service
+@DependsOn({"bookFormatsInstalled"})
+public class EndpointConfiguration {
+    private static final Logger logger = LoggerFactory.getLogger(EndpointConfiguration.class);
+    private Map<String, Boolean> endpointStatuses = new ConcurrentHashMap<>();
+    private Map<String, Set<String>> endpointGroups = new ConcurrentHashMap<>();
+
+    private final ApplicationProperties applicationProperties;
+
+    private boolean bookFormatsInstalled;
+
+    @Autowired
+    public EndpointConfiguration(
+            ApplicationProperties applicationProperties,
+            @Qualifier("bookFormatsInstalled") boolean bookFormatsInstalled) {
+        this.applicationProperties = applicationProperties;
+        this.bookFormatsInstalled = bookFormatsInstalled;
+        init();
+        processEnvironmentConfigs();
+    }
+
+    public void enableEndpoint(String endpoint) {
+        endpointStatuses.put(endpoint, true);
+    }
+
+    public void disableEndpoint(String endpoint) {
+        if (!endpointStatuses.containsKey(endpoint) || endpointStatuses.get(endpoint) != false) {
+            logger.info("Disabling {}", endpoint);
+            endpointStatuses.put(endpoint, false);
+        }
+    }
+
+    public boolean isEndpointEnabled(String endpoint) {
+        if (endpoint.startsWith("/")) {
+            endpoint = endpoint.substring(1);
+        }
+        return endpointStatuses.getOrDefault(endpoint, true);
+    }
+
+    public void addEndpointToGroup(String group, String endpoint) {
+        endpointGroups.computeIfAbsent(group, k -> new HashSet<>()).add(endpoint);
+    }
+
+    public void enableGroup(String group) {
+        Set<String> endpoints = endpointGroups.get(group);
+        if (endpoints != null) {
+            for (String endpoint : endpoints) {
+                enableEndpoint(endpoint);
+            }
+        }
+    }
+
+    public void disableGroup(String group) {
+        Set<String> endpoints = endpointGroups.get(group);
+        if (endpoints != null) {
+            for (String endpoint : endpoints) {
+                disableEndpoint(endpoint);
+            }
+        }
+    }
+
+    public void init() {
+        // Adding endpoints to "PageOps" group
+        addEndpointToGroup("PageOps", "remove-pages");
+        addEndpointToGroup("PageOps", "merge-pdfs");
+        addEndpointToGroup("PageOps", "split-pdfs");
+        addEndpointToGroup("PageOps", "pdf-organizer");
+        addEndpointToGroup("PageOps", "rotate-pdf");
+        addEndpointToGroup("PageOps", "multi-page-layout");
+        addEndpointToGroup("PageOps", "scale-pages");
+        addEndpointToGroup("PageOps", "adjust-contrast");
+        addEndpointToGroup("PageOps", "crop");
+        addEndpointToGroup("PageOps", "auto-split-pdf");
+        addEndpointToGroup("PageOps", "extract-page");
+        addEndpointToGroup("PageOps", "pdf-to-single-page");
+        addEndpointToGroup("PageOps", "split-by-size-or-count");
+        addEndpointToGroup("PageOps", "overlay-pdf");
+        addEndpointToGroup("PageOps", "split-pdf-by-sections");
+
+        // Adding endpoints to "Convert" group
+        addEndpointToGroup("Convert", "pdf-to-img");
+        addEndpointToGroup("Convert", "img-to-pdf");
+        addEndpointToGroup("Convert", "pdf-to-pdfa");
+        addEndpointToGroup("Convert", "file-to-pdf");
+        addEndpointToGroup("Convert", "xlsx-to-pdf");
+        addEndpointToGroup("Convert", "pdf-to-word");
+        addEndpointToGroup("Convert", "pdf-to-presentation");
+        addEndpointToGroup("Convert", "pdf-to-text");
+        addEndpointToGroup("Convert", "pdf-to-html");
+        addEndpointToGroup("Convert", "pdf-to-xml");
+        addEndpointToGroup("Convert", "html-to-pdf");
+        addEndpointToGroup("Convert", "url-to-pdf");
+        addEndpointToGroup("Convert", "markdown-to-pdf");
+        addEndpointToGroup("Convert", "pdf-to-csv");
+
+        // Adding endpoints to "Security" group
+        addEndpointToGroup("Security", "add-password");
+        addEndpointToGroup("Security", "remove-password");
+        addEndpointToGroup("Security", "change-permissions");
+        addEndpointToGroup("Security", "add-watermark");
+        addEndpointToGroup("Security", "cert-sign");
+        addEndpointToGroup("Security", "sanitize-pdf");
+        addEndpointToGroup("Security", "auto-redact");
+
+        // Adding endpoints to "Other" group
+        addEndpointToGroup("Other", "ocr-pdf");
+        addEndpointToGroup("Other", "add-image");
+        addEndpointToGroup("Other", "compress-pdf");
+        addEndpointToGroup("Other", "extract-images");
+        addEndpointToGroup("Other", "change-metadata");
+        addEndpointToGroup("Other", "extract-image-scans");
+        addEndpointToGroup("Other", "sign");
+        addEndpointToGroup("Other", "flatten");
+        addEndpointToGroup("Other", "repair");
+        addEndpointToGroup("Other", "remove-blanks");
+        addEndpointToGroup("Other", "remove-annotations");
+        addEndpointToGroup("Other", "compare");
+        addEndpointToGroup("Other", "add-page-numbers");
+        addEndpointToGroup("Other", "auto-rename");
+        addEndpointToGroup("Other", "get-info-on-pdf");
+        addEndpointToGroup("Other", "show-javascript");
+
+        // CLI
+        addEndpointToGroup("CLI", "compress-pdf");
+        addEndpointToGroup("CLI", "extract-image-scans");
+        addEndpointToGroup("CLI", "remove-blanks");
+        addEndpointToGroup("CLI", "repair");
+        addEndpointToGroup("CLI", "pdf-to-pdfa");
+        addEndpointToGroup("CLI", "file-to-pdf");
+        addEndpointToGroup("CLI", "xlsx-to-pdf");
+        addEndpointToGroup("CLI", "pdf-to-word");
+        addEndpointToGroup("CLI", "pdf-to-presentation");
+        addEndpointToGroup("CLI", "pdf-to-text");
+        addEndpointToGroup("CLI", "pdf-to-html");
+        addEndpointToGroup("CLI", "pdf-to-xml");
+        addEndpointToGroup("CLI", "ocr-pdf");
+        addEndpointToGroup("CLI", "html-to-pdf");
+        addEndpointToGroup("CLI", "url-to-pdf");
+        addEndpointToGroup("CLI", "book-to-pdf");
+        addEndpointToGroup("CLI", "pdf-to-book");
+
+        // Calibre
+        addEndpointToGroup("Calibre", "book-to-pdf");
+        addEndpointToGroup("Calibre", "pdf-to-book");
+
+        // python
+        addEndpointToGroup("Python", "extract-image-scans");
+        addEndpointToGroup("Python", "remove-blanks");
+        addEndpointToGroup("Python", "html-to-pdf");
+        addEndpointToGroup("Python", "url-to-pdf");
+
+        // openCV
+        addEndpointToGroup("OpenCV", "extract-image-scans");
+        addEndpointToGroup("OpenCV", "remove-blanks");
+
+        // LibreOffice
+        addEndpointToGroup("LibreOffice", "repair");
+        addEndpointToGroup("LibreOffice", "file-to-pdf");
+        addEndpointToGroup("LibreOffice", "xlsx-to-pdf");
+        addEndpointToGroup("LibreOffice", "pdf-to-word");
+        addEndpointToGroup("LibreOffice", "pdf-to-presentation");
+        addEndpointToGroup("LibreOffice", "pdf-to-text");
+        addEndpointToGroup("LibreOffice", "pdf-to-html");
+        addEndpointToGroup("LibreOffice", "pdf-to-xml");
+
+        // OCRmyPDF
+        addEndpointToGroup("OCRmyPDF", "compress-pdf");
+        addEndpointToGroup("OCRmyPDF", "pdf-to-pdfa");
+        addEndpointToGroup("OCRmyPDF", "ocr-pdf");
+
+        // Java
+        addEndpointToGroup("Java", "merge-pdfs");
+        addEndpointToGroup("Java", "remove-pages");
+        addEndpointToGroup("Java", "split-pdfs");
+        addEndpointToGroup("Java", "pdf-organizer");
+        addEndpointToGroup("Java", "rotate-pdf");
+        addEndpointToGroup("Java", "pdf-to-img");
+        addEndpointToGroup("Java", "img-to-pdf");
+        addEndpointToGroup("Java", "add-password");
+        addEndpointToGroup("Java", "remove-password");
+        addEndpointToGroup("Java", "change-permissions");
+        addEndpointToGroup("Java", "add-watermark");
+        addEndpointToGroup("Java", "add-image");
+        addEndpointToGroup("Java", "extract-images");
+        addEndpointToGroup("Java", "change-metadata");
+        addEndpointToGroup("Java", "cert-sign");
+        addEndpointToGroup("Java", "multi-page-layout");
+        addEndpointToGroup("Java", "scale-pages");
+        addEndpointToGroup("Java", "add-page-numbers");
+        addEndpointToGroup("Java", "auto-rename");
+        addEndpointToGroup("Java", "auto-split-pdf");
+        addEndpointToGroup("Java", "sanitize-pdf");
+        addEndpointToGroup("Java", "crop");
+        addEndpointToGroup("Java", "get-info-on-pdf");
+        addEndpointToGroup("Java", "extract-page");
+        addEndpointToGroup("Java", "pdf-to-single-page");
+        addEndpointToGroup("Java", "markdown-to-pdf");
+        addEndpointToGroup("Java", "show-javascript");
+        addEndpointToGroup("Java", "auto-redact");
+        addEndpointToGroup("Java", "pdf-to-csv");
+        addEndpointToGroup("Java", "split-by-size-or-count");
+        addEndpointToGroup("Java", "overlay-pdf");
+        addEndpointToGroup("Java", "split-pdf-by-sections");
+
+        // Javascript
+        addEndpointToGroup("Javascript", "pdf-organizer");
+        addEndpointToGroup("Javascript", "sign");
+        addEndpointToGroup("Javascript", "compare");
+        addEndpointToGroup("Javascript", "adjust-contrast");
+    }
+
+    private void processEnvironmentConfigs() {
+        List<String> endpointsToRemove = applicationProperties.getEndpoints().getToRemove();
+        List<String> groupsToRemove = applicationProperties.getEndpoints().getGroupsToRemove();
+        if (!bookFormatsInstalled) {
+            groupsToRemove.add("Calibre");
+        }
+        if (endpointsToRemove != null) {
+            for (String endpoint : endpointsToRemove) {
+                disableEndpoint(endpoint.trim());
+            }
+        }
+
+        if (groupsToRemove != null) {
+            for (String group : groupsToRemove) {
+                disableGroup(group.trim());
+            }
+        }
+    }
+}

src/main/java/stirling/software/SPDF/config/EndpointInterceptor.java

@@ -0,0 +1,26 @@
+package stirling.software.SPDF.config;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.stereotype.Component;
+import org.springframework.web.servlet.HandlerInterceptor;
+
+import jakarta.servlet.http.HttpServletRequest;
+import jakarta.servlet.http.HttpServletResponse;
+
+@Component
+public class EndpointInterceptor implements HandlerInterceptor {
+
+    @Autowired private EndpointConfiguration endpointConfiguration;
+
+    @Override
+    public boolean preHandle(
+            HttpServletRequest request, HttpServletResponse response, Object handler)
+            throws Exception {
+        String requestURI = request.getRequestURI();
+        if (!endpointConfiguration.isEndpointEnabled(requestURI)) {
+            response.sendError(HttpServletResponse.SC_FORBIDDEN, "This endpoint is disabled");
+            return false;
+        }
+        return true;
+    }
+}

src/main/java/stirling/software/SPDF/config/MetricsConfig.java

@@ -0,0 +1,25 @@
+package stirling.software.SPDF.config;
+
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+import io.micrometer.core.instrument.Meter;
+import io.micrometer.core.instrument.config.MeterFilter;
+import io.micrometer.core.instrument.config.MeterFilterReply;
+
+@Configuration
+public class MetricsConfig {
+
+    @Bean
+    public MeterFilter meterFilter() {
+        return new MeterFilter() {
+            @Override
+            public MeterFilterReply accept(Meter.Id id) {
+                if (id.getName().equals("http.requests")) {
+                    return MeterFilterReply.NEUTRAL;
+                }
+                return MeterFilterReply.DENY;
+            }
+        };
+    }
+}

src/main/java/stirling/software/SPDF/config/MetricsFilter.java

@@ -0,0 +1,64 @@
+package stirling.software.SPDF.config;
+
+import java.io.IOException;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.stereotype.Component;
+import org.springframework.web.filter.OncePerRequestFilter;
+
+import io.micrometer.core.instrument.Counter;
+import io.micrometer.core.instrument.MeterRegistry;
+
+import jakarta.servlet.FilterChain;
+import jakarta.servlet.ServletException;
+import jakarta.servlet.http.HttpServletRequest;
+import jakarta.servlet.http.HttpServletResponse;
+
+@Component
+public class MetricsFilter extends OncePerRequestFilter {
+
+    private final MeterRegistry meterRegistry;
+
+    @Autowired
+    public MetricsFilter(MeterRegistry meterRegistry) {
+        this.meterRegistry = meterRegistry;
+    }
+
+    @Override
+    protected void doFilterInternal(
+            HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)
+            throws ServletException, IOException {
+        String uri = request.getRequestURI();
+
+        // System.out.println("uri="+uri + ", method=" + request.getMethod() );
+        // Ignore static resources
+        if (!(uri.startsWith("/js")
+                || uri.startsWith("/v1/api-docs")
+                || uri.endsWith("robots.txt")
+                || uri.startsWith("/images")
+                || uri.startsWith("/images")
+                || uri.endsWith(".png")
+                || uri.endsWith(".ico")
+                || uri.endsWith(".css")
+                || uri.endsWith(".map")
+                || uri.endsWith(".svg")
+                || uri.endsWith(".js")
+                || uri.contains("swagger")
+                || uri.startsWith("/api/v1/info")
+                || uri.startsWith("/site.webmanifest")
+                || uri.startsWith("/fonts")
+                || uri.startsWith("/pdfjs"))) {
+
+            Counter counter =
+                    Counter.builder("http.requests")
+                            .tag("uri", uri)
+                            .tag("method", request.getMethod())
+                            .register(meterRegistry);
+
+            counter.increment();
+            // System.out.println("Counted");
+        }
+
+        filterChain.doFilter(request, response);
+    }
+}

src/main/java/stirling/software/SPDF/config/OpenApiConfig.java

@@ -0,0 +1,53 @@
+package stirling.software.SPDF.config;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+import io.swagger.v3.oas.models.Components;
+import io.swagger.v3.oas.models.OpenAPI;
+import io.swagger.v3.oas.models.info.Info;
+import io.swagger.v3.oas.models.security.SecurityRequirement;
+import io.swagger.v3.oas.models.security.SecurityScheme;
+
+import stirling.software.SPDF.model.ApplicationProperties;
+
+@Configuration
+public class OpenApiConfig {
+
+    @Autowired ApplicationProperties applicationProperties;
+
+    @Bean
+    public OpenAPI customOpenAPI() {
+        String version = getClass().getPackage().getImplementationVersion();
+        if (version == null) {
+            version = "1.0.0"; // default version if all else fails
+        }
+
+        SecurityScheme apiKeyScheme =
+                new SecurityScheme()
+                        .type(SecurityScheme.Type.APIKEY)
+                        .in(SecurityScheme.In.HEADER)
+                        .name("X-API-KEY");
+        if (!applicationProperties.getSecurity().getEnableLogin()) {
+            return new OpenAPI()
+                    .components(new Components())
+                    .info(
+                            new Info()
+                                    .title("Stirling PDF API")
+                                    .version(version)
+                                    .description(
+                                            "API documentation for all Server-Side processing.\nPlease note some functionality might be UI only and missing from here."));
+        } else {
+            return new OpenAPI()
+                    .components(new Components().addSecuritySchemes("apiKey", apiKeyScheme))
+                    .info(
+                            new Info()
+                                    .title("Stirling PDF API")
+                                    .version(version)
+                                    .description(
+                                            "API documentation for all Server-Side processing.\nPlease note some functionality might be UI only and missing from here."))
+                    .addSecurityItem(new SecurityRequirement().addList("apiKey"));
+        }
+    }
+}

src/main/java/stirling/software/SPDF/config/PostStartupProcesses.java

@@ -0,0 +1,98 @@
+package stirling.software.SPDF.config;
+
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.List;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.beans.factory.annotation.Qualifier;
+import org.springframework.stereotype.Component;
+
+import jakarta.annotation.PostConstruct;
+import stirling.software.SPDF.model.ApplicationProperties;
+import stirling.software.SPDF.utils.ProcessExecutor;
+import stirling.software.SPDF.utils.ProcessExecutor.ProcessExecutorResult;
+
+@Component
+public class PostStartupProcesses {
+
+    @Autowired ApplicationProperties applicationProperties;
+
+    @Autowired
+    @Qualifier("RunningInDocker")
+    private boolean runningInDocker;
+
+    @Autowired
+    @Qualifier("bookFormatsInstalled")
+    private boolean bookFormatsInstalled;
+
+    @Autowired
+    @Qualifier("htmlFormatsInstalled")
+    private boolean htmlFormatsInstalled;
+
+    private static final Logger logger = LoggerFactory.getLogger(PostStartupProcesses.class);
+
+    @PostConstruct
+    public void runInstallCommandBasedOnEnvironment() throws IOException, InterruptedException {
+        List<List<String>> commands = new ArrayList<>();
+        // Checking for DOCKER_INSTALL_BOOK_FORMATS environment variable
+        if (bookFormatsInstalled) {
+            List<String> tmpList = new ArrayList<>();
+            // Set up the timezone configuration commands
+            tmpList.addAll(
+                    Arrays.asList(
+                            "sh",
+                            "-c",
+                            "echo 'tzdata tzdata/Areas select Europe' | debconf-set-selections; "
+                                    + "echo 'tzdata tzdata/Zones/Europe select Berlin' | debconf-set-selections"));
+            commands.add(tmpList);
+
+            // Install calibre with DEBIAN_FRONTEND set to noninteractive
+            tmpList = new ArrayList<>();
+            tmpList.addAll(
+                    Arrays.asList(
+                            "sh",
+                            "-c",
+                            "DEBIAN_FRONTEND=noninteractive apt-get install -y --no-install-recommends calibre"));
+            commands.add(tmpList);
+        }
+
+        // Checking for DOCKER_INSTALL_HTML_FORMATS environment variable
+        if (htmlFormatsInstalled) {
+            List<String> tmpList = new ArrayList<>();
+            // Add -y flag for automatic yes to prompts and --no-install-recommends to reduce size
+            tmpList.addAll(
+                    Arrays.asList(
+                            "apt-get", "install", "wkhtmltopdf", "-y", "--no-install-recommends"));
+            commands.add(tmpList);
+        }
+
+        if (!commands.isEmpty()) {
+            // Run the command
+            if (runningInDocker) {
+                List<String> tmpList = new ArrayList<>();
+                tmpList.addAll(Arrays.asList("apt-get", "update"));
+                commands.add(0, tmpList);
+
+                for (List<String> list : commands) {
+                    ProcessExecutorResult returnCode =
+                            ProcessExecutor.getInstance(ProcessExecutor.Processes.INSTALL_APP, true)
+                                    .runCommandWithOutputHandling(list);
+                    logger.info("RC for app installs {}", returnCode.getRc());
+                }
+            } else {
+
+                logger.info(
+                        "Not running inside Docker so skipping automated install process with command.");
+            }
+
+        } else {
+            if (runningInDocker) {
+                logger.info("No custom apps to install.");
+            }
+        }
+    }
+}

src/main/java/stirling/software/SPDF/config/StartupApplicationListener.java

@@ -0,0 +1,18 @@
+package stirling.software.SPDF.config;
+
+import java.time.LocalDateTime;
+
+import org.springframework.context.ApplicationListener;
+import org.springframework.context.event.ContextRefreshedEvent;
+import org.springframework.stereotype.Component;
+
+@Component
+public class StartupApplicationListener implements ApplicationListener<ContextRefreshedEvent> {
+
+    public static LocalDateTime startTime;
+
+    @Override
+    public void onApplicationEvent(ContextRefreshedEvent event) {
+        startTime = LocalDateTime.now();
+    }
+}

src/main/java/stirling/software/SPDF/config/WebMvcConfig.java

@@ -0,0 +1,26 @@
+package stirling.software.SPDF.config;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
+import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
+import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
+
+@Configuration
+public class WebMvcConfig implements WebMvcConfigurer {
+
+    @Autowired private EndpointInterceptor endpointInterceptor;
+
+    @Override
+    public void addInterceptors(InterceptorRegistry registry) {
+        registry.addInterceptor(endpointInterceptor);
+    }
+
+    @Override
+    public void addResourceHandlers(ResourceHandlerRegistry registry) {
+        // Handler for external static resources
+        registry.addResourceHandler("/**")
+                .addResourceLocations("file:customFiles/static/", "classpath:/static/");
+        // .setCachePeriod(0); // Optional: disable caching
+    }
+}

src/main/java/stirling/software/SPDF/config/YamlPropertySourceFactory.java

@@ -0,0 +1,25 @@
+package stirling.software.SPDF.config;
+
+import java.io.IOException;
+import java.util.Properties;
+
+import org.springframework.beans.factory.config.YamlPropertiesFactoryBean;
+import org.springframework.core.env.PropertiesPropertySource;
+import org.springframework.core.env.PropertySource;
+import org.springframework.core.io.support.EncodedResource;
+import org.springframework.core.io.support.PropertySourceFactory;
+
+public class YamlPropertySourceFactory implements PropertySourceFactory {
+
+    @Override
+    public PropertySource<?> createPropertySource(String name, EncodedResource encodedResource)
+            throws IOException {
+        YamlPropertiesFactoryBean factory = new YamlPropertiesFactoryBean();
+        factory.setResources(encodedResource.getResource());
+
+        Properties properties = factory.getObject();
+
+        return new PropertiesPropertySource(
+                encodedResource.getResource().getFilename(), properties);
+    }
+}

src/main/java/stirling/software/SPDF/config/security/CustomAuthenticationFailureHandler.java

@@ -0,0 +1,49 @@
+package stirling.software.SPDF.config.security;
+
+import java.io.IOException;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.security.authentication.BadCredentialsException;
+import org.springframework.security.authentication.LockedException;
+import org.springframework.security.core.AuthenticationException;
+import org.springframework.security.web.authentication.SimpleUrlAuthenticationFailureHandler;
+import org.springframework.stereotype.Component;
+
+import jakarta.servlet.ServletException;
+import jakarta.servlet.http.HttpServletRequest;
+import jakarta.servlet.http.HttpServletResponse;
+
+@Component
+public class CustomAuthenticationFailureHandler extends SimpleUrlAuthenticationFailureHandler {
+
+    @Autowired private final LoginAttemptService loginAttemptService;
+
+    @Autowired
+    public CustomAuthenticationFailureHandler(LoginAttemptService loginAttemptService) {
+        this.loginAttemptService = loginAttemptService;
+    }
+
+    @Override
+    public void onAuthenticationFailure(
+            HttpServletRequest request,
+            HttpServletResponse response,
+            AuthenticationException exception)
+            throws IOException, ServletException {
+        String ip = request.getRemoteAddr();
+        logger.error("Failed login attempt from IP: " + ip);
+
+        String username = request.getParameter("username");
+        if (loginAttemptService.loginAttemptCheck(username)) {
+            setDefaultFailureUrl("/login?error=locked");
+
+        } else {
+            if (exception.getClass().isAssignableFrom(BadCredentialsException.class)) {
+                setDefaultFailureUrl("/login?error=badcredentials");
+            } else if (exception.getClass().isAssignableFrom(LockedException.class)) {
+                setDefaultFailureUrl("/login?error=locked");
+            }
+        }
+
+        super.onAuthenticationFailure(request, response, exception);
+    }
+}

src/main/java/stirling/software/SPDF/config/security/CustomAuthenticationSuccessHandler.java

@@ -0,0 +1,47 @@
+package stirling.software.SPDF.config.security;
+
+import java.io.IOException;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.security.core.Authentication;
+import org.springframework.security.web.authentication.SavedRequestAwareAuthenticationSuccessHandler;
+import org.springframework.security.web.savedrequest.SavedRequest;
+import org.springframework.stereotype.Component;
+
+import jakarta.servlet.ServletException;
+import jakarta.servlet.http.HttpServletRequest;
+import jakarta.servlet.http.HttpServletResponse;
+import jakarta.servlet.http.HttpSession;
+import stirling.software.SPDF.utils.RequestUriUtils;
+
+@Component
+public class CustomAuthenticationSuccessHandler
+        extends SavedRequestAwareAuthenticationSuccessHandler {
+
+    @Autowired private LoginAttemptService loginAttemptService;
+
+    @Override
+    public void onAuthenticationSuccess(
+            HttpServletRequest request, HttpServletResponse response, Authentication authentication)
+            throws ServletException, IOException {
+        String username = request.getParameter("username");
+        loginAttemptService.loginSucceeded(username);
+
+        // Get the saved request
+        HttpSession session = request.getSession(false);
+        SavedRequest savedRequest =
+                session != null
+                        ? (SavedRequest) session.getAttribute("SPRING_SECURITY_SAVED_REQUEST")
+                        : null;
+        if (savedRequest != null
+                && !RequestUriUtils.isStaticResource(savedRequest.getRedirectUrl())) {
+            // Redirect to the original destination
+            super.onAuthenticationSuccess(request, response, authentication);
+        } else {
+            // Redirect to the root URL (considering context path)
+            getRedirectStrategy().sendRedirect(request, response, "/");
+        }
+
+        // super.onAuthenticationSuccess(request, response, authentication);
+    }
+}

src/main/java/stirling/software/SPDF/config/security/CustomUserDetailsService.java

@@ -0,0 +1,57 @@
+package stirling.software.SPDF.config.security;
+
+import java.util.Collection;
+import java.util.Set;
+import java.util.stream.Collectors;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.security.authentication.LockedException;
+import org.springframework.security.core.GrantedAuthority;
+import org.springframework.security.core.authority.SimpleGrantedAuthority;
+import org.springframework.security.core.userdetails.UserDetails;
+import org.springframework.security.core.userdetails.UserDetailsService;
+import org.springframework.security.core.userdetails.UsernameNotFoundException;
+import org.springframework.stereotype.Service;
+
+import stirling.software.SPDF.model.Authority;
+import stirling.software.SPDF.model.User;
+import stirling.software.SPDF.repository.UserRepository;
+
+@Service
+public class CustomUserDetailsService implements UserDetailsService {
+
+    @Autowired private UserRepository userRepository;
+
+    @Autowired private LoginAttemptService loginAttemptService;
+
+    @Override
+    public UserDetails loadUserByUsername(String username) throws UsernameNotFoundException {
+        User user =
+                userRepository
+                        .findByUsername(username)
+                        .orElseThrow(
+                                () ->
+                                        new UsernameNotFoundException(
+                                                "No user found with username: " + username));
+
+        if (loginAttemptService.isBlocked(username)) {
+            throw new LockedException(
+                    "Your account has been locked due to too many failed login attempts.");
+        }
+
+        return new org.springframework.security.core.userdetails.User(
+                user.getUsername(),
+                user.getPassword(),
+                user.isEnabled(),
+                true,
+                true,
+                true,
+                getAuthorities(user.getAuthorities()));
+    }
+
+    private Collection<? extends GrantedAuthority> getAuthorities(Set<Authority> authorities) {
+        return authorities.stream()
+                .map(authority -> new SimpleGrantedAuthority(authority.getAuthority()))
+                .collect(Collectors.toList());
+    }
+}

src/main/java/stirling/software/SPDF/config/security/FirstLoginFilter.java

@@ -0,0 +1,53 @@
+package stirling.software.SPDF.config.security;
+
+import java.io.IOException;
+import java.util.Optional;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.context.annotation.Lazy;
+import org.springframework.security.core.Authentication;
+import org.springframework.security.core.context.SecurityContextHolder;
+import org.springframework.stereotype.Component;
+import org.springframework.web.filter.OncePerRequestFilter;
+
+import jakarta.servlet.FilterChain;
+import jakarta.servlet.ServletException;
+import jakarta.servlet.http.HttpServletRequest;
+import jakarta.servlet.http.HttpServletResponse;
+import stirling.software.SPDF.model.User;
+import stirling.software.SPDF.utils.RequestUriUtils;
+
+@Component
+public class FirstLoginFilter extends OncePerRequestFilter {
+
+    @Autowired @Lazy private UserService userService;
+
+    @Override
+    protected void doFilterInternal(
+            HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)
+            throws ServletException, IOException {
+        String method = request.getMethod();
+        String requestURI = request.getRequestURI();
+        // Check if the request is for static resources
+        boolean isStaticResource = RequestUriUtils.isStaticResource(requestURI);
+
+        // If it's a static resource, just continue the filter chain and skip the logic below
+        if (isStaticResource) {
+            filterChain.doFilter(request, response);
+            return;
+        }
+
+        Authentication authentication = SecurityContextHolder.getContext().getAuthentication();
+        if (authentication != null && authentication.isAuthenticated()) {
+            Optional<User> user = userService.findByUsername(authentication.getName());
+            if ("GET".equalsIgnoreCase(method)
+                    && user.isPresent()
+                    && user.get().isFirstLogin()
+                    && !"/change-creds".equals(requestURI)) {
+                response.sendRedirect("/change-creds");
+                return;
+            }
+        }
+        filterChain.doFilter(request, response);
+    }
+}

src/main/java/stirling/software/SPDF/config/security/IPRateLimitingFilter.java

@@ -0,0 +1,68 @@
+package stirling.software.SPDF.config.security;
+
+import java.io.IOException;
+import java.util.concurrent.ConcurrentHashMap;
+import java.util.concurrent.atomic.AtomicInteger;
+
+import jakarta.servlet.Filter;
+import jakarta.servlet.FilterChain;
+import jakarta.servlet.ServletException;
+import jakarta.servlet.ServletRequest;
+import jakarta.servlet.ServletResponse;
+import jakarta.servlet.http.HttpServletRequest;
+import stirling.software.SPDF.utils.RequestUriUtils;
+
+public class IPRateLimitingFilter implements Filter {
+
+    private final ConcurrentHashMap<String, AtomicInteger> requestCounts =
+            new ConcurrentHashMap<>();
+    private final ConcurrentHashMap<String, AtomicInteger> getCounts = new ConcurrentHashMap<>();
+    private final int maxRequests;
+    private final int maxGetRequests;
+
+    public IPRateLimitingFilter(int maxRequests, int maxGetRequests) {
+        this.maxRequests = maxRequests;
+        this.maxGetRequests = maxGetRequests;
+    }
+
+    @Override
+    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
+            throws IOException, ServletException {
+        if (request instanceof HttpServletRequest) {
+            HttpServletRequest httpRequest = (HttpServletRequest) request;
+            String method = httpRequest.getMethod();
+            String requestURI = httpRequest.getRequestURI();
+            // Check if the request is for static resources
+            boolean isStaticResource = RequestUriUtils.isStaticResource(requestURI);
+
+            // If it's a static resource, just continue the filter chain and skip the logic below
+            if (isStaticResource) {
+                chain.doFilter(request, response);
+                return;
+            }
+
+            String clientIp = request.getRemoteAddr();
+            requestCounts.computeIfAbsent(clientIp, k -> new AtomicInteger(0));
+            if (!"GET".equalsIgnoreCase(method)) {
+
+                if (requestCounts.get(clientIp).incrementAndGet() > maxRequests) {
+                    // Handle limit exceeded (e.g., send error response)
+                    response.getWriter().write("Rate limit exceeded");
+                    return;
+                }
+            } else {
+                if (requestCounts.get(clientIp).incrementAndGet() > maxGetRequests) {
+                    // Handle limit exceeded (e.g., send error response)
+                    response.getWriter().write("GET Rate limit exceeded");
+                    return;
+                }
+            }
+        }
+        chain.doFilter(request, response);
+    }
+
+    public void resetRequestCounts() {
+        requestCounts.clear();
+        getCounts.clear();
+    }
+}

src/main/java/stirling/software/SPDF/config/security/InitialSecuritySetup.java

@@ -0,0 +1,88 @@
+package stirling.software.SPDF.config.security;
+
+import java.io.IOException;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.util.List;
+import java.util.UUID;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.stereotype.Component;
+
+import jakarta.annotation.PostConstruct;
+import stirling.software.SPDF.model.ApplicationProperties;
+import stirling.software.SPDF.model.Role;
+
+@Component
+public class InitialSecuritySetup {
+
+    @Autowired private UserService userService;
+
+    @Autowired ApplicationProperties applicationProperties;
+
+    @PostConstruct
+    public void init() {
+        if (!userService.hasUsers()) {
+
+            String initialUsername =
+                    applicationProperties.getSecurity().getInitialLogin().getUsername();
+            String initialPassword =
+                    applicationProperties.getSecurity().getInitialLogin().getPassword();
+            if (initialUsername != null && initialPassword != null) {
+                userService.saveUser(initialUsername, initialPassword, Role.ADMIN.getRoleId());
+            } else {
+                initialUsername = "admin";
+                initialPassword = "stirling";
+                userService.saveUser(
+                        initialUsername, initialPassword, Role.ADMIN.getRoleId(), true);
+            }
+        }
+        if (!userService.usernameExists(Role.INTERNAL_API_USER.getRoleId())) {
+            userService.saveUser(
+                    Role.INTERNAL_API_USER.getRoleId(),
+                    UUID.randomUUID().toString(),
+                    Role.INTERNAL_API_USER.getRoleId());
+            userService.addApiKeyToUser(Role.INTERNAL_API_USER.getRoleId());
+        }
+    }
+
+    @PostConstruct
+    public void initSecretKey() throws IOException {
+        String secretKey = applicationProperties.getAutomaticallyGenerated().getKey();
+        if (secretKey == null || secretKey.isEmpty()) {
+            secretKey = UUID.randomUUID().toString(); // Generating a random UUID as the secret key
+            saveKeyToConfig(secretKey);
+        }
+    }
+
+    private void saveKeyToConfig(String key) throws IOException {
+        Path path = Paths.get("configs", "settings.yml"); // Target the configs/settings.yml
+        List<String> lines = Files.readAllLines(path);
+        boolean keyFound = false;
+
+        // Search for the existing key to replace it or place to add it
+        for (int i = 0; i < lines.size(); i++) {
+            if (lines.get(i).startsWith("AutomaticallyGenerated:")) {
+                keyFound = true;
+                if (i + 1 < lines.size() && lines.get(i + 1).trim().startsWith("key:")) {
+                    lines.set(i + 1, "  key: " + key);
+                    break;
+                } else {
+                    lines.add(i + 1, "  key: " + key);
+                    break;
+                }
+            }
+        }
+
+        // If the section doesn't exist, append it
+        if (!keyFound) {
+            lines.add("# Automatically Generated Settings (Do Not Edit Directly)");
+            lines.add("AutomaticallyGenerated:");
+            lines.add("  key: " + key);
+        }
+
+        // Write back to the file
+        Files.write(path, lines);
+    }
+}

src/main/java/stirling/software/SPDF/config/security/LoginAttemptService.java

@@ -0,0 +1,58 @@
+package stirling.software.SPDF.config.security;
+
+import java.util.concurrent.ConcurrentHashMap;
+import java.util.concurrent.TimeUnit;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.stereotype.Service;
+
+import jakarta.annotation.PostConstruct;
+import stirling.software.SPDF.model.ApplicationProperties;
+import stirling.software.SPDF.model.AttemptCounter;
+
+@Service
+public class LoginAttemptService {
+
+    @Autowired ApplicationProperties applicationProperties;
+
+    private int MAX_ATTEMPTS;
+    private long ATTEMPT_INCREMENT_TIME;
+
+    @PostConstruct
+    public void init() {
+        MAX_ATTEMPTS = applicationProperties.getSecurity().getLoginAttemptCount();
+        ATTEMPT_INCREMENT_TIME =
+                TimeUnit.MINUTES.toMillis(
+                        applicationProperties.getSecurity().getLoginResetTimeMinutes());
+    }
+
+    private final ConcurrentHashMap<String, AttemptCounter> attemptsCache =
+            new ConcurrentHashMap<>();
+
+    public void loginSucceeded(String key) {
+        attemptsCache.remove(key);
+    }
+
+    public boolean loginAttemptCheck(String key) {
+        attemptsCache.compute(
+                key,
+                (k, attemptCounter) -> {
+                    if (attemptCounter == null
+                            || attemptCounter.shouldReset(ATTEMPT_INCREMENT_TIME)) {
+                        return new AttemptCounter();
+                    } else {
+                        attemptCounter.increment();
+                        return attemptCounter;
+                    }
+                });
+        return attemptsCache.get(key).getAttemptCount() >= MAX_ATTEMPTS;
+    }
+
+    public boolean isBlocked(String key) {
+        AttemptCounter attemptCounter = attemptsCache.get(key);
+        if (attemptCounter != null) {
+            return attemptCounter.getAttemptCount() >= MAX_ATTEMPTS;
+        }
+        return false;
+    }
+}

src/main/java/stirling/software/SPDF/config/security/RateLimitResetScheduler.java

@@ -0,0 +1,19 @@
+package stirling.software.SPDF.config.security;
+
+import org.springframework.scheduling.annotation.Scheduled;
+import org.springframework.stereotype.Component;
+
+@Component
+public class RateLimitResetScheduler {
+
+    private final IPRateLimitingFilter rateLimitingFilter;
+
+    public RateLimitResetScheduler(IPRateLimitingFilter rateLimitingFilter) {
+        this.rateLimitingFilter = rateLimitingFilter;
+    }
+
+    @Scheduled(cron = "0 0 0 * * MON") // At 00:00 every Monday TODO: configurable
+    public void resetRateLimit() {
+        rateLimitingFilter.resetRequestCounts();
+    }
+}

src/main/java/stirling/software/SPDF/config/security/SecurityConfiguration.java

@@ -0,0 +1,140 @@
+package stirling.software.SPDF.config.security;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.beans.factory.annotation.Qualifier;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.context.annotation.Lazy;
+import org.springframework.security.authentication.dao.DaoAuthenticationProvider;
+import org.springframework.security.config.annotation.method.configuration.EnableMethodSecurity;
+import org.springframework.security.config.annotation.web.builders.HttpSecurity;
+import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
+import org.springframework.security.core.userdetails.UserDetailsService;
+import org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder;
+import org.springframework.security.crypto.password.PasswordEncoder;
+import org.springframework.security.web.SecurityFilterChain;
+import org.springframework.security.web.authentication.UsernamePasswordAuthenticationFilter;
+import org.springframework.security.web.authentication.rememberme.PersistentTokenRepository;
+import org.springframework.security.web.savedrequest.NullRequestCache;
+import org.springframework.security.web.util.matcher.AntPathRequestMatcher;
+
+import stirling.software.SPDF.repository.JPATokenRepositoryImpl;
+
+@Configuration
+@EnableWebSecurity()
+@EnableMethodSecurity
+public class SecurityConfiguration {
+
+    @Autowired private UserDetailsService userDetailsService;
+
+    @Bean
+    public PasswordEncoder passwordEncoder() {
+        return new BCryptPasswordEncoder();
+    }
+
+    @Autowired @Lazy private UserService userService;
+
+    @Autowired
+    @Qualifier("loginEnabled")
+    public boolean loginEnabledValue;
+
+    @Autowired private UserAuthenticationFilter userAuthenticationFilter;
+
+    @Autowired private LoginAttemptService loginAttemptService;
+
+    @Autowired private FirstLoginFilter firstLoginFilter;
+
+    @Bean
+    public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
+        http.addFilterBefore(userAuthenticationFilter, UsernamePasswordAuthenticationFilter.class);
+
+        if (loginEnabledValue) {
+
+            http.csrf(csrf -> csrf.disable());
+            http.addFilterBefore(rateLimitingFilter(), UsernamePasswordAuthenticationFilter.class);
+            http.addFilterAfter(firstLoginFilter, UsernamePasswordAuthenticationFilter.class);
+            http.formLogin(
+                            formLogin ->
+                                    formLogin
+                                            .loginPage("/login")
+                                            .successHandler(
+                                                    new CustomAuthenticationSuccessHandler())
+                                            .defaultSuccessUrl("/")
+                                            .failureHandler(
+                                                    new CustomAuthenticationFailureHandler(
+                                                            loginAttemptService))
+                                            .permitAll())
+                    .requestCache(requestCache -> requestCache.requestCache(new NullRequestCache()))
+                    .logout(
+                            logout ->
+                                    logout.logoutRequestMatcher(
+                                                    new AntPathRequestMatcher("/logout"))
+                                            .logoutSuccessUrl("/login?logout=true")
+                                            .invalidateHttpSession(true) // Invalidate session
+                                            .deleteCookies("JSESSIONID", "remember-me"))
+                    .rememberMe(
+                            rememberMeConfigurer ->
+                                    rememberMeConfigurer // Use the configurator directly
+                                            .key("uniqueAndSecret")
+                                            .tokenRepository(persistentTokenRepository())
+                                            .tokenValiditySeconds(1209600) // 2 weeks
+                            )
+                    .authorizeHttpRequests(
+                            authz ->
+                                    authz.requestMatchers(
+                                                    req -> {
+                                                        String uri = req.getRequestURI();
+                                                        String contextPath = req.getContextPath();
+
+                                                        // Remove the context path from the URI
+                                                        String trimmedUri =
+                                                                uri.startsWith(contextPath)
+                                                                        ? uri.substring(
+                                                                                contextPath
+                                                                                        .length())
+                                                                        : uri;
+
+                                                        return trimmedUri.startsWith("/login")
+                                                                || trimmedUri.endsWith(".svg")
+                                                                || trimmedUri.startsWith(
+                                                                        "/register")
+                                                                || trimmedUri.startsWith("/error")
+                                                                || trimmedUri.startsWith("/images/")
+                                                                || trimmedUri.startsWith("/public/")
+                                                                || trimmedUri.startsWith("/css/")
+                                                                || trimmedUri.startsWith("/js/")
+                                                                || trimmedUri.startsWith(
+                                                                        "/api/v1/info/status");
+                                                    })
+                                            .permitAll()
+                                            .anyRequest()
+                                            .authenticated())
+                    .userDetailsService(userDetailsService)
+                    .authenticationProvider(authenticationProvider());
+        } else {
+            http.csrf(csrf -> csrf.disable())
+                    .authorizeHttpRequests(authz -> authz.anyRequest().permitAll());
+        }
+
+        return http.build();
+    }
+
+    @Bean
+    public IPRateLimitingFilter rateLimitingFilter() {
+        int maxRequestsPerIp = 1000000; // Example limit TODO add config level
+        return new IPRateLimitingFilter(maxRequestsPerIp, maxRequestsPerIp);
+    }
+
+    @Bean
+    public DaoAuthenticationProvider authenticationProvider() {
+        DaoAuthenticationProvider authProvider = new DaoAuthenticationProvider();
+        authProvider.setUserDetailsService(userDetailsService);
+        authProvider.setPasswordEncoder(passwordEncoder());
+        return authProvider;
+    }
+
+    @Bean
+    public PersistentTokenRepository persistentTokenRepository() {
+        return new JPATokenRepositoryImpl();
+    }
+}

src/main/java/stirling/software/SPDF/config/security/UserAuthenticationFilter.java

@@ -0,0 +1,118 @@
+package stirling.software.SPDF.config.security;
+
+import java.io.IOException;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.beans.factory.annotation.Qualifier;
+import org.springframework.context.annotation.Lazy;
+import org.springframework.http.HttpStatus;
+import org.springframework.security.core.Authentication;
+import org.springframework.security.core.AuthenticationException;
+import org.springframework.security.core.context.SecurityContextHolder;
+import org.springframework.security.core.userdetails.UserDetails;
+import org.springframework.security.core.userdetails.UserDetailsService;
+import org.springframework.stereotype.Component;
+import org.springframework.web.filter.OncePerRequestFilter;
+
+import jakarta.servlet.FilterChain;
+import jakarta.servlet.ServletException;
+import jakarta.servlet.http.HttpServletRequest;
+import jakarta.servlet.http.HttpServletResponse;
+import stirling.software.SPDF.model.ApiKeyAuthenticationToken;
+
+@Component
+public class UserAuthenticationFilter extends OncePerRequestFilter {
+
+    @Autowired private UserDetailsService userDetailsService;
+
+    @Autowired @Lazy private UserService userService;
+
+    @Autowired
+    @Qualifier("loginEnabled")
+    public boolean loginEnabledValue;
+
+    @Override
+    protected void doFilterInternal(
+            HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)
+            throws ServletException, IOException {
+
+        if (!loginEnabledValue) {
+            // If login is not enabled, just pass all requests without authentication
+            filterChain.doFilter(request, response);
+            return;
+        }
+        String requestURI = request.getRequestURI();
+        Authentication authentication = SecurityContextHolder.getContext().getAuthentication();
+
+        // Check for API key in the request headers if no authentication exists
+        if (authentication == null || !authentication.isAuthenticated()) {
+            String apiKey = request.getHeader("X-API-Key");
+            if (apiKey != null && !apiKey.trim().isEmpty()) {
+                try {
+                    // Use API key to authenticate. This requires you to have an authentication
+                    // provider for API keys.
+                    UserDetails userDetails = userService.loadUserByApiKey(apiKey);
+                    if (userDetails == null) {
+                        response.setStatus(HttpStatus.UNAUTHORIZED.value());
+                        response.getWriter().write("Invalid API Key.");
+                        return;
+                    }
+                    authentication =
+                            new ApiKeyAuthenticationToken(
+                                    userDetails, apiKey, userDetails.getAuthorities());
+                    SecurityContextHolder.getContext().setAuthentication(authentication);
+                } catch (AuthenticationException e) {
+                    // If API key authentication fails, deny the request
+                    response.setStatus(HttpStatus.UNAUTHORIZED.value());
+                    response.getWriter().write("Invalid API Key.");
+                    return;
+                }
+            }
+        }
+
+        // If we still don't have any authentication, deny the request
+        if (authentication == null || !authentication.isAuthenticated()) {
+            String method = request.getMethod();
+            String contextPath = request.getContextPath();
+
+            if ("GET".equalsIgnoreCase(method) && !(contextPath + "/login").equals(requestURI)) {
+                response.sendRedirect(contextPath + "/login"); // redirect to the login page
+                return;
+            } else {
+                response.setStatus(HttpStatus.UNAUTHORIZED.value());
+                response.getWriter()
+                        .write(
+                                "Authentication required. Please provide a X-API-KEY in request header.\nThis is found in Settings -> Account Settings -> API Key\nAlternativly you can disable authentication if this is unexpected");
+                return;
+            }
+        }
+
+        filterChain.doFilter(request, response);
+    }
+
+    @Override
+    protected boolean shouldNotFilter(HttpServletRequest request) throws ServletException {
+        String uri = request.getRequestURI();
+        String contextPath = request.getContextPath();
+        String[] permitAllPatterns = {
+            contextPath + "/login",
+            contextPath + "/register",
+            contextPath + "/error",
+            contextPath + "/images/",
+            contextPath + "/public/",
+            contextPath + "/css/",
+            contextPath + "/js/",
+            contextPath + "/pdfjs/",
+            contextPath + "/api/v1/info/status",
+            contextPath + "/site.webmanifest"
+        };
+
+        for (String pattern : permitAllPatterns) {
+            if (uri.startsWith(pattern) || uri.endsWith(".svg")) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+}

src/main/java/stirling/software/SPDF/config/security/UserBasedRateLimitingFilter.java

@@ -0,0 +1,143 @@
+package stirling.software.SPDF.config.security;
+
+import java.io.IOException;
+import java.time.Duration;
+import java.util.Map;
+import java.util.concurrent.ConcurrentHashMap;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.beans.factory.annotation.Qualifier;
+import org.springframework.http.HttpStatus;
+import org.springframework.security.core.Authentication;
+import org.springframework.security.core.GrantedAuthority;
+import org.springframework.security.core.context.SecurityContextHolder;
+import org.springframework.security.core.userdetails.UserDetails;
+import org.springframework.security.core.userdetails.UserDetailsService;
+import org.springframework.stereotype.Component;
+import org.springframework.web.filter.OncePerRequestFilter;
+
+import io.github.bucket4j.Bandwidth;
+import io.github.bucket4j.Bucket;
+import io.github.bucket4j.ConsumptionProbe;
+import io.github.bucket4j.Refill;
+
+import jakarta.servlet.FilterChain;
+import jakarta.servlet.ServletException;
+import jakarta.servlet.http.HttpServletRequest;
+import jakarta.servlet.http.HttpServletResponse;
+import stirling.software.SPDF.model.Role;
+
+@Component
+public class UserBasedRateLimitingFilter extends OncePerRequestFilter {
+
+    private final Map<String, Bucket> apiBuckets = new ConcurrentHashMap<>();
+    private final Map<String, Bucket> webBuckets = new ConcurrentHashMap<>();
+
+    @Autowired private UserDetailsService userDetailsService;
+
+    @Autowired
+    @Qualifier("rateLimit")
+    public boolean rateLimit;
+
+    @Override
+    protected void doFilterInternal(
+            HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)
+            throws ServletException, IOException {
+        if (!rateLimit) {
+            // If rateLimit is not enabled, just pass all requests without rate limiting
+            filterChain.doFilter(request, response);
+            return;
+        }
+
+        String method = request.getMethod();
+        if (!"POST".equalsIgnoreCase(method)) {
+            // If the request is not a POST, just pass it through without rate limiting
+            filterChain.doFilter(request, response);
+            return;
+        }
+
+        String identifier = null;
+
+        // Check for API key in the request headers
+        String apiKey = request.getHeader("X-API-Key");
+        if (apiKey != null && !apiKey.trim().isEmpty()) {
+            identifier =
+                    "API_KEY_" + apiKey; // Prefix to distinguish between API keys and usernames
+        } else {
+            Authentication authentication = SecurityContextHolder.getContext().getAuthentication();
+            if (authentication != null && authentication.isAuthenticated()) {
+                UserDetails userDetails = (UserDetails) authentication.getPrincipal();
+                identifier = userDetails.getUsername();
+            }
+        }
+
+        // If neither API key nor an authenticated user is present, use IP address
+        if (identifier == null) {
+            identifier = request.getRemoteAddr();
+        }
+
+        Role userRole =
+                getRoleFromAuthentication(SecurityContextHolder.getContext().getAuthentication());
+
+        if (request.getHeader("X-API-Key") != null) {
+            // It's an API call
+            processRequest(
+                    userRole.getApiCallsPerDay(),
+                    identifier,
+                    apiBuckets,
+                    request,
+                    response,
+                    filterChain);
+        } else {
+            // It's a Web UI call
+            processRequest(
+                    userRole.getWebCallsPerDay(),
+                    identifier,
+                    webBuckets,
+                    request,
+                    response,
+                    filterChain);
+        }
+    }
+
+    private Role getRoleFromAuthentication(Authentication authentication) {
+        if (authentication != null && authentication.isAuthenticated()) {
+            for (GrantedAuthority authority : authentication.getAuthorities()) {
+                try {
+                    return Role.fromString(authority.getAuthority());
+                } catch (IllegalArgumentException ex) {
+                    // Ignore and continue to next authority.
+                }
+            }
+        }
+        throw new IllegalStateException("User does not have a valid role.");
+    }
+
+    private void processRequest(
+            int limitPerDay,
+            String identifier,
+            Map<String, Bucket> buckets,
+            HttpServletRequest request,
+            HttpServletResponse response,
+            FilterChain filterChain)
+            throws IOException, ServletException {
+        Bucket userBucket = buckets.computeIfAbsent(identifier, k -> createUserBucket(limitPerDay));
+        ConsumptionProbe probe = userBucket.tryConsumeAndReturnRemaining(1);
+
+        if (probe.isConsumed()) {
+            response.setHeader("X-Rate-Limit-Remaining", Long.toString(probe.getRemainingTokens()));
+            filterChain.doFilter(request, response);
+        } else {
+            long waitForRefill = probe.getNanosToWaitForRefill() / 1_000_000_000;
+            response.setStatus(HttpStatus.TOO_MANY_REQUESTS.value());
+            response.setHeader("X-Rate-Limit-Retry-After-Seconds", String.valueOf(waitForRefill));
+            response.getWriter().write("Rate limit exceeded for POST requests.");
+        }
+    }
+
+    private Bucket createUserBucket(int limitPerDay) {
+        Bandwidth limit =
+                Bandwidth.classic(limitPerDay, Refill.intervally(limitPerDay, Duration.ofDays(1)));
+        return Bucket.builder().addLimit(limit).build();
+    }
+}

src/main/java/stirling/software/SPDF/config/security/UserService.java

@@ -0,0 +1,197 @@
+package stirling.software.SPDF.config.security;
+
+import java.util.Collection;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.Optional;
+import java.util.UUID;
+import java.util.stream.Collectors;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.security.authentication.UsernamePasswordAuthenticationToken;
+import org.springframework.security.core.Authentication;
+import org.springframework.security.core.GrantedAuthority;
+import org.springframework.security.core.authority.SimpleGrantedAuthority;
+import org.springframework.security.core.userdetails.UserDetails;
+import org.springframework.security.core.userdetails.UsernameNotFoundException;
+import org.springframework.security.crypto.password.PasswordEncoder;
+import org.springframework.stereotype.Service;
+
+import stirling.software.SPDF.controller.api.pipeline.UserServiceInterface;
+import stirling.software.SPDF.model.Authority;
+import stirling.software.SPDF.model.Role;
+import stirling.software.SPDF.model.User;
+import stirling.software.SPDF.repository.UserRepository;
+
+@Service
+public class UserService implements UserServiceInterface {
+
+    @Autowired private UserRepository userRepository;
+
+    @Autowired private PasswordEncoder passwordEncoder;
+
+    public Authentication getAuthentication(String apiKey) {
+        User user = getUserByApiKey(apiKey);
+        if (user == null) {
+            throw new UsernameNotFoundException("API key is not valid");
+        }
+
+        // Convert the user into an Authentication object
+        return new UsernamePasswordAuthenticationToken(
+                user, // principal (typically the user)
+                null, // credentials (we don't expose the password or API key here)
+                getAuthorities(user) // user's authorities (roles/permissions)
+                );
+    }
+
+    private Collection<? extends GrantedAuthority> getAuthorities(User user) {
+        // Convert each Authority object into a SimpleGrantedAuthority object.
+        return user.getAuthorities().stream()
+                .map((Authority authority) -> new SimpleGrantedAuthority(authority.getAuthority()))
+                .collect(Collectors.toList());
+    }
+
+    private String generateApiKey() {
+        String apiKey;
+        do {
+            apiKey = UUID.randomUUID().toString();
+        } while (userRepository.findByApiKey(apiKey) != null); // Ensure uniqueness
+        return apiKey;
+    }
+
+    public User addApiKeyToUser(String username) {
+        User user =
+                userRepository
+                        .findByUsername(username)
+                        .orElseThrow(() -> new UsernameNotFoundException("User not found"));
+
+        user.setApiKey(generateApiKey());
+        return userRepository.save(user);
+    }
+
+    public User refreshApiKeyForUser(String username) {
+        return addApiKeyToUser(username); // reuse the add API key method for refreshing
+    }
+
+    public String getApiKeyForUser(String username) {
+        User user =
+                userRepository
+                        .findByUsername(username)
+                        .orElseThrow(() -> new UsernameNotFoundException("User not found"));
+        return user.getApiKey();
+    }
+
+    public boolean isValidApiKey(String apiKey) {
+        return userRepository.findByApiKey(apiKey) != null;
+    }
+
+    public User getUserByApiKey(String apiKey) {
+        return userRepository.findByApiKey(apiKey);
+    }
+
+    public UserDetails loadUserByApiKey(String apiKey) {
+        User userOptional = userRepository.findByApiKey(apiKey);
+        if (userOptional != null) {
+            User user = userOptional;
+            // Convert your User entity to a UserDetails object with authorities
+            return new org.springframework.security.core.userdetails.User(
+                    user.getUsername(),
+                    user.getPassword(), // you might not need this for API key auth
+                    getAuthorities(user));
+        }
+        return null; // or throw an exception
+    }
+
+    public boolean validateApiKeyForUser(String username, String apiKey) {
+        Optional<User> userOpt = userRepository.findByUsername(username);
+        return userOpt.isPresent() && userOpt.get().getApiKey().equals(apiKey);
+    }
+
+    public void saveUser(String username, String password) {
+        User user = new User();
+        user.setUsername(username);
+        user.setPassword(passwordEncoder.encode(password));
+        user.setEnabled(true);
+        userRepository.save(user);
+    }
+
+    public void saveUser(String username, String password, String role, boolean firstLogin) {
+        User user = new User();
+        user.setUsername(username);
+        user.setPassword(passwordEncoder.encode(password));
+        user.addAuthority(new Authority(role, user));
+        user.setEnabled(true);
+        user.setFirstLogin(firstLogin);
+        userRepository.save(user);
+    }
+
+    public void saveUser(String username, String password, String role) {
+        User user = new User();
+        user.setUsername(username);
+        user.setPassword(passwordEncoder.encode(password));
+        user.addAuthority(new Authority(role, user));
+        user.setEnabled(true);
+        user.setFirstLogin(false);
+        userRepository.save(user);
+    }
+
+    public void deleteUser(String username) {
+        Optional<User> userOpt = userRepository.findByUsername(username);
+        if (userOpt.isPresent()) {
+            for (Authority authority : userOpt.get().getAuthorities()) {
+                if (authority.getAuthority().equals(Role.INTERNAL_API_USER.getRoleId())) {
+                    return;
+                }
+            }
+            userRepository.delete(userOpt.get());
+        }
+    }
+
+    public boolean usernameExists(String username) {
+        return userRepository.findByUsername(username).isPresent();
+    }
+
+    public boolean hasUsers() {
+        return userRepository.count() > 0;
+    }
+
+    public void updateUserSettings(String username, Map<String, String> updates) {
+        Optional<User> userOpt = userRepository.findByUsername(username);
+        if (userOpt.isPresent()) {
+            User user = userOpt.get();
+            Map<String, String> settingsMap = user.getSettings();
+
+            if (settingsMap == null) {
+                settingsMap = new HashMap<String, String>();
+            }
+            settingsMap.clear();
+            settingsMap.putAll(updates);
+            user.setSettings(settingsMap);
+
+            userRepository.save(user);
+        }
+    }
+
+    public Optional<User> findByUsername(String username) {
+        return userRepository.findByUsername(username);
+    }
+
+    public void changeUsername(User user, String newUsername) {
+        user.setUsername(newUsername);
+        userRepository.save(user);
+    }
+
+    public void changePassword(User user, String newPassword) {
+        user.setPassword(passwordEncoder.encode(newPassword));
+        userRepository.save(user);
+    }
+
+    public void changeFirstUse(User user, boolean firstUse) {
+        user.setFirstLogin(firstUse);
+        userRepository.save(user);
+    }
+
+    public boolean isPasswordCorrect(User user, String currentPassword) {
+        return passwordEncoder.matches(currentPassword, user.getPassword());
+    }
+}

src/main/java/stirling/software/SPDF/controller/CompressController.java

@@ -1,92 +0,0 @@
-package stirling.software.SPDF.controller;
-
-import java.io.IOException;
-import java.nio.file.Files;
-import java.nio.file.Path;
-import java.util.ArrayList;
-import java.util.List;
-
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-import org.springframework.http.HttpHeaders;
-import org.springframework.http.MediaType;
-import org.springframework.http.ResponseEntity;
-import org.springframework.stereotype.Controller;
-import org.springframework.ui.Model;
-import org.springframework.web.bind.annotation.GetMapping;
-import org.springframework.web.bind.annotation.PostMapping;
-import org.springframework.web.bind.annotation.RequestParam;
-import org.springframework.web.multipart.MultipartFile;
-
-import stirling.software.SPDF.utils.ProcessExecutor;
-
-
-@Controller
-public class CompressController {
-
-    private static final Logger logger = LoggerFactory.getLogger(CompressController.class);
-
-    @GetMapping("/compress-pdf")
-    public String compressPdfForm(Model model) {
-        model.addAttribute("currentPage", "compress-pdf");
-        return "compress-pdf";
-    }
-
-    
-    @PostMapping("/compress-pdf")
-    public ResponseEntity<byte[]> optimizePdf(
-            @RequestParam("fileInput") MultipartFile inputFile,
-            @RequestParam("optimizeLevel") int optimizeLevel,
-            @RequestParam(name = "fastWebView", required = false) Boolean fastWebView,
-            @RequestParam(name = "jbig2Lossy", required = false) Boolean jbig2Lossy) throws IOException, InterruptedException {
-
-        // Save the uploaded file to a temporary location
-        Path tempInputFile = Files.createTempFile("input_", ".pdf");
-        inputFile.transferTo(tempInputFile.toFile());
-
-        // Prepare the output file path
-        Path tempOutputFile = Files.createTempFile("output_", ".pdf");
-
-        // Prepare the OCRmyPDF command
-        List<String> command = new ArrayList<>();
-        command.add("ocrmypdf");
-        command.add("--skip-text");
-        command.add("--tesseract-timeout=0");
-        command.add("--optimize");
-        command.add(String.valueOf(optimizeLevel));
-        command.add("--output-type");
-        command.add("pdf");
-
-
-        if (fastWebView != null && fastWebView) {
-            long fileSize = inputFile.getSize();
-            long fastWebViewSize = (long) (fileSize * 1.25); // 25% higher than file size
-            command.add("--fast-web-view");
-            command.add(String.valueOf(fastWebViewSize));
-        }
-
-        if (jbig2Lossy != null && jbig2Lossy) {
-            command.add("--jbig2-lossy");
-        }
-
-        command.add(tempInputFile.toString());
-        command.add(tempOutputFile.toString());
-
-        int returnCode = ProcessExecutor.getInstance(ProcessExecutor.Processes.OCR_MY_PDF).runCommandWithOutputHandling(command);
-        
-        // Read the optimized PDF file
-        byte[] pdfBytes = Files.readAllBytes(tempOutputFile);
-
-        // Clean up the temporary files
-        Files.delete(tempInputFile);
-        Files.delete(tempOutputFile);
-
-        // Return the optimized PDF as a response
-        String outputFilename = inputFile.getOriginalFilename().replaceFirst("[.][^.]+$", "") + "_Optimized.pdf";
-        HttpHeaders headers = new HttpHeaders();
-        headers.setContentType(MediaType.APPLICATION_PDF);
-        headers.setContentDispositionFormData("attachment", outputFilename);
-        return ResponseEntity.ok().headers(headers).body(pdfBytes);
-}
-
-}

src/main/java/stirling/software/SPDF/controller/MergeController.java

@@ -1,71 +0,0 @@
-package stirling.software.SPDF.controller;
-
-import java.io.ByteArrayInputStream;
-import java.io.ByteArrayOutputStream;
-import java.io.IOException;
-import java.util.ArrayList;
-import java.util.List;
-
-import org.apache.pdfbox.pdmodel.PDDocument;
-import org.apache.pdfbox.pdmodel.PDPage;
-import org.apache.pdfbox.pdmodel.PDPageTree;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-import org.springframework.core.io.InputStreamResource;
-import org.springframework.http.MediaType;
-import org.springframework.http.ResponseEntity;
-import org.springframework.stereotype.Controller;
-import org.springframework.ui.Model;
-import org.springframework.web.bind.annotation.GetMapping;
-import org.springframework.web.bind.annotation.PostMapping;
-import org.springframework.web.bind.annotation.RequestParam;
-import org.springframework.web.multipart.MultipartFile;
-
-import stirling.software.SPDF.utils.PdfUtils;
-
-@Controller
-public class MergeController {
-
-    private static final Logger logger = LoggerFactory.getLogger(MergeController.class);
-
-    @GetMapping("/merge-pdfs")
-    public String hello(Model model) {
-        model.addAttribute("currentPage", "merge-pdfs");
-        return "merge-pdfs";
-    }
-
-    @PostMapping("/merge-pdfs")
-    public ResponseEntity<byte[]> mergePdfs(@RequestParam("fileInput") MultipartFile[] files) throws IOException {
-        // Read the input PDF files into PDDocument objects
-        List<PDDocument> documents = new ArrayList<>();
-
-        // Loop through the files array and read each file into a PDDocument
-        for (MultipartFile file : files) {
-            documents.add(PDDocument.load(file.getInputStream()));
-        }
-
-        PDDocument mergedDoc = mergeDocuments(documents);
-
-        // Return the merged PDF as a response
-        return PdfUtils.pdfDocToWebResponse(mergedDoc, files[0].getOriginalFilename().replaceFirst("[.][^.]+$", "")+ "_merged.pdf");
-    }
-
-    private PDDocument mergeDocuments(List<PDDocument> documents) throws IOException {
-        // Create a new empty document
-        PDDocument mergedDoc = new PDDocument();
-
-        // Iterate over the list of documents and add their pages to the merged document
-        for (PDDocument doc : documents) {
-            // Get all pages from the current document
-            PDPageTree pages = doc.getPages();
-            // Iterate over the pages and add them to the merged document
-            for (PDPage page : pages) {
-                mergedDoc.addPage(page);
-            }
-        }
-
-        // Return the merged document
-        return mergedDoc;
-    }
-
-}

src/main/java/stirling/software/SPDF/controller/OCRController.java

@@ -1,173 +0,0 @@
-package stirling.software.SPDF.controller;
-
-import java.io.File;
-import java.io.FileOutputStream;
-import java.io.IOException;
-import java.nio.file.Files;
-import java.nio.file.Path;
-import java.nio.file.Paths;
-import java.util.ArrayList;
-import java.util.Arrays;
-import java.util.Collections;
-import java.util.List;
-import java.util.stream.Collectors;
-import java.util.zip.ZipEntry;
-import java.util.zip.ZipOutputStream;
-
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-import org.springframework.http.HttpHeaders;
-import org.springframework.http.MediaType;
-import org.springframework.http.ResponseEntity;
-import org.springframework.stereotype.Controller;
-import org.springframework.web.bind.annotation.GetMapping;
-import org.springframework.web.bind.annotation.PostMapping;
-import org.springframework.web.bind.annotation.RequestParam;
-import org.springframework.web.multipart.MultipartFile;
-import org.springframework.web.servlet.ModelAndView;
-
-import stirling.software.SPDF.utils.ProcessExecutor;
-//import com.spire.pdf.*;
-import java.util.concurrent.Semaphore;
-@Controller
-public class OCRController {
-
-	private static final Logger logger = LoggerFactory.getLogger(OCRController.class);
-
-	@GetMapping("/ocr-pdf")
-	public ModelAndView ocrPdfPage() {
-		ModelAndView modelAndView = new ModelAndView("ocr-pdf");
-		modelAndView.addObject("languages", getAvailableTesseractLanguages());
-		modelAndView.addObject("currentPage", "ocr-pdf");
-		return modelAndView;
-	}
-
-	private final Semaphore semaphore = new Semaphore(2);
-	
-	@PostMapping("/ocr-pdf")
-	public ResponseEntity<byte[]> processPdfWithOCR(@RequestParam("fileInput") MultipartFile inputFile,
-			@RequestParam("languages") List<String> selectedLanguages,
-			@RequestParam(name = "sidecar", required = false) Boolean sidecar,
-			@RequestParam(name = "deskew", required = false) Boolean deskew,
-			@RequestParam(name = "clean", required = false) Boolean clean,
-			@RequestParam(name = "clean-final", required = false) Boolean cleanFinal,
-			@RequestParam(name = "ocrType", required = false) String ocrType) throws IOException, InterruptedException {
-
-	    
-		//--output-type pdfa
-		if (selectedLanguages == null || selectedLanguages.size() < 1) {
-			throw new IOException("Please select at least one language.");
-	    }
-		
-		// Save the uploaded file to a temporary location
-		Path tempInputFile = Files.createTempFile("input_", ".pdf");
-		inputFile.transferTo(tempInputFile.toFile());
-
-		// Prepare the output file path
-		Path tempOutputFile = Files.createTempFile("output_", ".pdf");
-
-		// Prepare the output file path
-        Path sidecarTextPath = null;
-        
-		// Run OCR Command
-	    String languageOption = String.join("+", selectedLanguages);
-	    
-	    List<String> command = new ArrayList<>(Arrays.asList("ocrmypdf","--verbose", "2", "--output-type", "pdf"));
-	    		
-	    
-	    if (sidecar != null && sidecar) {
-	        sidecarTextPath = Files.createTempFile("sidecar", ".txt");
-	        command.add("--sidecar");
-	        command.add(sidecarTextPath.toString());
-	    }
-	    
-	    if (deskew != null && deskew) {
-            command.add("--deskew");
-	    }
-	    if (clean != null && clean) {
-            command.add("--clean");
-        }
-	    if (cleanFinal != null && cleanFinal) {
-            command.add("--clean-final");
-        }
-	    if (ocrType != null && !ocrType.equals("")) {
-            if("skip-text".equals(ocrType)) {
-                command.add("--skip-text");
-            } else if("force-ocr".equals(ocrType)) {
-                command.add("--force-ocr");
-            } else if("Normal".equals(ocrType)) {
-                
-            }
-        }
-
-	    command.addAll(Arrays.asList("--language", languageOption,
-	            tempInputFile.toString(), tempOutputFile.toString()));
-	    
-	    //Run CLI command
-	    int returnCode = ProcessExecutor.getInstance(ProcessExecutor.Processes.OCR_MY_PDF).runCommandWithOutputHandling(command);
-        
-		// Read the OCR processed PDF file
-		byte[] pdfBytes = Files.readAllBytes(tempOutputFile);
-		
-	    
-		// Clean up the temporary files
-		Files.delete(tempInputFile);
-		// Return the OCR processed PDF as a response
-		String outputFilename = inputFile.getOriginalFilename().replaceFirst("[.][^.]+$", "") + "_OCR.pdf";
-
-		HttpHeaders headers = new HttpHeaders();
-
-	    if (sidecar != null && sidecar) {
-	        // Create a zip file containing both the PDF and the text file
-	        String outputZipFilename = inputFile.getOriginalFilename().replaceFirst("[.][^.]+$", "") + "_OCR.zip";
-	        Path tempZipFile = Files.createTempFile("output_", ".zip");
-
-	        try (ZipOutputStream zipOut = new ZipOutputStream(new FileOutputStream(tempZipFile.toFile()))) {
-	            // Add PDF file to the zip
-	            ZipEntry pdfEntry = new ZipEntry(outputFilename);
-	            zipOut.putNextEntry(pdfEntry);
-	            Files.copy(tempOutputFile, zipOut);
-	            zipOut.closeEntry();
-
-	            // Add text file to the zip
-	            ZipEntry txtEntry = new ZipEntry(outputFilename.replace(".pdf", ".txt"));
-	            zipOut.putNextEntry(txtEntry);
-	            Files.copy(sidecarTextPath, zipOut);
-	            zipOut.closeEntry();
-	        }
-
-	        byte[] zipBytes = Files.readAllBytes(tempZipFile);
-
-	        // Clean up the temporary zip file
-	        Files.delete(tempZipFile);
-	        Files.delete(tempOutputFile);
-	        Files.delete(sidecarTextPath);
-	        
-	        // Return the zip file containing both the PDF and the text file
-	        headers.setContentType(MediaType.APPLICATION_OCTET_STREAM);
-	        headers.setContentDispositionFormData("attachment", outputZipFilename);
-	        return ResponseEntity.ok().headers(headers).body(zipBytes);
-	    } else {
-	        // Return the OCR processed PDF as a response
-	    	Files.delete(tempOutputFile);
-	        headers.setContentType(MediaType.APPLICATION_PDF);
-	        headers.setContentDispositionFormData("attachment", outputFilename);
-	        return ResponseEntity.ok().headers(headers).body(pdfBytes);
-	    }
-	    
-	}
-
-	public List<String> getAvailableTesseractLanguages() {
-	    String tessdataDir = "/usr/share/tesseract-ocr/4.00/tessdata";
-	    File[] files = new File(tessdataDir).listFiles();
-	    if (files == null) {
-	        return Collections.emptyList();
-	    }
-	    return Arrays.stream(files)
-	            .filter(file -> file.getName().endsWith(".traineddata"))
-	            .map(file -> file.getName().replace(".traineddata", ""))
-	            .filter(lang -> !lang.equalsIgnoreCase("osd"))
-	            .collect(Collectors.toList());
-	}
-
-}

src/main/java/stirling/software/SPDF/controller/OverlayImageController.java

@@ -1,43 +0,0 @@
-package stirling.software.SPDF.controller;
-
-import java.io.IOException;
-
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-import org.springframework.http.HttpStatus;
-import org.springframework.http.ResponseEntity;
-import org.springframework.stereotype.Controller;
-import org.springframework.ui.Model;
-import org.springframework.web.bind.annotation.GetMapping;
-import org.springframework.web.bind.annotation.PostMapping;
-import org.springframework.web.bind.annotation.RequestParam;
-import org.springframework.web.multipart.MultipartFile;
-
-import stirling.software.SPDF.utils.PdfUtils;
-
-@Controller
-public class OverlayImageController {
-
-    private static final Logger logger = LoggerFactory.getLogger(OverlayImageController.class);
-
-    @GetMapping("/add-image")
-    public String overlayImage(Model model) {
-        model.addAttribute("currentPage", "add-image");
-        return "add-image";
-    }
-
-    @PostMapping("/add-image")
-    public ResponseEntity<byte[]> overlayImage(@RequestParam("fileInput") MultipartFile pdfFile, @RequestParam("fileInput2") MultipartFile imageFile, @RequestParam("x") float x,
-            @RequestParam("y") float y) {
-        try {
-            byte[] pdfBytes = pdfFile.getBytes();
-            byte[] imageBytes = imageFile.getBytes();
-            byte[] result = PdfUtils.overlayImage(pdfBytes, imageBytes, x, y);
-
-            return PdfUtils.bytesToWebResponse(result, pdfFile.getOriginalFilename().replaceFirst("[.][^.]+$", "") + "_overlayed.pdf");
-        } catch (IOException e) {
-            logger.error("Failed to add image to PDF", e);
-            return new ResponseEntity<>(HttpStatus.BAD_REQUEST);
-        }
-    }
-}

src/main/java/stirling/software/SPDF/controller/PdfController.java

@@ -1,27 +0,0 @@
-package stirling.software.SPDF.controller;
-
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-import org.springframework.stereotype.Controller;
-import org.springframework.ui.Model;
-import org.springframework.web.bind.annotation.GetMapping;
-
-@Controller
-public class PdfController {
-
-    private static final Logger logger = LoggerFactory.getLogger(PdfController.class);
-    
-    @GetMapping("/home")
-    public String root(Model model) {
-        return "redirect:/";
-    }
-
-    @GetMapping("/")
-    public String home(Model model) {
-        model.addAttribute("currentPage", "home");
-        return "home";
-    }
-
-
-    
-}