quick cache fix

📝 Update README: Translation Progress Table

.git-blame-ignore-revs

@@ -0,0 +1,5 @@
+# Formatting
+5f771b785130154ed47952635b7acef371ffe0ec
+
+# Normalize files
+55d4fda01b2f39f5b7d7b4fda5214bd7ff0fd5dd

.gitattributes

@@ -0,0 +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

@@ -1,2 +1,2 @@
-# All PRs must be approved by one of the main v2 developers
-* @Frooodle @Sf298 @LaserKaspar @sbplat
+# All PRs to V1 must be approved by Frooodle
+* @Frooodle

.github/FUNDING.yml

@@ -0,0 +1,13 @@
+# These are supported funding model platforms
+
+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
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
+custom: ['https://paypal.me/froodleplex?country.x=GB&locale.x=en_GB'] # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

.github/dependabot.yml

@@ -0,0 +1,15 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "gradle" # See documentation for possible values
+    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,18 @@
+# Description
+
+Please provide a summary of the changes, including relevant motivation and context.
+
+Closes #(issue_number)
+
+## Checklist:
+
+- [ ] I have read the [Contribution Guidelines](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/CONTRIBUTING.md)
+- [ ] I have performed a self-review of my own code
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] My changes generate no new warnings
+
+## Contributor License Agreement
+
+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 the 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/scripts/check_duplicates.py

@@ -0,0 +1,51 @@
+import sys
+
+
+def find_duplicate_keys(file_path):
+    """
+    Finds duplicate keys in a properties file and returns their occurrences.
+
+    This function reads a properties file, identifies any keys that occur more than
+    once, and returns a dictionary with these keys and the line numbers of their occurrences.
+
+    Parameters:
+    file_path (str): The path to the properties file to be checked.
+
+    Returns:
+    dict: A dictionary where each key is a duplicated key in the file, and the value is a list
+          of line numbers where the key occurs.
+    """
+    with open(file_path, "r", encoding="utf-8") as file:
+        lines = file.readlines()
+
+    keys = {}
+    duplicates = {}
+
+    for line_number, line in enumerate(lines, start=1):
+        line = line.strip()
+        if line and not line.startswith("#") and "=" in line:
+            key = line.split("=", 1)[0].strip()
+            if key in keys:
+                # If the key already exists, add the current line number
+                duplicates.setdefault(key, []).append(line_number)
+                # Also add the first instance of the key if not already done
+                if keys[key] not in duplicates[key]:
+                    duplicates[key].insert(0, keys[key])
+            else:
+                # Store the line number of the first instance of the key
+                keys[key] = line_number
+
+    return duplicates
+
+
+if __name__ == "__main__":
+    failed = False
+    for ar in sys.argv[1:]:
+        duplicates = find_duplicate_keys(ar)
+        if duplicates:
+            for key, lines in duplicates.items():
+                lines_str = ", ".join(map(str, lines))
+                print(f"{key} duplicated in {ar} on lines {lines_str}")
+                failed = True
+    if failed:
+        sys.exit(1)

.github/scripts/check_tabulator.py

@@ -0,0 +1,84 @@
+"""check_tabulator.py"""
+import argparse
+import sys
+
+
+def check_tabs(file_path):
+    """
+    Checks for tabs in the specified file.
+
+    Args:
+        file_path (str): The path to the file to be checked.
+
+    Returns:
+        bool: True if tabs are found, False otherwise.
+    """
+    with open(file_path, "r", encoding="utf-8") as file:
+        content = file.read()
+
+    if "\t" in content:
+        print(f"Tab found in {file_path}")
+        return True
+    return False
+
+
+def replace_tabs_with_spaces(file_path, replace_with="  "):
+    """
+    Replaces tabs with a specified number of spaces in the file.
+
+    Args:
+        file_path (str): The path to the file where tabs will be replaced.
+        replace_with (str): The character(s) to replace tabs with. Defaults to two spaces.
+    """
+    with open(file_path, "r", encoding="utf-8") as file:
+        content = file.read()
+
+    updated_content = content.replace("\t", replace_with)
+
+    with open(file_path, "w", encoding="utf-8") as file:
+        file.write(updated_content)
+
+
+def main():
+    """
+    Main function to replace tabs with spaces in the provided files.
+    The replacement character and files to check are taken from command line arguments.
+    """
+    # Create ArgumentParser instance
+    parser = argparse.ArgumentParser(
+        description="Replace tabs in files with specified characters."
+    )
+
+    # Define optional argument `--replace_with`
+    parser.add_argument(
+        "--replace_with",
+        default="  ",
+        help="Character(s) to replace tabs with. Default is two spaces.",
+    )
+
+    # Define argument for file paths
+    parser.add_argument("files", metavar="FILE", nargs="+", help="Files to process.")
+
+    # Parse arguments
+    args = parser.parse_args()
+
+    # Extract replacement characters and files from the parsed arguments
+    replace_with = args.replace_with
+    files_checked = args.files
+
+    error = False
+
+    for file_path in files_checked:
+        if check_tabs(file_path):
+            replace_tabs_with_spaces(file_path, replace_with)
+            error = True
+
+    if error:
+        print("Error: Originally found tabs in HTML files, now replaced.")
+        sys.exit(1)
+
+    sys.exit(0)
+
+
+if __name__ == "__main__":
+    main()

.github/scripts/gradle_to_chart.py

@@ -0,0 +1,67 @@
+import re
+import yaml
+
+# Paths to the files
+chart_yaml_path = "chart/stirling-pdf/Chart.yaml"
+gradle_path = "build.gradle"
+
+
+def get_chart_version(path):
+    """
+    Reads the appVersion from Chart.yaml.
+
+    Args:
+        path (str): The file path to the Chart.yaml.
+
+    Returns:
+        str: The appVersion if found, otherwise an empty string.
+    """
+    with open(path, encoding="utf-8") as file:
+        chart_yaml = yaml.safe_load(file)
+    return chart_yaml.get("appVersion", "")
+
+
+def get_gradle_version(path):
+    """
+    Extracts the version from build.gradle.
+
+    Args:
+        path (str): The file path to the build.gradle.
+
+    Returns:
+        str: The version if found, otherwise an empty string.
+    """
+    with open(path, encoding="utf-8") as file:
+        for line in file:
+            if "version =" in line:
+                # Extracts the value after 'version ='
+                return re.search(r'version\s*=\s*[\'"](.+?)[\'"]', line).group(1)
+    return ""
+
+
+def update_chart_version(path, new_version):
+    """
+    Updates the appVersion in Chart.yaml with a new version.
+
+    Args:
+        path (str): The file path to the Chart.yaml.
+        new_version (str): The new version to update to.
+    """
+    with open(path, encoding="utf-8") as file:
+        chart_yaml = yaml.safe_load(file)
+    chart_yaml["appVersion"] = new_version
+    with open(path, "w", encoding="utf-8") as file:
+        yaml.safe_dump(chart_yaml, file)
+
+
+# Main logic
+chart_version = get_chart_version(chart_yaml_path)
+gradle_version = get_gradle_version(gradle_path)
+
+if chart_version != gradle_version:
+    print(
+        f"Versions do not match. Updating Chart.yaml from {chart_version} to {gradle_version}."
+    )
+    update_chart_version(chart_yaml_path, gradle_version)
+else:
+    print("Versions match. No update required.")

.github/workflows/build.yml

@@ -0,0 +1,42 @@
+name: "Build repo"
+
+on:
+  push:
+    branches: ["main"]
+    paths-ignore:
+      - ".github/**"
+      - "**/*.md"
+  pull_request:
+    branches: ["main"]
+    paths-ignore:
+      - ".github/**"
+      - "**/*.md"
+
+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@v4
+
+      - name: Set up JDK 17
+        uses: actions/setup-java@v4
+        with:
+          java-version: "17"
+          distribution: "temurin"
+
+      - uses: gradle/actions/setup-gradle@v3
+        with:
+          gradle-version: 7.6
+
+      - name: Build with Gradle
+        run: ./gradlew build --no-build-cache

.github/workflows/licenses-update.yml

@@ -0,0 +1,62 @@
+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@v4
+
+      - name: Set up JDK 17
+        uses: actions/setup-java@v4
+        with:
+          java-version: "17"
+          distribution: "adopt"
+
+      - uses: gradle/actions/setup-gradle@v3
+
+      - 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: Set up git config
+        run: |
+          git config --global user.email "GitHub Action <action@github.com>"
+          git config --global user.name "GitHub Action <action@github.com>"
+
+      - name: Run git add
+        run: |
+          git add src/main/resources/static/3rdPartyLicenses.json
+          git diff --staged --quiet || echo "CHANGES_DETECTED=true" >> $GITHUB_ENV
+
+      - name: Create Pull Request
+        if: env.CHANGES_DETECTED == 'true'
+        uses: peter-evans/create-pull-request@v6
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          commit-message: "Update 3rd Party Licenses"
+          committer: GitHub Action <action@github.com>
+          author: GitHub Action <action@github.com>
+          signoff: true
+          branch: update-3rd-party-licenses
+          title: "Update 3rd Party Licenses"
+          body: |
+            Auto-generated by [create-pull-request][1]
+            [1]: https://github.com/peter-evans/create-pull-request
+          draft: false
+          delete-branch: true

.github/workflows/push-docker.yml

@@ -0,0 +1,112 @@
+name: Push Docker Image with VersionNumber
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - master
+      - main
+
+permissions:
+  contents: read
+  packages: write
+jobs:
+  push:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up JDK 17
+        uses: actions/setup-java@v4
+        with:
+          java-version: "17"
+          distribution: "temurin"
+
+      - uses: gradle/actions/setup-gradle@v3
+        with:
+          gradle-version: 7.6
+
+      - name: Run Gradle Command
+        run: ./gradlew clean build
+        env:
+          DOCKER_ENABLE_SECURITY: false
+
+      - name: Set up Docker Buildx
+        id: buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Get version number
+        id: versionNumber
+        run: echo "versionNumber=$(./gradlew printVersion --quiet | tail -1)" >> $GITHUB_OUTPUT
+
+      - name: Login to Docker Hub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKER_HUB_USERNAME }}
+          password: ${{ secrets.DOCKER_HUB_API }}
+
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ github.token }}
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+
+      - name: Convert repository owner to lowercase
+        id: repoowner
+        run: echo "lowercase=$(echo ${{ github.repository_owner }} | awk '{print tolower($0)}')" >> $GITHUB_OUTPUT
+
+      - name: Generate tags
+        id: meta
+        uses: docker/metadata-action@v5
+        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: Build and push main Dockerfile
+        uses: docker/build-push-action@v5
+        with:
+          builder: ${{ steps.buildx.outputs.name }}
+          context: .
+          file: ./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@v5
+        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@v5
+        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

.github/workflows/releaseArtifacts.yml

@@ -0,0 +1,75 @@
+name: Release Artifacts
+
+on:
+  workflow_dispatch:
+  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@v4
+
+      - name: Set up JDK 17
+        uses: actions/setup-java@v4
+        with:
+          java-version: "17"
+          distribution: "temurin"
+
+      - uses: gradle/actions/setup-gradle@v3
+        with:
+          gradle-version: 7.6
+
+      - name: Generate jar (With Security=${{ matrix.enable_security }})
+        run: ./gradlew clean createExe
+        env:
+          DOCKER_ENABLE_SECURITY: ${{ matrix.enable_security }}
+
+      - name: Get version number
+        id: versionNumber
+        run: echo "versionNumber=$(./gradlew printVersion --quiet | tail -1)" >> $GITHUB_OUTPUT
+
+      - name: Rename binarie
+        if: matrix.file_suffix != ''
+        run: cp ./build/launch4j/Stirling-PDF.exe ./build/launch4j/Stirling-PDF${{ matrix.file_suffix }}.exe
+
+      - name: Upload Assets binarie
+        uses: actions/upload-artifact@v4
+        with:
+          path: ./build/launch4j/Stirling-PDF${{ matrix.file_suffix }}.exe
+          name: Stirling-PDF${{ matrix.file_suffix }}.exe
+          overwrite: true
+          retention-days: 1
+          if-no-files-found: error
+      - name: Upload binaries to release
+        uses: softprops/action-gh-release@v2
+        with:
+          files: ./build/launch4j/Stirling-PDF${{ matrix.file_suffix }}.exe
+
+      - name: Rename jar binaries
+        run: cp ./build/libs/Stirling-PDF-${{ steps.versionNumber.outputs.versionNumber }}.jar ./build/libs/Stirling-PDF${{ matrix.file_suffix }}.jar
+
+      - name: Upload Assets jar binaries
+        uses: actions/upload-artifact@v4
+        with:
+          path: ./build/libs/Stirling-PDF${{ matrix.file_suffix }}.jar
+          name: Stirling-PDF${{ matrix.file_suffix }}.jar
+          overwrite: true
+          retention-days: 1
+          if-no-files-found: error
+
+      - name: Upload jar binaries to release
+        uses: softprops/action-gh-release@v2
+        with:
+          files: ./build/libs/Stirling-PDF${{ matrix.file_suffix }}.jar

.github/workflows/swagger.yml

@@ -0,0 +1,39 @@
+name: Update Swagger
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - master
+
+jobs:
+  push:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up JDK 17
+        uses: actions/setup-java@v4
+        with:
+          java-version: "17"
+          distribution: "temurin"
+
+      - uses: gradle/actions/setup-gradle@v3
+
+      - 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: Get version number
+        id: versionNumber
+        run: echo "versionNumber=$(./gradlew printVersion --quiet | tail -1)" >> $GITHUB_OUTPUT
+
+      - 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/sync_files.yml

@@ -0,0 +1,90 @@
+name: Sync Files
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - "build.gradle"
+      - "src/main/resources/messages_*.properties"
+      - "scripts/translation_status.toml"
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  sync-versions:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4.1.1
+      - name: Set up Python
+        uses: actions/setup-python@v5.1.0
+        with:
+          python-version: "3.x"
+      - name: Install dependencies
+        run: pip install pyyaml
+      - name: Sync versions
+        run: python .github/scripts/gradle_to_chart.py
+      - name: Set up git config
+        run: |
+          git config --global user.email "GitHub Action <action@github.com>"
+          git config --global user.name "GitHub Action <action@github.com>"
+      - name: Run git add
+        run: |
+          git add .
+          git diff --staged --quiet || git commit -m ":floppy_disk: Sync Versions
+          > Made via sync_files.yml" || echo "no changes"
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v6.0.1
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          commit-message: Update files
+          committer: GitHub Action <action@github.com>
+          author: GitHub Action <action@github.com>
+          signoff: true
+          branch: sync_version
+          title: ":floppy_disk: Update Version"
+          body: |
+            Auto-generated by [create-pull-request][1]
+
+            [1]: https://github.com/peter-evans/create-pull-request
+          draft: false
+          delete-branch: true
+  sync-readme:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4.1.1
+      - name: Set up Python
+        uses: actions/setup-python@v5.1.0
+        with:
+          python-version: "3.x"
+      - name: Install dependencies
+        run: pip install tomlkit
+      - name: Sync README
+        run: python scripts/counter_translation.py
+      - name: Set up git config
+        run: |
+          git config --global user.email "GitHub Action <action@github.com>"
+          git config --global user.name "GitHub Action <action@github.com>"
+      - name: Run git add
+        run: |
+          git add .
+          git diff --staged --quiet || git commit -m ":memo: Sync README
+          > Made via sync_files.yml" || echo "no changes"
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v6.0.1
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          commit-message: Update files
+          committer: GitHub Action <action@github.com>
+          author: GitHub Action <action@github.com>
+          signoff: true
+          branch: sync_readme
+          title: ":memo: Update README: Translation Progress Table"
+          body: |
+            Auto-generated by [create-pull-request][1]
+
+            [1]: https://github.com/peter-evans/create-pull-request
+          draft: false
+          delete-branch: true

.github/workflows/test.yml

@@ -0,0 +1,38 @@
+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@v4
+
+      - name: Set up Java 17
+        uses: actions/setup-java@v4
+        with:
+          java-version: "17"
+          distribution: "adopt"
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Install Docker Compose
+        run: |
+          sudo curl -SL "https://github.com/docker/compose/releases/download/v2.26.1/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,7 +1,127 @@
-node_modules/
-*.code-workspace
-.idea/
-dist/
-android/
-ios/
-releases/
+
+
+### 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

.npmrc

@@ -1 +0,0 @@
-engine-strict=true

.pre-commit-config.yaml

@@ -0,0 +1,37 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.2.1
+    hooks:
+      - id: ruff
+        args:
+          - --fix
+          - --line-length=127
+        files: ^((.github/scripts)/.+)?[^/]+\.py$
+      - id: ruff-format
+        files: ^((.github/scripts)/.+)?[^/]+\.py$
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.2.6
+    hooks:
+      - id: codespell
+        args:
+          - --ignore-words-list=
+          - --skip="./.*,*.csv,*.json,*.ambr"
+          - --quiet-level=2
+        files: \.(properties|html|css|js|py|md)$
+        exclude: (.vscode|.devcontainer|src/main/resources|Dockerfile)
+  - repo: local
+    hooks:
+      - id: check-duplicate-properties-keys
+        name: Check Duplicate Properties Keys
+        entry: python .github/scripts/check_duplicates.py
+        language: python
+        files: ^(src)/.+\.properties$
+  - repo: local
+    hooks:
+      - id: check-html-tabs
+        name: Check HTML for tabs
+        # args: ["--replace_with=  "]
+        entry: python .github/scripts/check_tabulator.py
+        language: python
+        exclude: ^src/main/resources/static/pdfjs/
+        files: ^.*(\.html|\.css|\.js)$

CONTRIBUTE.md

@@ -1,26 +0,0 @@
-# Contribute
-
-This file should introduce you with the concepts and tools used in this project.
-
-## PDF Library Docs
-- [pdf-lib](https://pdf-lib.js.org) - js
-- [pdfcpu](https://pdfcpu.io) - go-wasm
-- [opencv-wasm](https://www.npmjs.com/package/opencv-wasm) - ?-wasm
-- [pdfjs](https://www.npmjs.com/package/pdfjs-dist) - js
-
-## Adding a PDF Operation
-StirlingPDF aims to support as many types of operations as possible, including some that cannot be executed in the client. Because of this, we have decided to move some of the shared functionality into it's own node module so that it can be shared by both client and server.
-
-### Adding a shared (server + client) operation
-1. Add the code for the operation to a new file in the [functions folder](/shared-operations/functions/). 
-
-> **NOTE:** many of the functions in these files use **dependency injection** (see impose for an example).
-> 
-> **Explanation:** Because some libraries need to be imported in different ways. We import the library as needed in the ```pdf-operations.js``` files, then pass the required library objects into the operation function as a parameter.
-
-2. Now that we have the function code, we need to tell the other modules that it exists. Edit the [server operations](/server-node/src/pdf-operations.js) and the [client operations](/client-ionic/src/utils/pdf-operations.ts) files to add your new operation! (Try to follow existing patterns where possible, keep the added operations in alphabetical order in the files).
-   
-3. If you added a wrapper function to the [client operations](/client-ionic/src/utils/pdf-operations.ts) file, you will also need to add the TypeScript declarations to the [declaration](/client-ionic/declarations/shared-operations.d.ts) file. See the other module declarations for examples.
-
-### Adding a server only operation
-> WIP

CONTRIBUTING.md

@@ -0,0 +1,44 @@
+# Contributing to Stirling-PDF
+
+Thank you for your interest in contributing to Stirling-PDF! There are many ways to contribute other than writing code. For example, reporting bugs, creating suggestions, and adding or modifying translations.
+
+## Issue Guidelines
+
+Issues can be used to report bugs, request features, or ask questions. If you have a question, you could also ask us in our [Discord](https://discord.gg/FJUSXUSYec).
+
+Before opening an issue, please check to make sure someone hasn't already opened an issue about it.
+
+## Pull Requests
+
+Before you start working on an issue, please comment on (or create) the issue and wait for it to be assigned to you. If someone has already been assigned but didn't have the time to work on it lately, please communicate with them and ask if they're still working on it. This is to avoid multiple people working on the same issue.
+
+Once you have been assigned an issue, you can start working on it. When you are ready to submit your changes, open a pull request.
+For a detailed pull request tutorial, see [this guide](https://www.digitalocean.com/community/tutorials/how-to-create-a-pull-request-on-github).
+
+Please make sure your Pull Request adheres to the following guidelines:
+
+- Use the PR template provided.
+- Keep your Pull Request title succinct, detailed and to the point.
+- Keep commits atomic. One commit should contain one change. If you want to make multiple changes, submit multiple Pull Requests.
+- Commits should be clear, concise and easy to understand.
+- References to the Issue number in the Pull Request and/or Commit message.
+
+## Translations
+
+If you would like to add or modify a translation, please see [How to add new languages to Stirling-PDF](HowToAddNewLanguage.md). Also, please create a Pull Request so others can use it!
+
+## Docs
+
+Documentation for Stirling-PDF is handled in a seperate repository. Please see [Docs repository](https://github.com/Stirling-Tools/Stirling-Tools.github.io) or use "edit this page"-button at the bottom of each page at [https://stirlingtools.com/docs/](https://stirlingtools.com/docs/).
+
+## Fixing Bugs or Adding a New Feature
+
+First, make sure you've read the section [Pull Requests](#pull-requests).
+
+To build from source, please follow this [Guide](LocalRunGuide.md).
+
+If, at any point of time, you have a question, please feel free to ask in the same issue thread or in our [Discord](https://discord.gg/FJUSXUSYec).
+
+## License
+
+By contributing to this project, you agree that your contributions will be licensed under the [GPL 3 License](LICENSE). You also acknowledge and agree that your contributions will be included in Stirling-PDF and that they can be relicensed in the future under the MPL 2.0 (Mozilla Public License Version 2.0) license.

Dockerfile

@@ -0,0 +1,70 @@
+# Main stage
+FROM alpine:20240329
+
+# 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
+
+ARG VERSION_TAG
+
+
+# Set Environment Variables
+ENV DOCKER_ENABLE_SECURITY=false \
+    VERSION_TAG=$VERSION_TAG \
+    JAVA_TOOL_OPTIONS="$JAVA_TOOL_OPTIONS -XX:MaxRAMPercentage=75" \
+	HOME=/home/stirlingpdfuser \
+	PUID=1000 \
+    PGID=1000 \
+    UMASK=022
+
+
+# JDK for app
+RUN echo "@testing https://dl-cdn.alpinelinux.org/alpine/edge/main" | tee -a /etc/apk/repositories && \
+    echo "@testing https://dl-cdn.alpinelinux.org/alpine/edge/community" | tee -a /etc/apk/repositories && \
+    echo "@testing https://dl-cdn.alpinelinux.org/alpine/edge/testing" | tee -a /etc/apk/repositories && \
+    apk update && \
+    apk add --no-cache \
+        ca-certificates \
+        tzdata \
+        tini \
+        openssl \
+openssl-dev \
+        bash \
+        curl \
+        openjdk21-jre \
+        su-exec \
+        shadow \
+# Doc conversion
+        libreoffice@testing \
+# pdftohtml
+        poppler-utils \
+# OCR MY PDF (unpaper for descew and other advanced featues)
+        ocrmypdf \
+        tesseract-ocr-data-eng \
+# CV
+        py3-opencv \
+# python3/pip
+        python3 && \
+    wget https://bootstrap.pypa.io/get-pip.py -qO - | python3 - --break-system-packages --no-cache-dir --upgrade && \
+# uno unoconv and HTML
+    pip install --break-system-packages --no-cache-dir --upgrade unoconv WeasyPrint && \
+    mv /usr/share/tessdata /usr/share/tessdata-original && \
+    mkdir -p $HOME /configs /logs /customFiles /pipeline/watchedFolders /pipeline/finishedFolders && \
+    fc-cache -f -v && \
+    chmod +x /scripts/* && \
+    chmod +x /scripts/init.sh && \
+# User permissions
+    addgroup -S stirlingpdfgroup && adduser -S stirlingpdfuser -G stirlingpdfgroup && \
+    chown -R stirlingpdfuser:stirlingpdfgroup $HOME /scripts /usr/share/fonts/opentype/noto /configs /customFiles /pipeline && \
+    chown stirlingpdfuser:stirlingpdfgroup /app.jar && \
+    tesseract --list-langs && \
+    rm -rf /var/cache/apk/*
+
+EXPOSE 8080
+
+# Set user and run command
+ENTRYPOINT ["tini", "--", "/scripts/init.sh"]
+CMD ["java", "-Dfile.encoding=UTF-8", "-jar", "/app.jar"]

Dockerfile-ultra-lite

@@ -0,0 +1,51 @@
+# use alpine
+FROM alpine:3.19.1
+
+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
+
+# 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 build/libs/*.jar app.jar
+
+
+# Set up necessary directories and permissions
+
+RUN mkdir /configs /logs /customFiles && \
+    chmod +x /scripts/*.sh && \
+    apk add --no-cache \
+        ca-certificates \
+        tzdata \
+        tini \
+        bash \
+        curl \
+        su-exec \
+        shadow \
+        openjdk21-jre && \
+    echo "@testing https://dl-cdn.alpinelinux.org/alpine/edge/main" | tee -a /etc/apk/repositories && \
+    echo "@testing https://dl-cdn.alpinelinux.org/alpine/edge/community" | tee -a /etc/apk/repositories && \
+    echo "@testing https://dl-cdn.alpinelinux.org/alpine/edge/testing" | tee -a /etc/apk/repositories && \
+    # User permissions
+    addgroup -S stirlingpdfgroup && adduser -S stirlingpdfuser -G stirlingpdfgroup && \
+    chown -R stirlingpdfuser:stirlingpdfgroup $HOME /scripts  /configs /customFiles /pipeline && \
+    chown stirlingpdfuser:stirlingpdfgroup /app.jar    
+
+# Set environment variables
+ENV ENDPOINTS_GROUPS_TO_REMOVE=CLI
+
+EXPOSE 8080
+
+ENTRYPOINT ["tini", "--", "/scripts/init-without-ocr.sh"]
+
+# Run the application
+CMD ["java", "-Dfile.encoding=UTF-8", "-jar", "/app.jar"]

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,33 @@
+## User Guide for Local Directory Scanning and File Processing
+
+### 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

@@ -0,0 +1,51 @@
+<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>
+
+
+# How to add new languages to Stirling-PDF
+
+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/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 isn't 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
+```html
+<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/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
+
+
+Then simply translate all property entries within that file and make a PR into main for others to use!
+
+If you do not have a java IDE i am happy to verify the changes worked once you raise PR (but won't be able to verify the translations themselves)
+
+## Handling Untranslatable Strings
+
+Sometimes, certain strings in the properties file may not require translation because they are the same in the target language or are universal (like names of protocols, certain terminologies, etc.). To ensure accurate statistics for language progress, these strings should be added to the `ignore_translation.toml` file located in the `scripts` directory. This will exclude them from the translation progress calculations.
+
+For example, if the English string error=Error does not need translation in Polish, add it to the ignore_translation.toml under the Polish section:
+
+```toml
+[pl_PL]
+ignore = [
+    "language.direction",  # Existing entries
+    "error"                # Add new entries here
+]
+```
+
+Make sure to place the entry under the correct language section. This helps maintain the accuracy of translation progress statistics and ensures that the translation tool or scripts do not misinterpret the completion rate.

HowToUseOCR.md

@@ -0,0 +1,79 @@
+# OCR Language Packs and Setup
+
+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 doesn't!
+The paths have changed for the tessadata locations on new docker images, please use ``/usr/share/tessdata`` (Others should still work for backwards compatibility but might not)
+
+## How does the OCR Work
+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
+
+Tesseract OCR supports a variety of languages. You can find additional language packs in the Tesseract GitHub repositories:
+
+- [tessdata_fast](https://github.com/tesseract-ocr/tessdata_fast): These language packs are smaller and faster to load, but may provide lower recognition accuracy.
+- [tessdata](https://github.com/tesseract-ocr/tessdata): These language packs are larger and provide better recognition accuracy, but may take longer to load.
+
+Depending on your requirements, you can choose the appropriate language pack for your use case. By default Stirling-PDF uses the tessdata_fast eng but this can be replaced.
+
+### 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/tessdata`
+
+# DO NOT REMOVE EXISTING ENG.TRAINEDDATA, IT'S REQUIRED.
+
+#### Docker
+
+If you are using Docker, you need to expose the Tesseract tessdata directory as a volume in order to use the additional language packs.
+#### Docker Compose
+Modify your `docker-compose.yml` file to include the following volume configuration:
+
+
+```yaml
+services:
+  your_service_name:
+    image: your_docker_image_name
+    volumes:
+      - /location/of/trainingData:/usr/share/tessdata
+```
+
+
+#### Docker run
+Add the following to your existing docker run command
+```bash
+-v /location/of/trainingData:/usr/share/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

@@ -0,0 +1,45 @@
+pipeline {
+    agent any
+    stages {
+        stage('Build') {
+            steps {
+				sh 'chmod 755 gradlew'
+                sh './gradlew build'
+            }
+        }
+        stage('Docker Build') {
+            steps {
+                script {
+                    def appVersion = sh(returnStdout: true, script: './gradlew printVersion -q').trim()
+                    def image = "frooodle/s-pdf:$appVersion"
+                    sh "docker build -t $image ."
+                }
+            }
+        }
+        stage('Docker Push') {
+            steps {
+                script {
+                    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 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

@@ -0,0 +1,674 @@
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ 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.
+
+                            Preamble
+
+  The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+  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.
+
+  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.
+
+  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.
+
+  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.
+
+  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.
+
+  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.
+
+  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.
+
+  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.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                       TERMS AND CONDITIONS
+
+  0. Definitions.
+
+  "This License" refers to version 3 of the GNU General Public License.
+
+  "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+  "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.
+
+  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.
+
+  A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+  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.
+
+  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.
+
+  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.
+
+  1. Source Code.
+
+  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.
+
+  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.
+
+  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.
+
+  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.
+
+  The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+  The Corresponding Source for a work in source code form is that
+same work.
+
+  2. Basic Permissions.
+
+  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.
+
+  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,335 @@
+
+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 (21 recommended)
+
+- 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++ openjdk-21-jdk 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-21-openjdk python3 python3-pip
+```
+
+For non-root users with Nix Package Manager, use the following command:
+```bash
+nix-channel --update
+nix-env -iA nixpkgs.jdk21 nixpkgs.git nixpkgs.python38 nixpkgs.gnumake nixpkgs.libgcc nixpkgs.automake nixpkgs.autoconf nixpkgs.libtool nixpkgs.pkg-config nixpkgs.zlib nixpkgs.leptonica
+```
+
+### Step 2: Clone and Build jbig2enc (Only required for certain OCR functionality)
+
+For Debian and Fedora, you can build it from source using the following commands:
+
+```bash
+mkdir ~/.git
+cd ~/.git &&\
+git clone https://github.com/agl/jbig2enc.git &&\
+cd jbig2enc &&\
+./autogen.sh &&\
+./configure &&\
+make &&\
+sudo make install
+```
+
+For Nix, you will face `Leptonica not detected`. Bypass this by installing it directly using the following command:
+```bash
+nix-env -iA nixpkgs.jbig2enc
+```
+
+### Step 3: Install Additional Software
+Next we need to install LibreOffice for conversions, ocrmypdf for OCR, and opencv for pattern 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 --break-system-packages
+```
+
+For Fedora:
+
+```bash
+sudo dnf install -y libreoffice-writer libreoffice-calc libreoffice-impress unpaper ocrmypdf
+pip3 install uno opencv-python-headless unoconv pngquant WeasyPrint
+```
+
+For Nix:
+
+```bash
+nix-env -iA nixpkgs.unpaper nixpkgs.libreoffice nixpkgs.ocrmypdf nixpkgs.poppler_utils
+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."
+```
+
+For non-root users, you can just keep the jar in the main directory of Stirling-PDF using the following command:
+```bash
+mv ./build/libs/Stirling-PDF-*.jar ./Stirling-PDF-*.jar
+```
+
+### 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/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'
+```
+
+Nix:
+
+```bash
+nix-env -iA nixpkgs.tesseract
+```
+
+**Note:** Nix Package Manager pre-installs almost all the language packs when tesseract is installed.
+
+### Step 7: Run Stirling-PDF
+
+Those who have pushed to the root directory, run the following commands:
+
+```bash
+./gradlew bootRun
+or
+java -jar /opt/Stirling-PDF/Stirling-PDF-*.jar
+```
+
+Since libreoffice, soffice, and conversion tools have their dbus_tmp_dir set as `dbus_tmp_dir="/run/user/$(id -u)/libreoffice-dbus"`, you might get the following error when using their endpoints:
+```
+[Thread-7] INFO  s.s.SPDF.utils.ProcessExecutor - mkdir: cannot create directory ‘/run/user/1501’: Permission denied
+```
+To resolve this, before starting the Stirling-PDF, you have to set the environment variable to a directory you have write access to by using the following commands:
+
+```bash
+mkdir temp
+export DBUS_SESSION_BUS_ADDRESS="unix:path=./temp"
+./gradlew bootRun
+or
+java -jar ./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: Changing the host and port of the application:
+
+To override the default configuration, you can add the following to `/.git/Stirling-PDF/configs/custom_settings.yml` file:
+
+```bash
+server:
+  host: 0.0.0.0
+  port: 3000
+```
+
+**Note:** This file is created after the first application launch. To have it before that, you can create the directory and add the file yourself.
+
+### Optional: Run Stirling-PDF as a service (requires root).
+
+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 argument to java -jar command:
+
+```bash
+export APP_HOME_NAME="Stirling PDF"
+or
+-DAPP_HOME_NAME="Stirling PDF"
+```

PipelineFeature.md

@@ -0,0 +1,44 @@
+# Pipeline Configuration and Usage Tutorial
+- Configure the pipeline config file and input files to run files against it
+- For reuse, download the config file and re-upload it when needed, or place it in /pipeline/defaultWebUIConfigs/ to auto-load in the web UI for all users
+
+## 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.
+
+    
+### Current Limitations
+- Cannot have more than one of the same operation
+- Cannot input additional files via UI
+- All files and operations run in serial mode
+
+
+    

README.md

@@ -1,223 +1,321 @@
-# StirlingPDF rewrite
+<p align="center"><img src="https://raw.githubusercontent.com/Stirling-Tools/Stirling-PDF/main/docs/stirling.png" width="80" ></p>
+<h1 align="center">Stirling-PDF</h1>
 
-This is the development repository for the new StirlingPDF backend. With the power of JS, WASM & GO this will provide almost all functionality SPDF can do currently directly on the client. For automation purposes this will still provide an API to automate your workflows.
+[![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/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 Sponsor](https://img.shields.io/badge/Github%20Sponsor-yellow?style=flat&logo=github)](https://github.com/sponsors/Frooodle)
 
-## Try the new API!
+[![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)
 
-[![Run in Postman](https://run.pstmn.io/button.svg)](https://documenter.getpostman.com/view/30633786/2s9YRB1Wto)
+This is a robust, locally hosted web-based PDF manipulation tool using Docker. It enables you to carry out various operations on PDF files, including splitting, merging, converting, reorganizing, adding images, rotating, compressing, and more. This locally hosted web application has evolved to encompass a comprehensive set of features, addressing all your PDF requirements.
 
-## Understanding Workflows
+Stirling PDF does not initiate any outbound calls for record-keeping or tracking purposes.
 
-Workflows define how to apply operations to a PDF, including their order and relations with eachother.
+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.
 
-Workflows can be created via the web-ui and then exported or, if you want to brag a bit, you can create the JSON object yourself.
-
-### Basics
-
-To create your own, you have to understand a few key features first. You can also look at more examples our github repository.
-
-```json
-{
-  "outputOptions": {
-    "zip": false
-  },
-  "operations": [
-    {
-      "type": "extract",
-      "values": {
-        "pageIndexes": [0, 2]
-      },
-      "operations": []
-    }
-  ]
-}
-```
-
-The workflow above will extract the first (p\[0\]) and third (p\[2\]) page of the document.
-
-You can also nest workflows like this:
-
-```json
-{
-  "outputOptions": {
-    "zip": false
-  },
-  "operations": [
-    {
-      "type": "extract",
-      "values": {
-        "pageIndexes": [0, 2]
-      },
-      "operations": [
-        {
-          "type": "impose",
-          "values": {
-            "nup": 2, // 2 pages of the input document will be put on one page of the output document.
-            "format": "A4L" // A4L -> The page size of the Ouput will be an A4 in Landscape. You can also use other paper formats and "P" for portrait output. 
-          },
-          "operations": []
-        }
-      ]
-    }
-  ]
-}
-```
-
-If you look at it closely, you will see that the extract operation has another nested operation of the type impose. This workflow will produce a PDF with the 1st and 2nd page of the input on one single page.
-
-### Advanced
-
-If that is not enought for you usecase, there is also the possibility to connect operations with eachother.
-
-You can also do different operations to produce two different output PDFs from one input.
-
-If you are interested in learning about this, take a look at the Example workflows provided in the repository, ask on the discord, or wait for me to finish this documentation.
+![stirling-home](images/stirling-home.jpg)
 
 ## Features
 
-### Rewrite Roadmap
+- Dark mode support.
+- 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)
 
-* [x] Client side PDF-Manipulation
-* [x] Workflows
-* [ ] Feature equivalent with S-PDF v1
-* [ ] Stateful UI
-* [ ] Node based editing of Workflows
-* [ ] Propper auth using passportjs
+## **PDF Features**
 
-### Functions
+### **Page Operations**
 
-Current functions of spdf and their progress in this repo.
+- 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.
 
-#### Page Operations
-| Status | Feature                  | Description |
-| ------ | ------------------------ | ----------- |
-| 🚧A    | Merge                    |             |
-| 🚧A    | Split                    |             |
-| 🚧A    | Organize                 |             |
-| 🚧S    | Rotate                   |             |
-| 🚧A    | Remove Pages             |             |
-| 🚧A    | Multi-Page Layout        |             |
-| ❌     | Adjust page size/scale   |             |
-| 🚧A    | Auto Split Pages         |             |
-| ❌     | Adjust Colours/Contrast  |             |
-| ❌     | Crop                     |             |
-| 🚧A    | Extract Pages            |             |
-| ❌     | PDF to Single large 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)
+Demo of the app is available [here](https://stirlingpdf.io). username: demo, password: demo
+
+## Technologies used
+
+- Spring Boot + Thymeleaf
+- [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
+
+### Docker / Podman
+
+https://hub.docker.com/r/frooodle/s-pdf
+
+Stirling PDF has 2 different versions, a Full version and ultra-Lite version. 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-ultra-lite?label=Stirling-PDF%20Ultra-Lite)
+
+Docker Run
+
+```bash
+docker run -d \
+  -p 8080:8080 \
+  -v /location/of/trainingData:/usr/share/tessdata \
+  -v /location/of/extraConfigs:/configs \
+  -v /location/of/logs:/logs \
+  -e DOCKER_ENABLE_SECURITY=false \
+  -e INSTALL_BOOK_AND_ADVANCED_HTML_OPS=false \
+  -e LANGS=en_GB \
+  --name stirling-pdf \
+  frooodle/s-pdf:latest
 
 
-#### Convert
-| Status | Feature             | Description |
-| ------ | ------------------- | ----------- |
-| ❌     | Image to PDF        |             |
-| 🚧S    | Convert file to PDF |             |
-| ❌     | URL to PDF          |             |
-| ❌     | HTML to PDF         |             |
-| ❌     | Markdown to PDF     |             |
-| ❌     | PDF to Image        |             |
-| ❌     | PDF to Word         |             |
-| ❌     | PDF to Presentation |             |
-| ❌     | PDF to Text/RTF     |             |
-| ❌     | PDF to HTML         |             |
-| ❌     | PDF to PDF/A        |             |
+  Can also add these for customisation but are not required
 
-#### Security
-| Status | Feature               | Description |
-| ------ | --------------------- | ----------- |
-| ❌     | Add Password          |             |
-| ❌     | Remove Password       |             |
-| ❌     | Change Permissions    |             |
-| ❌     | Add Watermark         |             |
-| ❌     | Sign with Certificate |             |
-| ❌     | Sanitize              |             |
-| ❌     | Auto Redact           |             |
+  -v /location/of/customFiles:/customFiles \
+```
 
-#### Miscellaneous
-| Status | Feature                     | Description |
-| ------ | --------------------------- | ----------- |
-| ❌     | OCR                         |             |
-| ❌     | Add image                   |             |
-| ❌     | Compress                    |             |
-| ❌     | Extract Images              |             |
-| 🚧S    | Change Metadata             |             |
-| 🚧A    | Detect/Split Scanned photos |             |
-| ❌     | Sign                        |             |
-| ❌     | Flatten                     |             |
-| ❌     | Repair                      |             |
-| 🚧A    | Remove Blank Pages          |             |
-| ❌     | Compare/Diff                |             |
-| ❌     | Add Page Numbers            |             |
-| ❌     | Auto Rename                 |             |
-| ❌     | Get info                    |             |
-| ❌     | Show JS                     |             |
+Docker Compose
 
+```yaml
+version: '3.3'
+services:
+  stirling-pdf:
+    image: frooodle/s-pdf:latest
+    ports:
+      - '8080:8080'
+    volumes:
+      - /location/of/trainingData:/usr/share/tessdata #Required for extra OCR languages
+      - /location/of/extraConfigs:/configs
+#      - /location/of/customFiles:/customFiles/
+#      - /location/of/logs:/logs/
+    environment:
+      - DOCKER_ENABLE_SECURITY=false
+      - INSTALL_BOOK_AND_ADVANCED_HTML_OPS=false
+      - LANGS=en_GB
+```
 
+Note: Podman is CLI-compatible with Docker, so simply replace "docker" with "podman".
 
+## Enable OCR/Compression feature
 
-✔️: Done, 🚧: Started Developement, ❌: Planned Feature
-A: Available in the internal API, S: Available on the node server, C: Available in the client
+Please view https://github.com/Stirling-Tools/Stirling-PDF/blob/main/HowToUseOCR.md
 
-## Contribute
+## Supported Languages
 
-For initial instructions look at [CONTRIBUTE.md](./CONTRIBUTE.md)
+Stirling PDF currently supports 27!
 
+| Language                                    | Progress                               |
+| ------------------------------------------- | -------------------------------------- |
+| English (English) (en_GB)                   | ![100%](https://geps.dev/progress/100) |
+| English (US) (en_US)                        | ![100%](https://geps.dev/progress/100) |
+| Arabic (العربية) (ar_AR)                    | ![41%](https://geps.dev/progress/41)   |
+| German (Deutsch) (de_DE)                    | ![97%](https://geps.dev/progress/97)   |
+| French (Français) (fr_FR)                   | ![89%](https://geps.dev/progress/89)   |
+| Spanish (Español) (es_ES)                   | ![97%](https://geps.dev/progress/97)   |
+| Simplified Chinese (简体中文) (zh_CN)       | ![96%](https://geps.dev/progress/96)   |
+| Traditional Chinese (繁體中文) (zh_TW)      | ![96%](https://geps.dev/progress/96)   |
+| Catalan (Català) (ca_CA)                    | ![50%](https://geps.dev/progress/50)   |
+| Italian (Italiano) (it_IT)                  | ![99%](https://geps.dev/progress/99)   |
+| Swedish (Svenska) (sv_SE)                   | ![41%](https://geps.dev/progress/41)   |
+| Polish (Polski) (pl_PL)                     | ![43%](https://geps.dev/progress/43)   |
+| Romanian (Română) (ro_RO)                   | ![40%](https://geps.dev/progress/40)   |
+| Korean (한국어) (ko_KR)                     | ![89%](https://geps.dev/progress/89)   |
+| Portuguese Brazilian (Português) (pt_BR)    | ![62%](https://geps.dev/progress/62)   |
+| Russian (Русский) (ru_RU)                   | ![89%](https://geps.dev/progress/89)   |
+| Basque (Euskara) (eu_ES)                    | ![65%](https://geps.dev/progress/65)   |
+| Japanese (日本語) (ja_JP)                   | ![89%](https://geps.dev/progress/89)   |
+| Dutch (Nederlands) (nl_NL)                  | ![86%](https://geps.dev/progress/86)   |
+| Greek (Ελληνικά) (el_GR)                    | ![87%](https://geps.dev/progress/87)   |
+| Turkish (Türkçe) (tr_TR)                    | ![97%](https://geps.dev/progress/97)   |
+| Indonesia (Bahasa Indonesia) (id_ID)        | ![80%](https://geps.dev/progress/80)   |
+| Hindi (हिंदी) (hi_IN)                          | ![81%](https://geps.dev/progress/81)   |
+| Hungarian (Magyar) (hu_HU)                  | ![79%](https://geps.dev/progress/79)   |
+| Bulgarian (Български) (bg_BG)               | ![96%](https://geps.dev/progress/96)   |
+| Sebian Latin alphabet (Srpski) (sr_LATN_RS) | ![82%](https://geps.dev/progress/82)   |
+| Ukrainian (Українська) (uk_UA)              | ![88%](https://geps.dev/progress/88)   |
+| Slovakian (Slovensky) (sk_SK)               | ![96%](https://geps.dev/progress/96)   |
 
+## Contributing (creating issues, translations, fixing bugs, etc.)
 
-/*
-///// CONVERT 2 pdf
-file2pdf
-url2pdf
-html2pdf
-md2pdf
-image2pdf
+Please see our [Contributing Guide](CONTRIBUTING.md)!
 
-///// CONVERT from pdf
-pdf2image
-flatten
-pdf2pdf/a
-pdf2word
-pdf2presentation
-pdf2rtf
-pdf2html
-pdf2xml
+## Customisation
 
-///// SINGLE
-merge
-rotate
-crop
-pageNumbers
-colours/contrast
-addPassword
-removePassword
-compress
-changeMetadata
-change Permissions
-OCR
-sanitise
-repair
-compare
-extract images
-signWith certificate
-impose
-adjust page size/scale
-auto rename
-getAllInfo
-showJS
-redact
-pdf2singleLargePage
+Stirling PDF allows easy customization of the app.
+Includes things like
 
-///// SPLITTING
-split
-auto split
-detect/split scanned
+- Custom application name
+- Custom slogans, icons, HTML, images CSS etc (via file overrides) 
 
-///// REARRANGE
-- organise pages (remove/re-arrange)
-- removePages
-- removeBlank
-- extractPages
+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
 
-///// ADD OBJECTS
-add image
-add watermark
-sign
-*/
+Environment variables are also supported and would override the settings file
+For example in the settings.yml you have
+
+```yaml
+system:
+  defaultLocale: 'en-US'
+```
+
+To have this via an environment variable you would have ``SYSTEM_DEFAULTLOCALE``
+
+The Current list of settings is
+
+```yaml
+security:
+  enableLogin: false # set to 'true' to enable login
+  csrfDisabled: true # Set to 'true' to disable CSRF protection (not recommended for production)
+  loginAttemptCount: 5 # lock user account after 5 tries
+  loginResetTimeMinutes : 120 # lock account for 2 hours after x attempts
+#  initialLogin:
+#    username: "admin" # Initial username for the first login (these are defaulted)
+#    password: "stirling" # Initial password for the first login
+#  oauth2:
+#    enabled: false # set to 'true' to enable login (Note: enableLogin must also be 'true' for this to work)
+#    issuer: "" # set to any provider that supports OpenID Connect Discovery (/.well-known/openid-configuration) end-point
+#    clientId: "" # Client ID from your provider
+#    clientSecret: "" # Client Secret from your provider
+#    autoCreateUser: false # set to 'true' to allow auto-creation of non-existing users
+#    useAsUsername: "email" # Default is 'email'; custom fields can be used as the username
+#    scopes: "openid, profile, email" # Specify the scopes for which the application will request permissions
+#    provider: "google" # Set this to your OAuth provider's name, e.g., 'google' or 'keycloak'
+
+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
+  enableAlphaFunctionality: false # Set to enable functionality which might need more testing before it fully goes live (This feature might make no changes)
+  showUpdate: true # see when a new update is available
+  showUpdateOnlyAdmin: false # Only admins can see when a new update is available, depending on showUpdate it must be set to 'true'
+  customHTMLFiles: false # enable to have files placed in /customFiles/templates override the existing template html files
+
+ui:
+  appName: null # Application's visible name
+  homeDescription: null # Short description or tagline shown on homepage.
+  appNameNavbar: null # 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 (`/api/*`) endpoints, 'false' to disable
+```
+
+There is an additional config file ``/configs/custom_settings.yml`` were users familiar with java and spring application.properties can input their own settings on-top of Stirling-PDFs existing ones
+
+### 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)
+- ``INSTALL_BOOK_AND_ADVANCED_HTML_OPS`` to download calibre onto stirling-pdf enabling pdf to/from book and advanced html conversion
+- ``LANGS`` to define custom font libraries to install for use for document conversions
+
+## 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 users 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 manually or automatically
+
+### 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,52 @@
+| Technology     | Ultra-Lite | Full |
+|----------------|:----------:|:----:|
+| Java           |     ✔️      |  ✔️  |
+| JavaScript     |     ✔️      |  ✔️  |
+| Libre          |            |  ✔️  |
+| Python         |            |  ✔️  |
+| OpenCV         |            |  ✔️  |
+| OCRmyPDF       |            |  ✔️  |
+
+Operation                | Ultra-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               |     ✔️      |  ✔️
+compress-pdf             |            |  ✔️
+extract-image-scans      |            |  ✔️
+ocr-pdf                  |            |  ✔️
+pdf-to-pdfa              |            |  ✔️
+remove-blanks            |            |  ✔️

build.gradle

@@ -0,0 +1,210 @@
+plugins {
+    id 'java'
+    id 'org.springframework.boot' version '3.2.4'
+    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.25.0'
+    id 'com.github.jk1.dependency-license-report' version '2.6'
+}
+
+import com.github.jk1.license.render.*
+
+group = 'stirling.software'
+version = '0.24.1'
+
+//17 is lowest but we support and recommend 21
+sourceCompatibility = '17'
+
+repositories {
+    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 21?"
+  downloadUrl="https://download.oracle.com/java/21/latest/jdk-21_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 21."
+  messagesLauncherError="Java is corrupted. Please uninstall and then install  Java 21."
+  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 {
+    //security updates
+    implementation 'ch.qos.logback:logback-classic:1.5.3'
+    implementation 'ch.qos.logback:logback-core:1.5.3'
+    implementation 'org.springframework:spring-webmvc:6.1.5'
+
+    implementation("io.github.pixee:java-security-toolkit:1.1.3")
+
+    implementation 'org.yaml:snakeyaml:2.2'
+    implementation 'org.springframework.boot:spring-boot-starter-web:3.2.4'
+    implementation 'org.springframework.boot:spring-boot-starter-thymeleaf:3.2.4'
+
+    if (System.getenv('DOCKER_ENABLE_SECURITY') != 'false') {
+        implementation 'org.springframework.boot:spring-boot-starter-security:3.2.4'
+        implementation 'org.thymeleaf.extras:thymeleaf-extras-springsecurity5:3.1.2.RELEASE'
+        implementation "org.springframework.boot:spring-boot-starter-data-jpa:3.2.4"
+        implementation 'org.springframework.boot:spring-boot-starter-oauth2-client:3.2.4'
+
+        //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.4'
+
+    // 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:3.0.2'){
+        exclude group: 'commons-logging', module: 'commons-logging'
+    }
+
+    implementation ('org.apache.pdfbox:xmpbox:3.0.2'){
+        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:3.2.4'
+    implementation 'io.micrometer:micrometer-core:1.12.4'
+    implementation group: 'com.google.zxing', name: 'core', version: '3.5.3'
+    // https://mvnrepository.com/artifact/org.commonmark/commonmark
+    implementation 'org.commonmark:commonmark:0.22.0'
+    implementation 'org.commonmark:commonmark-ext-gfm-tables:0.22.0'
+    // https://mvnrepository.com/artifact/com.github.vladimir-bukhtoyarov/bucket4j-core
+    implementation 'com.github.vladimir-bukhtoyarov:bucket4j-core:7.6.0'
+
+	implementation 'com.fathzer:javaluator:3.0.3'
+
+    developmentOnly("org.springframework.boot:spring-boot-devtools:3.2.4")
+    compileOnly 'org.projectlombok:lombok:1.18.32'
+    annotationProcessor 'org.projectlombok:lombok:1.18.32'
+}
+
+tasks.withType(JavaCompile) {
+    dependsOn 'spotlessApply'
+}
+compileJava {
+    options.compilerArgs << '-parameters'
+}
+
+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()
+}
+
+task printVersion {
+  println project.version
+}

chart/stirling-pdf/Chart.yaml

@@ -0,0 +1,16 @@
+apiVersion: v2
+appVersion: 0.24.0
+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: UI_APP_NAME
+#   value: "Stirling PDF"
+# - name: UI_HOME_DESCRIPTION
+#   value: "Your locally hosted one-stop-shop for all your PDF needs."
+# - name: UI_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:
+

client-ionic/capacitor.config.ts

@@ -1,12 +0,0 @@
-import { CapacitorConfig } from '@capacitor/cli';
-
-const config: CapacitorConfig = {
-  appId: 'com.stirlingtools.pdf',
-  appName: 'StirlingPDF',
-  webDir: 'dist',
-  server: {
-    androidScheme: 'https'
-  }
-};
-
-export default config;

client-ionic/cypress.config.ts

@@ -1,10 +0,0 @@
-import { defineConfig } from "cypress";
-
-export default defineConfig({
-  e2e: {
-    baseUrl: "http://localhost:5173",
-    setupNodeEvents(on, config) {
-      // implement node event listeners here
-    },
-  },
-});

client-ionic/cypress/e2e/test.cy.ts

@@ -1,6 +0,0 @@
-describe('My First Test', () => {
-  it('Visits the app root url', () => {
-    cy.visit('/')
-    cy.contains('#container', 'Ready to create an app?')
-  })
-})

client-ionic/cypress/fixtures/example.json

@@ -1,5 +0,0 @@
-{
-  "name": "Using fixtures to represent data",
-  "email": "hello@cypress.io",
-  "body": "Fixtures are a great way to mock data for responses to routes"
-}

client-ionic/cypress/support/commands.ts

@@ -1,37 +0,0 @@
-/// <reference types="cypress" />
-// ***********************************************
-// This example commands.ts shows you how to
-// create various custom commands and overwrite
-// existing commands.
-//
-// For more comprehensive examples of custom
-// commands please read more here:
-// https://on.cypress.io/custom-commands
-// ***********************************************
-//
-//
-// -- This is a parent command --
-// Cypress.Commands.add('login', (email, password) => { ... })
-//
-//
-// -- This is a child command --
-// Cypress.Commands.add('drag', { prevSubject: 'element'}, (subject, options) => { ... })
-//
-//
-// -- This is a dual command --
-// Cypress.Commands.add('dismiss', { prevSubject: 'optional'}, (subject, options) => { ... })
-//
-//
-// -- This will overwrite an existing command --
-// Cypress.Commands.overwrite('visit', (originalFn, url, options) => { ... })
-//
-// declare global {
-//   namespace Cypress {
-//     interface Chainable {
-//       login(email: string, password: string): Chainable<void>
-//       drag(subject: string, options?: Partial<TypeOptions>): Chainable<Element>
-//       dismiss(subject: string, options?: Partial<TypeOptions>): Chainable<Element>
-//       visit(originalFn: CommandOriginalFn, url: string, options: Partial<VisitOptions>): Chainable<Element>
-//     }
-//   }
-// }

client-ionic/cypress/support/e2e.ts

@@ -1,20 +0,0 @@
-// ***********************************************************
-// This example support/e2e.ts is processed and
-// loaded automatically before your test files.
-//
-// This is a great place to put global configuration and
-// behavior that modifies Cypress.
-//
-// You can change the location of this file or turn off
-// automatically serving support files with the
-// 'supportFile' configuration option.
-//
-// You can read more here:
-// https://on.cypress.io/configuration
-// ***********************************************************
-
-// Import commands.js using ES2015 syntax:
-import './commands'
-
-// Alternatively you can use CommonJS syntax:
-// require('./commands')

client-ionic/index.html

@@ -1,33 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-  <head>
-    <meta charset="utf-8" />
-    <title>Ionic App</title>
-    
-    <base href="/" />
-    
-    <meta name="color-scheme" content="light dark" />
-    <meta
-      name="viewport"
-      content="viewport-fit=cover, width=device-width, initial-scale=1.0, minimum-scale=1.0, maximum-scale=1.0, user-scalable=no"
-    />
-    <meta name="format-detection" content="telephone=no" />
-    <meta name="msapplication-tap-highlight" content="no" />
-    
-    <link rel="manifest" href="/manifest.json" />
-    
-    <link rel="shortcut icon" type="image/png" href="/favicon.png" />
-    
-    <!-- add to homescreen for ios -->
-    <meta name="apple-mobile-web-app-capable" content="yes" />
-    <meta name="apple-mobile-web-app-title" content="Ionic App" />
-    <meta name="apple-mobile-web-app-status-bar-style" content="black" />
-    
-    <!-- TODO: I have no idea if this will build: -->
-    <script src="/src/utils/browserfs.min.js"></script>
-  </head>
-  <body>
-    <div id="root"></div>
-    <script type="module" src="/src/main.tsx"></script>
-  </body>
-</html>

client-ionic/ionic.config.json

@@ -1,7 +0,0 @@
-{
-  "name": "StirlingPDF",
-  "integrations": {
-    "capacitor": {}
-  },
-  "type": "react-vite"
-}

client-ionic/ionic.starter.json

@@ -1,12 +0,0 @@
-{
-  "name": "Blank Starter",
-  "baseref": "main",
-  "tarignore": [
-    "node_modules",
-    "package-lock.json",
-    "www"
-  ],
-  "scripts": {
-    "test": "npm run build && npm run test.unit -- --watch=false && npm i --no-save concurrently && ./node_modules/.bin/concurrently \"npm run dev\" \"npm run test.e2e\" --kill-others --success first"
-  }
-}

client-ionic/package.json

@@ -1,58 +0,0 @@
-{
-  "name": "@stirling-pdf/client-ionic",
-  "private": true,
-  "version": "0.0.0",
-  "type": "module",
-  "scripts": {
-    "dev": "ionic serve",
-    "dev-android": "ionic build && ionic cap run android -l --external --open",
-    "linux_build-release-android": "ionic cap build android --no-open --prod && cd android && ./gradlew assembleDebug && mkdir -p ../releases && mv app/build/outputs/apk/debug/app-debug.apk ../releases/StirlingPDF.apk  && echo \"Done packaging APK!!!\"",
-    "linux_build-release-pwa": "ionic build && mkdir -p releases && zip -r releases/pwa.zip dist/ && echo \"Done packaging PWA!!!\"",
-    "build-vite": "tsc && vite build",
-    "preview": "vite preview",
-    "test.e2e": "cypress run",
-    "test.unit": "vitest",
-    "lint": "eslint"
-  },
-  "dependencies": {
-    "@capacitor/android": "5.5.1",
-    "@capacitor/app": "5.0.6",
-    "@capacitor/core": "5.5.1",
-    "@capacitor/haptics": "5.0.6",
-    "@capacitor/ios": "^5.5.1",
-    "@capacitor/keyboard": "5.0.6",
-    "@capacitor/status-bar": "5.0.6",
-    "@capawesome/capacitor-file-picker": "^5.1.1",
-    "@ionic/react": "^7.0.0",
-    "@ionic/react-router": "^7.0.0",
-    "@stirling-pdf/shared-operations": "*",
-    "@types/react-router": "^5.1.20",
-    "@types/react-router-dom": "^5.3.3",
-    "downloadjs": "^1.4.7",
-    "ionicons": "^7.0.0",
-    "pdf-lib": "^1.17.1",
-    "react": "^18.2.0",
-    "react-dom": "^18.2.0",
-    "react-router": "^5.3.4",
-    "react-router-dom": "^5.3.4"
-  },
-  "devDependencies": {
-    "@capacitor/cli": "5.5.1",
-    "@testing-library/jest-dom": "^5.16.5",
-    "@testing-library/react": "^14.0.0",
-    "@testing-library/user-event": "^14.4.3",
-    "@types/downloadjs": "^1.4.5",
-    "@types/react": "^18.0.27",
-    "@types/react-dom": "^18.0.10",
-    "@vitejs/plugin-legacy": "^4.0.2",
-    "@vitejs/plugin-react": "^4.0.1",
-    "cypress": "^13.3.2",
-    "eslint": "^8.35.0",
-    "eslint-plugin-react": "^7.32.2",
-    "jsdom": "^22.1.0",
-    "typescript": "^5.1.6",
-    "vite": "4.5.0",
-    "vite-plugin-pwa": "^0.16.6",
-    "vitest": "^0.32.2"
-  }
-}

client-ionic/public/manifest.json

@@ -1,21 +0,0 @@
-{
-  "short_name": "StirlingPDF",
-  "name": "StirlingPDF",
-  "icons": [
-    {
-      "src": "assets/icon/favicon.png",
-      "sizes": "64x64 32x32 24x24 16x16",
-      "type": "image/x-icon"
-    },
-    {
-      "src": "assets/icon/icon.png",
-      "type": "image/png",
-      "sizes": "512x512",
-      "purpose": "maskable"
-    }
-  ],
-  "start_url": ".",
-  "display": "standalone",
-  "theme_color": "#ffffff",
-  "background_color": "#ffffff"
-}

client-ionic/src/App.test.tsx

@@ -1,8 +0,0 @@
-import React from 'react';
-import { render } from '@testing-library/react';
-import App from './App';
-
-test('renders without crashing', () => {
-  const { baseElement } = render(<App />);
-  expect(baseElement).toBeDefined();
-});

client-ionic/src/App.tsx

@@ -1,42 +0,0 @@
-import { Redirect, Route } from 'react-router-dom';
-import { IonApp, IonRouterOutlet, setupIonicReact } from '@ionic/react';
-import { IonReactRouter } from '@ionic/react-router';
-import Home from './pages/Home';
-
-/* Core CSS required for Ionic components to work properly */
-import '@ionic/react/css/core.css';
-
-/* Basic CSS for apps built with Ionic */
-import '@ionic/react/css/normalize.css';
-import '@ionic/react/css/structure.css';
-import '@ionic/react/css/typography.css';
-
-/* Optional CSS utils that can be commented out */
-import '@ionic/react/css/padding.css';
-import '@ionic/react/css/float-elements.css';
-import '@ionic/react/css/text-alignment.css';
-import '@ionic/react/css/text-transformation.css';
-import '@ionic/react/css/flex-utils.css';
-import '@ionic/react/css/display.css';
-
-/* Theme variables */
-import './theme/variables.css';
-
-setupIonicReact();
-
-const App: React.FC = () => (
-  <IonApp>
-    <IonReactRouter>
-      <IonRouterOutlet>
-        <Route exact path="/home">
-          <Home />
-        </Route>
-        <Route exact path="/">
-          <Redirect to="/home" />
-        </Route>
-      </IonRouterOutlet>
-    </IonReactRouter>
-  </IonApp>
-);
-
-export default App;

client-ionic/src/components/ExploreContainer.css

@@ -1,24 +0,0 @@
-#container {
-  text-align: center;
-  position: absolute;
-  left: 0;
-  right: 0;
-  top: 50%;
-  transform: translateY(-50%);
-}
-
-#container strong {
-  font-size: 20px;
-  line-height: 26px;
-}
-
-#container p {
-  font-size: 16px;
-  line-height: 22px;
-  color: #8c8c8c;
-  margin: 0;
-}
-
-#container a {
-  text-decoration: none;
-}

client-ionic/src/components/ExploreContainer.tsx

@@ -1,14 +0,0 @@
-import './ExploreContainer.css';
-
-interface ContainerProps { }
-
-const ExploreContainer: React.FC<ContainerProps> = () => {
-  return (
-    <div id="container">
-      <strong>Ready to create an app?</strong>
-      <p>Start with Ionic <a target="_blank" rel="noopener noreferrer" href="https://ionicframework.com/docs/components">UI Components</a></p>
-    </div>
-  );
-};
-
-export default ExploreContainer;

client-ionic/src/main.tsx

@@ -1,11 +0,0 @@
-import React from 'react';
-import { createRoot } from 'react-dom/client';
-import App from './App';
-
-const container = document.getElementById('root');
-const root = createRoot(container!);
-root.render(
-  <React.StrictMode>
-    <App />
-  </React.StrictMode>
-);

client-ionic/src/pages/Home.tsx

@@ -1,48 +0,0 @@
-import { IonContent, IonHeader, IonPage, IonTitle, IonToolbar, IonButton } from '@ionic/react';
-import './Home.css';
-import { rotatePages } from '../utils/pdf-operations.js';
-
-import { FilePicker } from '@capawesome/capacitor-file-picker';
-
-import download from 'downloadjs';
-
-console.log(rotatePages);
-async function rotate90() {
-  console.log("Test rotate 90 with Button Click");
-
-  const pickedFiles = await FilePicker.pickFiles({
-    types: ['application/pdf'],
-    multiple: false,
-  });
-  const file = pickedFiles.files[0];
-  
-  const buffer = await file.blob?.arrayBuffer();
-  if (!buffer) return;
-  
-  const rotated = await rotatePages(buffer, 90)
-
-  download(rotated, "Rotated.pdf", "application/pdf");
-}
-
-
-const Home: React.FC = () => {
-  return (
-    <IonPage>
-      <IonHeader>
-        <IonToolbar>
-          <IonTitle>Blank</IonTitle>
-        </IonToolbar>
-      </IonHeader>
-      <IonContent fullscreen>
-        <IonHeader collapse="condense">
-          <IonToolbar>
-            <IonTitle size="large">Blank</IonTitle>
-          </IonToolbar>
-        </IonHeader>
-        <IonButton onClick={rotate90}>Rotate 90</IonButton>
-      </IonContent>
-    </IonPage>
-  );
-};
-
-export default Home;

client-ionic/src/setupTests.ts

@@ -1,14 +0,0 @@
-// jest-dom adds custom jest matchers for asserting on DOM nodes.
-// allows you to do things like:
-// expect(element).toHaveTextContent(/react/i)
-// learn more: https://github.com/testing-library/jest-dom
-import '@testing-library/jest-dom/extend-expect';
-
-// Mock matchmedia
-window.matchMedia = window.matchMedia || function() {
-  return {
-      matches: false,
-      addListener: function() {},
-      removeListener: function() {}
-  };
-};

client-ionic/src/theme/variables.css

@@ -1,242 +0,0 @@
-/* Ionic Variables and Theming. For more info, please see:
-http://ionicframework.com/docs/theming/ */
-
-/** Ionic CSS Variables **/
-:root {
-  /** primary **/
-  --ion-color-primary: #3880ff;
-  --ion-color-primary-rgb: 56, 128, 255;
-  --ion-color-primary-contrast: #ffffff;
-  --ion-color-primary-contrast-rgb: 255, 255, 255;
-  --ion-color-primary-shade: #3171e0;
-  --ion-color-primary-tint: #4c8dff;
-
-  /** secondary **/
-  --ion-color-secondary: #3dc2ff;
-  --ion-color-secondary-rgb: 61, 194, 255;
-  --ion-color-secondary-contrast: #ffffff;
-  --ion-color-secondary-contrast-rgb: 255, 255, 255;
-  --ion-color-secondary-shade: #36abe0;
-  --ion-color-secondary-tint: #50c8ff;
-
-  /** tertiary **/
-  --ion-color-tertiary: #5260ff;
-  --ion-color-tertiary-rgb: 82, 96, 255;
-  --ion-color-tertiary-contrast: #ffffff;
-  --ion-color-tertiary-contrast-rgb: 255, 255, 255;
-  --ion-color-tertiary-shade: #4854e0;
-  --ion-color-tertiary-tint: #6370ff;
-
-  /** success **/
-  --ion-color-success: #2dd36f;
-  --ion-color-success-rgb: 45, 211, 111;
-  --ion-color-success-contrast: #ffffff;
-  --ion-color-success-contrast-rgb: 255, 255, 255;
-  --ion-color-success-shade: #28ba62;
-  --ion-color-success-tint: #42d77d;
-
-  /** warning **/
-  --ion-color-warning: #ffc409;
-  --ion-color-warning-rgb: 255, 196, 9;
-  --ion-color-warning-contrast: #000000;
-  --ion-color-warning-contrast-rgb: 0, 0, 0;
-  --ion-color-warning-shade: #e0ac08;
-  --ion-color-warning-tint: #ffca22;
-
-  /** danger **/
-  --ion-color-danger: #eb445a;
-  --ion-color-danger-rgb: 235, 68, 90;
-  --ion-color-danger-contrast: #ffffff;
-  --ion-color-danger-contrast-rgb: 255, 255, 255;
-  --ion-color-danger-shade: #cf3c4f;
-  --ion-color-danger-tint: #ed576b;
-
-  /** dark **/
-  --ion-color-dark: #222428;
-  --ion-color-dark-rgb: 34, 36, 40;
-  --ion-color-dark-contrast: #ffffff;
-  --ion-color-dark-contrast-rgb: 255, 255, 255;
-  --ion-color-dark-shade: #1e2023;
-  --ion-color-dark-tint: #383a3e;
-
-  /** medium **/
-  --ion-color-medium: #92949c;
-  --ion-color-medium-rgb: 146, 148, 156;
-  --ion-color-medium-contrast: #ffffff;
-  --ion-color-medium-contrast-rgb: 255, 255, 255;
-  --ion-color-medium-shade: #808289;
-  --ion-color-medium-tint: #9d9fa6;
-
-  /** light **/
-  --ion-color-light: #f4f5f8;
-  --ion-color-light-rgb: 244, 245, 248;
-  --ion-color-light-contrast: #000000;
-  --ion-color-light-contrast-rgb: 0, 0, 0;
-  --ion-color-light-shade: #d7d8da;
-  --ion-color-light-tint: #f5f6f9;
-}
-
-@media (prefers-color-scheme: dark) {
-  /*
-   * Dark Colors
-   * -------------------------------------------
-   */
-
-  body {
-    --ion-color-primary: #428cff;
-    --ion-color-primary-rgb: 66,140,255;
-    --ion-color-primary-contrast: #ffffff;
-    --ion-color-primary-contrast-rgb: 255,255,255;
-    --ion-color-primary-shade: #3a7be0;
-    --ion-color-primary-tint: #5598ff;
-
-    --ion-color-secondary: #50c8ff;
-    --ion-color-secondary-rgb: 80,200,255;
-    --ion-color-secondary-contrast: #ffffff;
-    --ion-color-secondary-contrast-rgb: 255,255,255;
-    --ion-color-secondary-shade: #46b0e0;
-    --ion-color-secondary-tint: #62ceff;
-
-    --ion-color-tertiary: #6a64ff;
-    --ion-color-tertiary-rgb: 106,100,255;
-    --ion-color-tertiary-contrast: #ffffff;
-    --ion-color-tertiary-contrast-rgb: 255,255,255;
-    --ion-color-tertiary-shade: #5d58e0;
-    --ion-color-tertiary-tint: #7974ff;
-
-    --ion-color-success: #2fdf75;
-    --ion-color-success-rgb: 47,223,117;
-    --ion-color-success-contrast: #000000;
-    --ion-color-success-contrast-rgb: 0,0,0;
-    --ion-color-success-shade: #29c467;
-    --ion-color-success-tint: #44e283;
-
-    --ion-color-warning: #ffd534;
-    --ion-color-warning-rgb: 255,213,52;
-    --ion-color-warning-contrast: #000000;
-    --ion-color-warning-contrast-rgb: 0,0,0;
-    --ion-color-warning-shade: #e0bb2e;
-    --ion-color-warning-tint: #ffd948;
-
-    --ion-color-danger: #ff4961;
-    --ion-color-danger-rgb: 255,73,97;
-    --ion-color-danger-contrast: #ffffff;
-    --ion-color-danger-contrast-rgb: 255,255,255;
-    --ion-color-danger-shade: #e04055;
-    --ion-color-danger-tint: #ff5b71;
-
-    --ion-color-dark: #f4f5f8;
-    --ion-color-dark-rgb: 244,245,248;
-    --ion-color-dark-contrast: #000000;
-    --ion-color-dark-contrast-rgb: 0,0,0;
-    --ion-color-dark-shade: #d7d8da;
-    --ion-color-dark-tint: #f5f6f9;
-
-    --ion-color-medium: #989aa2;
-    --ion-color-medium-rgb: 152,154,162;
-    --ion-color-medium-contrast: #000000;
-    --ion-color-medium-contrast-rgb: 0,0,0;
-    --ion-color-medium-shade: #86888f;
-    --ion-color-medium-tint: #a2a4ab;
-
-    --ion-color-light: #222428;
-    --ion-color-light-rgb: 34,36,40;
-    --ion-color-light-contrast: #ffffff;
-    --ion-color-light-contrast-rgb: 255,255,255;
-    --ion-color-light-shade: #1e2023;
-    --ion-color-light-tint: #383a3e;
-  }
-
-  /*
-   * iOS Dark Theme
-   * -------------------------------------------
-   */
-
-  .ios body {
-    --ion-background-color: #000000;
-    --ion-background-color-rgb: 0,0,0;
-
-    --ion-text-color: #ffffff;
-    --ion-text-color-rgb: 255,255,255;
-
-    --ion-color-step-50: #0d0d0d;
-    --ion-color-step-100: #1a1a1a;
-    --ion-color-step-150: #262626;
-    --ion-color-step-200: #333333;
-    --ion-color-step-250: #404040;
-    --ion-color-step-300: #4d4d4d;
-    --ion-color-step-350: #595959;
-    --ion-color-step-400: #666666;
-    --ion-color-step-450: #737373;
-    --ion-color-step-500: #808080;
-    --ion-color-step-550: #8c8c8c;
-    --ion-color-step-600: #999999;
-    --ion-color-step-650: #a6a6a6;
-    --ion-color-step-700: #b3b3b3;
-    --ion-color-step-750: #bfbfbf;
-    --ion-color-step-800: #cccccc;
-    --ion-color-step-850: #d9d9d9;
-    --ion-color-step-900: #e6e6e6;
-    --ion-color-step-950: #f2f2f2;
-
-    --ion-item-background: #000000;
-
-    --ion-card-background: #1c1c1d;
-  }
-
-  .ios ion-modal {
-    --ion-background-color: var(--ion-color-step-100);
-    --ion-toolbar-background: var(--ion-color-step-150);
-    --ion-toolbar-border-color: var(--ion-color-step-250);
-  }
-
-
-  /*
-   * Material Design Dark Theme
-   * -------------------------------------------
-   */
-
-  .md body {
-    --ion-background-color: #121212;
-    --ion-background-color-rgb: 18,18,18;
-
-    --ion-text-color: #ffffff;
-    --ion-text-color-rgb: 255,255,255;
-
-    --ion-border-color: #222222;
-
-    --ion-color-step-50: #1e1e1e;
-    --ion-color-step-100: #2a2a2a;
-    --ion-color-step-150: #363636;
-    --ion-color-step-200: #414141;
-    --ion-color-step-250: #4d4d4d;
-    --ion-color-step-300: #595959;
-    --ion-color-step-350: #656565;
-    --ion-color-step-400: #717171;
-    --ion-color-step-450: #7d7d7d;
-    --ion-color-step-500: #898989;
-    --ion-color-step-550: #949494;
-    --ion-color-step-600: #a0a0a0;
-    --ion-color-step-650: #acacac;
-    --ion-color-step-700: #b8b8b8;
-    --ion-color-step-750: #c4c4c4;
-    --ion-color-step-800: #d0d0d0;
-    --ion-color-step-850: #dbdbdb;
-    --ion-color-step-900: #e7e7e7;
-    --ion-color-step-950: #f3f3f3;
-
-    --ion-item-background: #1e1e1e;
-
-    --ion-toolbar-background: #1f1f1f;
-
-    --ion-tab-bar-background: #1f1f1f;
-
-    --ion-card-background: #1e1e1e;
-  }
-}
-
-html {
-  /* For more information on dynamic font scaling, visit the documentation: 
-  https://ionicframework.com/docs/layout/dynamic-font-scaling */
-  --ion-dynamic-font: var(--ion-default-dynamic-font);
-}

client-ionic/src/utils/downloadjs.js

@@ -1,167 +0,0 @@
-//download.js v4.2, by dandavis; 2008-2016. [MIT] see http://danml.com/download.html for tests/usage
-// v1 landed a FF+Chrome compat way of downloading strings to local un-named files, upgraded to use a hidden frame and optional mime
-// v2 added named files via a[download], msSaveBlob, IE (10+) support, and window.URL support for larger+faster saves than dataURLs
-// v3 added dataURL and Blob Input, bind-toggle arity, and legacy dataURL fallback was improved with force-download mime and base64 support. 3.1 improved safari handling.
-// v4 adds AMD/UMD, commonJS, and plain browser support
-// v4.1 adds url download capability via solo URL argument (same domain/CORS only)
-// v4.2 adds semantic variable names, long (over 2MB) dataURL support, and hidden by default temp anchors
-// https://github.com/rndme/download
-
-(function (root, factory) {
-	if (typeof define === 'function' && define.amd) {
-		// AMD. Register as an anonymous module.
-		define([], factory);
-	} else if (typeof exports === 'object') {
-		// Node. Does not work with strict CommonJS, but
-		// only CommonJS-like environments that support module.exports,
-		// like Node.
-		module.exports = factory();
-	} else {
-		// Browser globals (root is window)
-		root.download = factory();
-  }
-}(this, function () {
-
-	return function download(data, strFileName, strMimeType) {
-
-		var self = window, // this script is only for browsers anyway...
-			defaultMime = "application/octet-stream", // this default mime also triggers iframe downloads
-			mimeType = strMimeType || defaultMime,
-			payload = data,
-			url = !strFileName && !strMimeType && payload,
-			anchor = document.createElement("a"),
-			toString = function(a){return String(a);},
-			myBlob = (self.Blob || self.MozBlob || self.WebKitBlob || toString),
-			fileName = strFileName || "download",
-			blob,
-			reader;
-			myBlob= myBlob.call ? myBlob.bind(self) : Blob ;
-	  
-		if(String(this)==="true"){ //reverse arguments, allowing download.bind(true, "text/xml", "export.xml") to act as a callback
-			payload=[payload, mimeType];
-			mimeType=payload[0];
-			payload=payload[1];
-		}
-
-
-		if(url && url.length< 2048){ // if no filename and no mime, assume a url was passed as the only argument
-			fileName = url.split("/").pop().split("?")[0];
-			anchor.href = url; // assign href prop to temp anchor
-		  	if(anchor.href.indexOf(url) !== -1){ // if the browser determines that it's a potentially valid url path:
-        		var ajax=new XMLHttpRequest();
-        		ajax.open( "GET", url, true);
-        		ajax.responseType = 'blob';
-        		ajax.onload= function(e){ 
-				  download(e.target.response, fileName, defaultMime);
-				};
-        		setTimeout(function(){ ajax.send();}, 0); // allows setting custom ajax headers using the return:
-			    return ajax;
-			} // end if valid url?
-		} // end if url?
-
-
-		//go ahead and download dataURLs right away
-		if(/^data:([\w+-]+\/[\w+.-]+)?[,;]/.test(payload)){
-		
-			if(payload.length > (1024*1024*1.999) && myBlob !== toString ){
-				payload=dataUrlToBlob(payload);
-				mimeType=payload.type || defaultMime;
-			}else{			
-				return navigator.msSaveBlob ?  // IE10 can't do a[download], only Blobs:
-					navigator.msSaveBlob(dataUrlToBlob(payload), fileName) :
-					saver(payload) ; // everyone else can save dataURLs un-processed
-			}
-			
-		}else{//not data url, is it a string with special needs?
-			if(/([\x80-\xff])/.test(payload)){			  
-				var i=0, tempUiArr= new Uint8Array(payload.length), mx=tempUiArr.length;
-				for(i;i<mx;++i) tempUiArr[i]= payload.charCodeAt(i);
-			 	payload=new myBlob([tempUiArr], {type: mimeType});
-			}		  
-		}
-		blob = payload instanceof myBlob ?
-			payload :
-			new myBlob([payload], {type: mimeType}) ;
-
-
-		function dataUrlToBlob(strUrl) {
-			var parts= strUrl.split(/[:;,]/),
-			type= parts[1],
-			decoder= parts[2] == "base64" ? atob : decodeURIComponent,
-			binData= decoder( parts.pop() ),
-			mx= binData.length,
-			i= 0,
-			uiArr= new Uint8Array(mx);
-
-			for(i;i<mx;++i) uiArr[i]= binData.charCodeAt(i);
-
-			return new myBlob([uiArr], {type: type});
-		 }
-
-		function saver(url, winMode){
-
-			if ('download' in anchor) { //html5 A[download]
-				anchor.href = url;
-				anchor.setAttribute("download", fileName);
-				anchor.className = "download-js-link";
-				anchor.innerHTML = "downloading...";
-				anchor.style.display = "none";
-				document.body.appendChild(anchor);
-				setTimeout(function() {
-					anchor.click();
-					document.body.removeChild(anchor);
-					if(winMode===true){setTimeout(function(){ self.URL.revokeObjectURL(anchor.href);}, 250 );}
-				}, 66);
-				return true;
-			}
-
-			// handle non-a[download] safari as best we can:
-			if(/(Version)\/(\d+)\.(\d+)(?:\.(\d+))?.*Safari\//.test(navigator.userAgent)) {
-				if(/^data:/.test(url))	url="data:"+url.replace(/^data:([\w\/\-\+]+)/, defaultMime);
-				if(!window.open(url)){ // popup blocked, offer direct download:
-					if(confirm("Displaying New Document\n\nUse Save As... to download, then click back to return to this page.")){ location.href=url; }
-				}
-				return true;
-			}
-
-			//do iframe dataURL download (old ch+FF):
-			var f = document.createElement("iframe");
-			document.body.appendChild(f);
-
-			if(!winMode && /^data:/.test(url)){ // force a mime that will download:
-				url="data:"+url.replace(/^data:([\w\/\-\+]+)/, defaultMime);
-			}
-			f.src=url;
-			setTimeout(function(){ document.body.removeChild(f); }, 333);
-
-		}//end saver
-
-
-
-
-		if (navigator.msSaveBlob) { // IE10+ : (has Blob, but not a[download] or URL)
-			return navigator.msSaveBlob(blob, fileName);
-		}
-
-		if(self.URL){ // simple fast and modern way using Blob and URL:
-			saver(self.URL.createObjectURL(blob), true);
-		}else{
-			// handle non-Blob()+non-URL browsers:
-			if(typeof blob === "string" || blob.constructor===toString ){
-				try{
-					return saver( "data:" +  mimeType   + ";base64,"  +  self.btoa(blob)  );
-				}catch(y){
-					return saver( "data:" +  mimeType   + "," + encodeURIComponent(blob)  );
-				}
-			}
-
-			// Blob but not URL support:
-			reader=new FileReader();
-			reader.onload=function(e){
-				saver(this.result);
-			};
-			reader.readAsDataURL(blob);
-		}
-		return true;
-	}; /* end download() */
-}));

client-ionic/src/utils/pdf-operations.ts

@@ -1,38 +0,0 @@
-
-// Import injected libraries here!
-
-import { Metadata, editMetadata as dependantEditMetadata} from "@stirling-pdf/shared-operations/functions/editMetadata";
-import { extractPages as dependantExtractPages } from "@stirling-pdf/shared-operations/functions/extractPages";
-import { mergePDFs as dependantMergePDFs } from '@stirling-pdf/shared-operations/functions/mergePDFs';
-import { rotatePages as dependantRotatePages } from '@stirling-pdf/shared-operations/functions/rotatePages';
-import { scaleContent as dependantScaleContent} from '@stirling-pdf/shared-operations/functions/scaleContent';
-import { scalePage as dependantScalePage } from '@stirling-pdf/shared-operations/functions/scalePage';
-import { splitPDF as dependantSplitPDF } from '@stirling-pdf/shared-operations/functions/splitPDF';
-
-export async function editMetadata(snapshot: string | Uint8Array | ArrayBuffer, metadata: Metadata) {
-    return dependantEditMetadata(snapshot, metadata);
-}
-
-export async function extractPages(snapshot: string | Uint8Array | ArrayBuffer, pageIndexes: number[]) {
-    return dependantExtractPages(snapshot, pageIndexes);
-}
-
-export async function mergePDFs(snapshots: (string | Uint8Array | ArrayBuffer)[]) {
-    return dependantMergePDFs(snapshots);
-}
-
-export async function rotatePages(snapshot: string | Uint8Array | ArrayBuffer, rotation: number) {
-    return dependantRotatePages(snapshot, rotation);
-}
-
-export async function scaleContent(snapshot: string | Uint8Array | ArrayBuffer, scaleFactor: number) {
-    return dependantScaleContent(snapshot, scaleFactor);
-}
-
-export async function scalePage(snapshot: string | Uint8Array | ArrayBuffer, pageSize: { width: number; height: number; }) {
-    return dependantScalePage(snapshot, pageSize);
-}
-
-export async function splitPDF(snapshot: string | Uint8Array | ArrayBuffer, splitAfterPageArray: number[]) {
-    return dependantSplitPDF(snapshot, splitAfterPageArray);
-}

client-ionic/src/vite-env.d.ts

@@ -1 +0,0 @@
-/// <reference types="vite/client" />

client-ionic/tsconfig.json

@@ -1,24 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "ESNext",
-    "useDefineForClassFields": true,
-    "lib": ["DOM", "DOM.Iterable", "ESNext"],
-    "allowJs": false,
-    "skipLibCheck": true,
-    "esModuleInterop": false,
-    "allowSyntheticDefaultImports": true,
-    "strict": true,
-    "forceConsistentCasingInFileNames": true,
-    "module": "ESNext",
-    "moduleResolution": "Node",
-    "resolveJsonModule": true,
-    "isolatedModules": true,
-    "noEmit": true,
-    "jsx": "react-jsx"
-  },
-  "include": [
-    "src",
-    "declarations/*.d.ts"
-  ],
-  "references": [{ "path": "./tsconfig.node.json" }]
-}

client-ionic/tsconfig.node.json

@@ -1,9 +0,0 @@
-{
-  "compilerOptions": {
-    "composite": true,
-    "module": "ESNext",
-    "moduleResolution": "Node",
-    "allowSyntheticDefaultImports": true
-  },
-  "include": ["vite.config.ts"]
-}

client-ionic/vite.config.ts

@@ -1,18 +0,0 @@
-import legacy from '@vitejs/plugin-legacy'
-import react from '@vitejs/plugin-react'
-import { defineConfig } from 'vite'
-import { VitePWA } from 'vite-plugin-pwa'; // https://ionicframework.com/docs/react/pwa
-
-// https://vitejs.dev/config/
-export default defineConfig({
-  plugins: [
-    react(),
-    VitePWA({ registerType: 'autoUpdate' }),
-    legacy()
-  ],
-  test: {
-    globals: true,
-    environment: 'jsdom',
-    setupFiles: './src/setupTests.ts',
-  }
-})

client-tauri/.gitignore

@@ -1,24 +0,0 @@
-# Logs
-logs
-*.log
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-pnpm-debug.log*
-lerna-debug.log*
-
-node_modules
-dist
-dist-ssr
-*.local
-
-# Editor directories and files
-.vscode/*
-!.vscode/extensions.json
-.idea
-.DS_Store
-*.suo
-*.ntvs*
-*.njsproj
-*.sln
-*.sw?

client-tauri/.vscode/extensions.json

@@ -1,3 +0,0 @@
-{
-  "recommendations": ["tauri-apps.tauri-vscode", "rust-lang.rust-analyzer"]
-}

client-tauri/README.md

@@ -1,7 +0,0 @@
-# Tauri + React + Typescript
-
-This template should help get you started developing with Tauri, React and Typescript in Vite.
-
-## Recommended IDE Setup
-
-- [VS Code](https://code.visualstudio.com/) + [Tauri](https://marketplace.visualstudio.com/items?itemName=tauri-apps.tauri-vscode) + [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer)

client-tauri/index.html

@@ -1,14 +0,0 @@
-<!doctype html>
-<html lang="en">
-  <head>
-    <meta charset="UTF-8" />
-    <link rel="icon" type="image/svg+xml" href="/stirling-pdf-logo.svg" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Tauri + React + TS</title>
-  </head>
-
-  <body>
-    <div id="root"></div>
-    <script type="module" src="/src/main.tsx"></script>
-  </body>
-</html>

client-tauri/package.json

@@ -1,40 +0,0 @@
-{
-  "name": "@stirling-pdf/client-tauri",
-  "private": true,
-  "version": "0.0.0",
-  "type": "module",
-  "scripts": {
-    "dev": "vite",
-    "build": "tsc && vite build",
-    "preview": "vite preview",
-    "tauri": "tauri"
-  },
-  "dependencies": {
-    "@stirling-pdf/shared-operations": "^0.0.0",
-    "@tauri-apps/api": "^1.5.1",
-    "archiver": "^6.0.1",
-    "bootstrap": "^5.3.2",
-    "i18next": "^23.6.0",
-    "i18next-browser-languagedetector": "^7.1.0",
-    "path-browserify": "^1.0.1",
-    "pdfjs-dist": "^4.0.189",
-    "react": "^18.2.0",
-    "react-bootstrap": "^2.9.1",
-    "react-dom": "^18.2.0",
-    "react-i18next": "^13.3.1",
-    "react-icons": "^4.11.0",
-    "react-router-bootstrap": "^0.26.2",
-    "react-router-dom": "^6.18.0",
-    "vite-plugin-top-level-await": "^1.3.1"
-  },
-  "devDependencies": {
-    "@tauri-apps/cli": "^1.5.0",
-    "@types/archiver": "^5.3.4",
-    "@types/react": "^18.2.15",
-    "@types/react-dom": "^18.2.7",
-    "@types/react-router-bootstrap": "^0.26.5",
-    "@vitejs/plugin-react": "^4.0.3",
-    "typescript": "^5.0.2",
-    "vite": "^4.4.4"
-  }
-}

client-tauri/src-tauri/.gitignore

@@ -1,4 +0,0 @@
-# Generated by Cargo
-# will have compiled files and executables
-/target/
-

client-tauri/src-tauri/Cargo.toml

@@ -1,23 +0,0 @@
-[package]
-name = "stirling_pdf"
-version = "0.0.0"
-description = "A Tauri App"
-authors = ["you"]
-license = ""
-repository = ""
-edition = "2021"
-
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
-[build-dependencies]
-tauri-build = { version = "1.5", features = [] }
-
-[dependencies]
-tauri = { version = "1.5", features = [ "fs-remove-dir", "fs-create-dir", "shell-all", "fs-write-file", "fs-read-file", "dialog-save", "dialog-open"] }
-serde = { version = "1.0", features = ["derive"] }
-serde_json = "1.0"
-
-[features]
-# this feature is used for production builds or when `devPath` points to the filesystem
-# DO NOT REMOVE!!
-custom-protocol = ["tauri/custom-protocol"]

client-tauri/src-tauri/build.rs

@@ -1,3 +0,0 @@
-fn main() {
-    tauri_build::build()
-}

client-tauri/src-tauri/src/main.rs

@@ -1,15 +0,0 @@
-// Prevents additional console window on Windows in release, DO NOT REMOVE!!
-#![cfg_attr(not(debug_assertions), windows_subsystem = "windows")]
-
-// Learn more about Tauri commands at https://tauri.app/v1/guides/features/command
-#[tauri::command]
-fn greet(name: &str) -> String {
-    format!("Hello, {}! You've been greeted from Rust!", name)
-}
-
-fn main() {
-    tauri::Builder::default()
-        .invoke_handler(tauri::generate_handler![greet])
-        .run(tauri::generate_context!())
-        .expect("error while running tauri application");
-}

client-tauri/src-tauri/tauri.conf.json

@@ -1,78 +0,0 @@
-{
-  "build": {
-    "beforeDevCommand": "npm run dev",
-    "beforeBuildCommand": "npm run build",
-    "devPath": "http://localhost:1420",
-    "distDir": "../dist",
-    "withGlobalTauri": false
-  },
-  "package": {
-    "productName": "StirlingPDF",
-    "version": "0.0.0"
-  },
-  "tauri": {
-    "allowlist": {
-      "all": false,
-      "shell": {
-        "all": true,
-        "open": true,
-        "scope": [
-          {
-            "name": "libreoffice-version",
-            "cmd": "libreoffice",
-            "args": ["--version"]
-          },{
-            "name": "libreoffice-convert",
-            "cmd": "libreoffice",
-            "args": ["--headless","--convert-to",{ "validator": "\\S+" },{ "validator": "\\S+" },"--outdir",{ "validator": "\\S+" }]
-          }
-        ]
-      },
-      "dialog": {
-        "all": false,
-        "ask": false,
-        "confirm": false,
-        "message": false,
-        "open": true,
-        "save": true
-      },
-      "fs": {
-        "all": false,
-        "readFile": true,
-        "writeFile": true,
-        "readDir": false,
-        "copyFile": false,
-        "createDir": true,
-        "removeDir": true,
-        "removeFile": false,
-        "renameFile": false,
-        "exists": false
-      }
-    },
-    "bundle": {
-      "active": true,
-      "targets": "all",
-      "identifier": "com.stirlingtools.pdf",
-      "icon": [
-        "icons/32x32.png",
-        "icons/128x128.png",
-        "icons/128x128@2x.png",
-        "icons/icon.icns",
-        "icons/icon.ico"
-      ],
-      "category": "Business"
-    },
-    "security": {
-      "csp": null
-    },
-    "windows": [
-      {
-        "fullscreen": false,
-        "resizable": true,
-        "title": "StirlingPDF",
-        "width": 800,
-        "height": 600
-      }
-    ]
-  }
-}