Cleanup, Updated Docs

deleted old/unused code

.git-blame-ignore-revs

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

.gitattributes

@@ -1,10 +0,0 @@
-* 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/pdfjs-legacy/* linguist-vendored
-src/main/resources/static/pdfjs-legacy/** 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 +0,0 @@
-# All PRs to V1 must be approved by Frooodle
-* @Frooodle

.github/ISSUE_TEMPLATE/1-bug.yml

@@ -1,128 +0,0 @@
-name: Bug Report
-description: File a bug report.
-title: "[Bug]: "
-body:
-  - type: markdown
-    attributes:
-      value: |
-        ## Bug Report
-
-        Thanks for taking the time to fill out this bug report!
-
-        This issue form is for reporting bugs only. Please fill out the following sections to help us understand the issue you are facing.
-
-  - type: dropdown
-    id: installation-method
-    attributes:
-      label: Installation Method
-      description: |
-        Indicate whether you are using Docker or a local installation.
-      options:
-        - Docker
-        - Docker ultra lite
-        - Docker fat
-        - Local Installation
-
-  - type: textarea
-    id: problem
-    validations:
-      required: true
-    attributes:
-      label: The Problem
-      description: |
-        Describe the issue you are experiencing here. Tell us what you were trying to do and what happened.
-
-        Provide a clear and concise description of what the problem is.
-      placeholder: Provide a detailed description of the issue.
-
-  - type: markdown
-    attributes:
-      value: |
-        ## Environment
-
-  - type: input
-    id: version
-    validations:
-      required: true
-    attributes:
-      label: Version of Stirling-PDF
-      placeholder: e.g., 0.0.2
-      description: What version of Stirling-PDF has the issue?
-
-  - type: input
-    id: last-working-version
-    attributes:
-      label: Last Working Version of Stirling-PDF
-      placeholder: e.g., 0.0.1
-      description: |
-        If known, please provide the last version where the issue did not occur. Otherwise, leave blank.
-
-  - type: input
-    id: url
-    attributes:
-      label: Page Where the Problem Occurred
-      placeholder: e.g., http://localhost:8080/pdf/pipeline
-      description: |
-        If applicable, provide the URL where the issue occurred. Otherwise, leave blank.
-
-  - type: textarea
-    id: docker
-    attributes:
-      label: Docker Configuration
-      description: |
-        Enter your Docker configuration here if it is relevant to the error. Remove any personal data. Otherwise, leave the field blank.
-      render: txt
-
-  - type: markdown
-    attributes:
-      value: |
-        ## Logs
-
-  - type: textarea
-    id: logs
-    attributes:
-      label: Relevant Log Output
-      description: |
-        Provide any log output that might help us diagnose the issue, such as error messages or stack traces.
-      render: txt
-
-  - type: markdown
-    attributes:
-      value: |
-        ## Additional Information
-
-  - type: textarea
-    id: additional-info
-    attributes:
-      label: Additional Information
-      description: |
-        If you have any additional information that might help us understand and resolve the issue, provide it here.
-
-  - type: markdown
-    attributes:
-      value: |
-        ## Browser Information
-
-  - type: dropdown
-    id: browsers
-    attributes:
-      label: Browsers Affected
-      description: |
-        If applicable, select the browsers where you are experiencing the issue. Otherwise, leave blank.
-      multiple: true
-      options:
-        - Firefox
-        - Chrome
-        - Safari
-        - Microsoft Edge
-        - Other
-
-  - type: checkboxes
-    id: terms
-    attributes:
-      label: No Duplicate of the Issue
-      description: |
-        Please confirm that you have searched for similar issues and none of them match your problem.
-      options:
-        - label: I have verified that there are no existing issues raised related to my problem.
-          required: true

.github/ISSUE_TEMPLATE/2-feature.yml

@@ -1,78 +0,0 @@
-name: Feature Request
-description: Submit a new feature request.
-title: "[Feature Request]: "
-labels:
-  - enhancement
-body:
-  - type: markdown
-    attributes:
-      value: |
-        ## Feature Request
-
-        Thank you for taking the time to suggest a new feature!
-
-        This form is for proposing features or enhancements. Please fill out the following sections to help us understand your idea or suggestion.
-
-  - type: textarea
-    id: feature-description
-    validations:
-      required: true
-    attributes:
-      label: Feature Description
-      description: |
-        Describe the feature you would like to see. Tell us what the feature should do and the problem it would solve.
-
-        Provide a clear and concise description of what you want to happen.
-      placeholder: Provide a detailed description of the desired feature.
-
-  - type: markdown
-    attributes:
-      value: |
-        ## Motivation
-
-  - type: textarea
-    id: motivation
-    attributes:
-      label: Why is this feature valuable?
-      description: |
-        Explain why this feature is valuable to you or others. How would it improve the tool or process?
-
-        Describe any relevant scenarios that would benefit from this feature.
-      placeholder: Describe why this feature is important.
-
-  - type: markdown
-    attributes:
-      value: |
-        ## Possible Implementation
-
-  - type: textarea
-    id: implementation
-    attributes:
-      label: Suggested Implementation
-      description: |
-        If you have ideas about how this feature could be implemented, describe them here.
-
-        This section is optional but can be helpful to guide initial discussions.
-      placeholder: Describe how this feature might be implemented.
-
-  - type: markdown
-    attributes:
-      value: |
-        ## Additional Information
-
-  - type: textarea
-    id: additional-info
-    attributes:
-      label: Additional Information
-      description: |
-        If you have any additional information, comments, or resources you think would support or be relevant to your feature request, include them here.
-
-  - type: checkboxes
-    id: search-confirmation
-    attributes:
-      label: No Duplicate of the Feature
-      description: |
-        Please confirm that you have searched for similar features in our repository and found none that match your request.
-      options:
-        - label: I have verified that there are no existing features requests similar to my request.
-          required: true

.github/ISSUE_TEMPLATE/config.yml

@@ -1,5 +0,0 @@
-blank_issues_enabled: true
-contact_links:
-  - name: 💬 Discord Server
-    url: https://discord.gg/Cn8pWhQRxZ
-    about: You can join our Discord server for real time discussion and support

.github/dependabot.yml

@@ -1,17 +0,0 @@
-# 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"
-    open-pull-requests-limit: 10
-    rebase-strategy: "auto"
-  - package-ecosystem: "docker"
-    directory: "/" # Location of Dockerfile
-    schedule:
-      interval: "weekly"

.github/labeler-config.yml

@@ -1,54 +0,0 @@
-Translation:
-  - changed-files:
-    - any-glob-to-any-file: 'src/main/resources/messages_*_*.properties'
-    - any-glob-to-any-file: 'scripts/ignore_translation.toml'
-    - any-glob-to-any-file: 'src/main/resources/templates/fragments/languages.html'
-
-Front End:
-  - changed-files:
-    - any-glob-to-any-file: 'src/main/resources/templates/**/*'
-    - any-glob-to-any-file: 'src/main/resources/static/**/*'
-    - any-glob-to-any-file: 'src/main/java/stirling/software/SPDF/controller/web/**'
-
-Java:
-  - changed-files:
-    - any-glob-to-any-file: 'src/main/java/**/*.java'
-
-Back End:
-  - changed-files:
-    - any-glob-to-any-file: 'src/main/java/stirling/software/SPDF/config/security/**/*'
-    - any-glob-to-any-file: 'src/main/java/stirling/software/SPDF/config/model/provider/**/*'
-    - any-glob-to-any-file: 'src/main/resources/settings.yml.template'
-    - any-glob-to-any-file: 'src/main/resources/banner.txt'
-
-Security:
-  - changed-files:
-    - any-glob-to-any-file: 'src/main/java/stirling/software/SPDF/config/security/**/*'
-    - any-glob-to-any-file: 'src/main/java/stirling/software/SPDF/config/model/provider/**/*'
-    - any-glob-to-any-file: 'src/main/java/stirling/software/SPDF/config/model/AuthenticationType.java'
-
-API:
-  - changed-files:
-    - any-glob-to-any-file: 'src/main/java/stirling/software/SPDF/controller/web/MetricsController.java'
-    - any-glob-to-any-file: 'src/main/java/stirling/software/SPDF/controller/api/**/*'
-
-Documentation:
-  - changed-files:
-    - any-glob-to-any-file: '**/*.md'
-    - any-glob-to-any-file: 'scripts/counter_translation.py'
-    - any-glob-to-any-file: 'scripts/ignore_translation.toml'
-
-Docker:
-  - changed-files:
-    - any-glob-to-any-file: 'Dockerfile'
-    - any-glob-to-any-file: 'Dockerfile-*'
-    - any-glob-to-any-file: 'exampleYmlFiles/*.yml'
-
-Test:
-  - changed-files:
-    - any-glob-to-any-file: 'cucumber/**/*'
-    - any-glob-to-any-file: 'src/test**/*'
-
-Github:
-  - changed-files:
-    - any-glob-to-any-file: '.github/**/*'

.github/labels.yml

@@ -1,93 +0,0 @@
-# Labels names are important as they are used by Release Drafter to decide
-# regarding where to record them in changelog or if to skip them.
-#
-# The repository labels will be automatically configured using this file and
-# the GitHub Action https://github.com/marketplace/actions/github-labeler.
-- name: "Back End"
-  color: "20CE6C"
-  description: "Issues related to back-end development"
-  from_name: "Back end"
-- name: "Bug"
-  description: "Something isn't working"
-  color: "EB9CA6"
-  from_name: "bug"
-- name: "dependencies"
-  description: "Pull requests that update a dependency file"
-  color: "5AA8FC"
-- name: "Docker"
-  description: "Pull requests that update Docker code"
-  color: "1FCEFF"
-  from_name: "docker"
-- name: "Documentation"
-  description: "Improvements or additions to documentation"
-  color: "35ABFF"
-  from_name: "documentation"
-- name: "Done for next release"
-  color: "0CDBD1"
-- name: "Done"
-  color: "60F13B"
-- name: "duplicate"
-  description: "This issue or pull request already exists"
-  color: "CDD1D5"
-- name: "enhancement"
-  description: "New feature or request"
-  color: "A0EEEE"
-- name: "fix needs confirmation"
-  color: "60A1E7"
-  description: "Fix needs to be confirmed"
-- name: "Front End"
-  color: "BBD2F1"
-  description: "Issues related to front-end development"
-- name: "github-actions"
-  description: "Pull requests that update GitHub Actions code"
-  color: "999999"
-  from_name: "github_actions"
-- name: "good first issue"
-  description: "Good for newcomers"
-  color: "C1B8FF"
-- name: "help wanted"
-  description: "Extra attention is needed"
-  color: "00E6C4"
-- name: "invalid"
-  description: "This doesn't seem right"
-  color: "E5E566"
-- name: "Java"
-  description: "Pull requests that update Java code"
-  color: "FF9E1F"
-  from_name: "java"
-- name: "Long-term Enhancement"
-  color: "BFDEC3"
-  description: "Enhancements planned for the long term"
-- name: "more-info-needed"
-  color: "00E4F8"
-  description: "More information is needed"
-- name: "needs investigation"
-  color: "B8C3A7"
-  description: "Issues that require further investigation"
-- name: "Prioritised enhancement"
-  color: "4BA2EE"
-  description: "High-priority enhancements"
-- name: "question"
-  description: "Further information is requested"
-  color: "D97EE5"
-- name: "Translation"
-  color: "9FABF9"
-  from_name: "translation"
-- name: "upstream"
-  color: "DEDEDE"
-- name: "v2"
-  color: "FFFF00"
-- name: "wontfix"
-  description: "This will not be worked on"
-  color: "FFFFFF"
-- name: "Security"
-  color: "000000"
-  description: "Security-related issues or pull requests"
-- name: "API"
-  color: "FFFF00"
-  description: "API-related issues or pull requests"
-- name: "Test"
-  color: "FF9E1F"
-  description: "Testing-related issues or pull requests"
-- name: "Stale"
-  color: "000000"

.github/pull_request_template.md

@@ -1,13 +0,0 @@
-# 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
-- [ ] I have read the section [Add New Translation Tags](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/HowToAddNewLanguage.md#add-new-translation-tags) (for new translation tags only)

.github/release.yml

@@ -1,32 +0,0 @@
-changelog:
-  exclude:
-    labels:
-      - Documentation
-      - Test
-      - Github
-
-  categories:
-    - title: Bug Fixes
-      labels:
-        - Bug
-    
-    - title: Enhancements
-      labels:
-        - enhancement
-
-    - title: Minor Enhancements
-      labels:
-        - Java
-        - Front End
-
-    - title: Docker Updates
-      labels:
-        - Docker
-
-    - title: Translation Changes
-      labels:
-        - Translation
-    
-    - title: Other Changes
-      labels:
-        - "*"

.github/scripts/check_duplicates.py

@@ -1,51 +0,0 @@
-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_language_properties.py

@@ -1,254 +0,0 @@
-"""
-Author: Ludy87
-Description: This script processes .properties files for localization checks. It compares translation files in a branch with
-a reference file to ensure consistency. The script performs two main checks:
-1. Verifies that the number of lines (including comments and empty lines) in the translation files matches the reference file.
-2. Ensures that all keys in the translation files are present in the reference file and vice versa.
-
-The script also provides functionality to update the translation files to match the reference file by adding missing keys and
-adjusting the format.
-
-Usage:
-    python script_name.py --reference-file <path_to_reference_file> --branch <branch_name> [--files <list_of_changed_files>]
-"""
-import copy
-import glob
-import os
-import argparse
-import re
-
-
-def parse_properties_file(file_path):
-    """Parses a .properties file and returns a list of objects (including comments, empty lines, and line numbers)."""
-    properties_list = []
-    with open(file_path, "r", encoding="utf-8") as file:
-        for line_number, line in enumerate(file, start=1):
-            stripped_line = line.strip()
-
-            # Empty lines
-            if not stripped_line:
-                properties_list.append(
-                    {"line_number": line_number, "type": "empty", "content": ""}
-                )
-                continue
-
-            # Comments
-            if stripped_line.startswith("#"):
-                properties_list.append(
-                    {
-                        "line_number": line_number,
-                        "type": "comment",
-                        "content": stripped_line,
-                    }
-                )
-                continue
-
-            # Key-value pairs
-            match = re.match(r"^([^=]+)=(.*)$", line)
-            if match:
-                key, value = match.groups()
-                properties_list.append(
-                    {
-                        "line_number": line_number,
-                        "type": "entry",
-                        "key": key.strip(),
-                        "value": value.strip(),
-                    }
-                )
-
-    return properties_list
-
-
-def write_json_file(file_path, updated_properties):
-    updated_lines = {entry["line_number"]: entry for entry in updated_properties}
-
-    # Sort by line numbers and retain comments and empty lines
-    all_lines = sorted(set(updated_lines.keys()))
-
-    original_format = []
-    for line in all_lines:
-        if line in updated_lines:
-            entry = updated_lines[line]
-        else:
-            entry = None
-        ref_entry = updated_lines[line]
-        if ref_entry["type"] in ["comment", "empty"]:
-            original_format.append(ref_entry)
-        elif entry is None:
-            # Add missing entries from the reference file
-            original_format.append(ref_entry)
-        elif entry["type"] == "entry":
-            # Replace entries with those from the current JSON
-            original_format.append(entry)
-
-    # Write back in the original format
-    with open(file_path, "w", encoding="utf-8") as file:
-        for entry in original_format:
-            if entry["type"] == "comment":
-                file.write(f"{entry['content']}\n")
-            elif entry["type"] == "empty":
-                file.write(f"{entry['content']}\n")
-            elif entry["type"] == "entry":
-                file.write(f"{entry['key']}={entry['value']}\n")
-
-
-def update_missing_keys(reference_file, file_list, branch=""):
-    reference_properties = parse_properties_file(reference_file)
-    for file_path in file_list:
-        basename_current_file = os.path.basename(branch + file_path)
-        if (
-            basename_current_file == os.path.basename(reference_file)
-            or not file_path.endswith(".properties")
-            or not basename_current_file.startswith("messages_")
-        ):
-            continue
-
-        current_properties = parse_properties_file(branch + file_path)
-        updated_properties = []
-        for ref_entry in reference_properties:
-            ref_entry_copy = copy.deepcopy(ref_entry)
-            for current_entry in current_properties:
-                if current_entry["type"] == "entry":
-                    if ref_entry_copy["type"] != "entry":
-                        continue
-                    if ref_entry_copy["key"] == current_entry["key"]:
-                        ref_entry_copy["value"] = current_entry["value"]
-            updated_properties.append(ref_entry_copy)
-        write_json_file(branch + file_path, updated_properties)
-
-
-def check_for_missing_keys(reference_file, file_list, branch):
-    update_missing_keys(reference_file, file_list, branch + "/")
-
-
-def read_properties(file_path):
-    with open(file_path, "r", encoding="utf-8") as file:
-        return file.read().splitlines()
-
-
-def check_for_differences(reference_file, file_list, branch):
-    reference_branch = reference_file.split("/")[0]
-    basename_reference_file = os.path.basename(reference_file)
-
-    report = []
-    report.append(
-        f"### 📋 Checking with the file `{basename_reference_file}` from the `{reference_branch}` - Checking the `{branch}`"
-    )
-    reference_lines = read_properties(reference_file)
-    has_differences = False
-
-    only_reference_file = True
-
-    for file_path in file_list:
-        basename_current_file = os.path.basename(branch + "/" + file_path)
-        if (
-            basename_current_file == basename_reference_file
-            or not file_path.endswith(".properties")
-            or not basename_current_file.startswith("messages_")
-        ):
-            continue
-        only_reference_file = False
-        report.append(f"#### 🗂️ **Checking File:** `{basename_current_file}`...")
-        current_lines = read_properties(branch + "/" + file_path)
-        reference_line_count = len(reference_lines)
-        current_line_count = len(current_lines)
-
-        if reference_line_count != current_line_count:
-            report.append("")
-            report.append("- **Test 1 Status:** ❌ Failed")
-            has_differences = True
-            if reference_line_count > current_line_count:
-                report.append(
-                    f"  - **Issue:** Missing lines! Comments, empty lines, or translation strings are missing. Details: {reference_line_count} (reference) vs {current_line_count} (current)."
-                )
-            elif reference_line_count < current_line_count:
-                report.append(
-                    f"  - **Issue:** Too many lines! Check your translation files! Details: {reference_line_count} (reference) vs {current_line_count} (current)."
-                )
-            # update_missing_keys(reference_file, [file_path], branch + "/")
-        else:
-            report.append("- **Test 1 Status:** ✅ Passed")
-
-        # Check for missing or extra keys
-        current_keys = []
-        reference_keys = []
-        for line in current_lines:
-            if not line.startswith("#") and line != "" and "=" in line:
-                key, _ = line.split("=", 1)
-                current_keys.append(key)
-        for line in reference_lines:
-            if not line.startswith("#") and line != "" and "=" in line:
-                key, _ = line.split("=", 1)
-                reference_keys.append(key)
-
-        current_keys_set = set(current_keys)
-        reference_keys_set = set(reference_keys)
-        missing_keys = current_keys_set.difference(reference_keys_set)
-        extra_keys = reference_keys_set.difference(current_keys_set)
-        missing_keys_list = list(missing_keys)
-        extra_keys_list = list(extra_keys)
-
-        if missing_keys_list or extra_keys_list:
-            has_differences = True
-            missing_keys_str = "`, `".join(missing_keys_list)
-            extra_keys_str = "`, `".join(extra_keys_list)
-            report.append("- **Test 2 Status:** ❌ Failed")
-            if missing_keys_list:
-                report.append(
-                    f"  - **Issue:** There are keys in ***{basename_current_file}*** `{missing_keys_str}` that are not present in ***{basename_reference_file}***!"
-                )
-            if extra_keys_list:
-                report.append(
-                    f"  - **Issue:** There are keys in ***{basename_reference_file}*** `{extra_keys_str}` that are not present in ***{basename_current_file}***!"
-                )
-            # update_missing_keys(reference_file, [file_path], branch + "/")
-        else:
-            report.append("- **Test 2 Status:** ✅ Passed")
-        # if has_differences:
-        #     report.append("")
-        #     report.append(f"#### 🚧 ***{basename_current_file}*** will be corrected...")
-        report.append("")
-        report.append("---")
-        report.append("")
-    # update_file_list = glob.glob(branch + "/src/**/messages_*.properties", recursive=True)
-    # update_missing_keys(reference_file, update_file_list)
-    # report.append("---")
-    # report.append("")
-    if has_differences:
-        report.append("## ❌ Overall Check Status: **_Failed_**")
-    else:
-        report.append("## ✅ Overall Check Status: **_Success_**")
-
-    if not only_reference_file:
-        print("\n".join(report))
-
-
-if __name__ == "__main__":
-    parser = argparse.ArgumentParser(description="Find missing keys")
-    parser.add_argument(
-        "--reference-file",
-        required=True,
-        help="Path to the reference file.",
-    )
-    parser.add_argument(
-        "--branch",
-        type=str,
-        required=True,
-        help="Branch name.",
-    )
-    parser.add_argument(
-        "--files",
-        nargs="+",
-        required=False,
-        help="List of changed files, separated by spaces.",
-    )
-    args = parser.parse_args()
-
-    file_list = args.files
-    if file_list is None:
-        file_list = glob.glob(
-            os.getcwd() + "/src/**/messages_*.properties", recursive=True
-        )
-        update_missing_keys(args.reference_file, file_list)
-    else:
-        check_for_differences(args.reference_file, file_list, args.branch)

.github/scripts/check_tabulator.py

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

@@ -1,67 +0,0 @@
-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/auto-labeler.yml

@@ -1,20 +0,0 @@
-name: "Pull Request Labeler"
-on:
-  pull_request_target:
-    types: [opened, synchronize]
-
-jobs:
-  labeler:
-    permissions:
-      contents: read
-      pull-requests: write
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      
-      - name: Apply Labels
-        uses: actions/labeler@v5
-        with:
-          repo-token: ${{ secrets.GITHUB_TOKEN }}
-          configuration-path: .github/labeler-config.yml
-          sync-labels: true

.github/workflows/build.yml

@@ -1,103 +0,0 @@
-name: Build repo
-
-on:
-  push:
-    branches: ["main"]
-  pull_request:
-    branches: ["main"]
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-
-    permissions:
-      actions: read
-      contents: read
-      security-events: write
-
-    strategy:
-      fail-fast: false
-      matrix:
-        jdk-version: [17, 21]
-
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v4
-
-      - name: Set up JDK ${{ matrix.jdk-version }}
-        uses: actions/setup-java@v4
-        with:
-          java-version: ${{ matrix.jdk-version }}
-          distribution: "temurin"
-
-      - name: Set up Gradle
-        uses: gradle/actions/setup-gradle@v4
-        with:
-          gradle-version: 8.7
-
-      - name: Build with Gradle
-        run: ./gradlew build --no-build-cache
-        continue-on-error: true
-      
-      - name: Upload JUnit test results
-        if: always()
-        uses: actions/upload-artifact@v3
-        with:
-          name: junit-test-results
-          path: '**/build/test-results/test/TEST-*.xml'
-          retention-days: 7
-      
-      - name: Check for test failures
-        if: failure()
-        run: |
-          echo "Tests failed. Please check the JUnit test results artifact for details."
-          exit 1
-
-  docker-compose-tests:
-    # if: github.event_name == 'push' && github.ref == 'refs/heads/main' ||
-    #     (github.event_name == 'pull_request' &&
-    #     contains(github.event.pull_request.labels.*.name, 'licenses') == false &&
-    #     (
-    #       contains(github.event.pull_request.labels.*.name, 'Front End') ||
-    #       contains(github.event.pull_request.labels.*.name, 'Java') ||
-    #       contains(github.event.pull_request.labels.*.name, 'Back End') ||
-    #       contains(github.event.pull_request.labels.*.name, 'Security') ||
-    #       contains(github.event.pull_request.labels.*.name, 'API') ||
-    #       contains(github.event.pull_request.labels.*.name, 'Docker') ||
-    #       contains(github.event.pull_request.labels.*.name, '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.29.1/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
-          sudo chmod +x /usr/local/bin/docker-compose
-
-      - name: Set up Python
-        uses: actions/setup-python@v5
-        with:
-          python-version: "3.7"
-
-      - name: Pip requirements
-        run: |
-           pip install -r ./cucumber/requirements.txt
-
-      - name: Run Docker Compose Tests
-        run: |
-          chmod +x ./test.sh
-          ./test.sh

.github/workflows/check_properties.yml

@@ -1,202 +0,0 @@
-name: Check Properties Files
-
-on:
-  pull_request_target:
-    types: [opened, synchronize, reopened]
-    paths:
-      - "src/main/resources/messages_*.properties"
-  push:
-    paths:
-      - "src/main/resources/messages_en_GB.properties"
-
-permissions:
-  contents: write
-  pull-requests: write
-
-jobs:
-  check-files:
-    if: github.event_name == 'pull_request_target'
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout PR branch
-        uses: actions/checkout@v4
-        with:
-          repository: ${{ github.event.pull_request.head.repo.full_name }}
-          ref: ${{ github.event.pull_request.head.ref }}
-          path: pr-branch
-          fetch-depth: 0
-
-      - name: Checkout main branch
-        uses: actions/checkout@v4
-        with:
-          ref: main
-          path: main-branch
-          fetch-depth: 0
-
-      - name: Set up Python
-        uses: actions/setup-python@v5
-        with:
-          python-version: "3.x"
-
-      - name: Install GitHub CLI
-        run: sudo apt-get update && sudo apt-get install -y gh
-
-      - name: Fetch PR changed files
-        id: fetch-pr-changes
-        env:
-          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: |
-          echo "Fetching PR changed files..."
-          cd pr-branch
-          gh repo set-default ${{ github.repository }}
-          gh pr view ${{ github.event.pull_request.number }} --json files -q ".files[].path" > ../changed_files.txt
-          cd ..
-          echo $(cat changed_files.txt)
-          BRANCH_PATH="pr-branch"
-          echo "BRANCH_PATH=${BRANCH_PATH}" >> $GITHUB_ENV
-          CHANGED_FILES=$(cat changed_files.txt | tr '\n' ' ')
-          echo "CHANGED_FILES=${CHANGED_FILES}" >> $GITHUB_ENV
-          echo "Changed files: ${CHANGED_FILES}"
-          echo "Branch: ${BRANCH_PATH}"
-
-      - name: Determine reference file
-        id: determine-file
-        run: |
-          echo "Determining reference file..."
-          if echo "${{ env.CHANGED_FILES }}" | grep -q 'src/main/resources/messages_en_GB.properties'; then
-              echo "REFERENCE_FILE=pr-branch/src/main/resources/messages_en_GB.properties" >> $GITHUB_ENV
-          else
-              echo "REFERENCE_FILE=main-branch/src/main/resources/messages_en_GB.properties" >> $GITHUB_ENV
-          fi
-          echo "REFERENCE_FILE=${{ env.REFERENCE_FILE }}"
-
-      - name: Show REFERENCE_FILE
-        run: echo "Reference file is set to ${{ env.REFERENCE_FILE }}"
-
-      - name: Run Python script to check files
-        id: run-check
-        run: |
-          python main-branch/.github/scripts/check_language_properties.py --reference-file ${{ env.REFERENCE_FILE }} --branch ${{ env.BRANCH_PATH }} --files ${{ env.CHANGED_FILES }} > failure.txt || true
-
-      - name: Capture output
-        id: capture-output
-        run: |
-          if [ -f failure.txt ] && [ -s failure.txt ]; then
-            echo "Test failed, capturing output..."
-            ERROR_OUTPUT=$(cat failure.txt)
-            echo "ERROR_OUTPUT<<EOF" >> $GITHUB_ENV
-            echo "$ERROR_OUTPUT" >> $GITHUB_ENV
-            echo "EOF" >> $GITHUB_ENV
-            echo $ERROR_OUTPUT
-          else
-            echo "No errors found."
-            echo "ERROR_OUTPUT=" >> $GITHUB_ENV
-          fi
-
-      - name: Post comment on PR
-        if: env.ERROR_OUTPUT != ''
-        uses: actions/github-script@v7
-        with:
-          script: |
-            const { GITHUB_REPOSITORY, ERROR_OUTPUT } = process.env;
-            const [repoOwner, repoName] = GITHUB_REPOSITORY.split('/');
-            const prNumber = context.issue.number;
-
-            // Find existing comment
-            const comments = await github.rest.issues.listComments({
-              owner: repoOwner,
-              repo: repoName,
-              issue_number: prNumber
-            });
-
-            const comment = comments.data.find(c => c.body.includes("## 🚀 Translation Verification Summary"));
-
-            // Only allow the action user to update comments
-            const expectedActor = "github-actions[bot]";
-
-            if (comment && comment.user.login === expectedActor) {
-              // Update existing comment
-              await github.rest.issues.updateComment({
-                owner: repoOwner,
-                repo: repoName,
-                comment_id: comment.id,
-                body: `## 🚀 Translation Verification Summary\n\n\n${ERROR_OUTPUT}\n`
-              });
-              console.log("Updated existing comment.");
-            } else if (!comment) {
-              // Create new comment if no existing comment is found
-              await github.rest.issues.createComment({
-                owner: repoOwner,
-                repo: repoName,
-                issue_number: prNumber,
-                body: `## 🚀 Translation Verification Summary\n\n\n${ERROR_OUTPUT}\n`
-              });
-              console.log("Created new comment.");
-            } else {
-              console.log("Comment update attempt denied. Actor does not match.");
-            }
-
-      # - name: Set up git config
-      #   run: |
-      #     git config --global user.name "github-actions[bot]"
-      #     git config --global user.email "github-actions[bot]@users.noreply.github.com"
-
-      # - name: Add translation keys
-      #   run: |
-      #     cd ${{ env.BRANCH_PATH }}
-      #     git add src/main/resources/messages_*.properties
-      #     git diff --staged --quiet || echo "CHANGES_DETECTED=true" >> $GITHUB_ENV
-      #     git commit -m "Update translation files" || echo "No changes to commit"
-      # - name: Push
-      #   if: env.CHANGES_DETECTED == 'true'
-      #   run: |
-      #     cd pr-branch
-      #     git remote set-url origin https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.event.pull_request.head.repo.full_name }}.git
-      #     git push origin ${{ github.head_ref }} || echo "Push failed: possibly no changes to push"
-
-  update-translations-main:
-    if: github.event_name == 'push'
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v4
-
-      - name: Set up Python
-        uses: actions/setup-python@v5
-        with:
-          python-version: "3.x"
-
-      - name: Run Python script to check files
-        id: run-check
-        run: |
-          python .github/scripts/check_language_properties.py --reference-file src/main/resources/messages_en_GB.properties --branch main
-
-      - name: Set up git config
-        run: |
-          git config --global user.name "github-actions[bot]"
-          git config --global user.email "github-actions[bot]@users.noreply.github.com"
-
-      - name: Add translation keys
-        run: |
-          git add src/main/resources/messages_*.properties
-          git diff --staged --quiet || echo "CHANGES_DETECTED=true" >> $GITHUB_ENV
-
-      - name: Create Pull Request
-        id: cpr
-        if: env.CHANGES_DETECTED == 'true'
-        uses: peter-evans/create-pull-request@v6
-        with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-          commit-message: "Update translation files"
-          committer: GitHub Action <action@github.com>
-          author: GitHub Action <action@github.com>
-          signoff: true
-          branch: update_translation_files
-          title: "Update translation files"
-          body: |
-            Auto-generated by [create-pull-request][1]
-
-            [1]: https://github.com/peter-evans/create-pull-request
-          labels: Translation
-          draft: false
-          delete-branch: true

.github/workflows/licenses-update.yml

@@ -1,79 +0,0 @@
-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@v4
-
-      - 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.name "github-actions[bot]"
-          git config --global user.email "github-actions[bot]@users.noreply.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
-        id: cpr
-        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
-          labels: licenses
-          draft: false
-          delete-branch: true
-
-      - name: Auto approve
-        if: steps.cpr.outputs.pull-request-operation == 'created'
-        run: gh pr review --approve "${{ steps.cpr.outputs.pull-request-number }}"
-        env:
-          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
-      - name: Enable auto-merge
-        if: steps.cpr.outputs.pull-request-operation == 'created'
-        uses: peter-evans/enable-pull-request-automerge@v3
-        with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-          pull-request-number: ${{ steps.cpr.outputs.pull-request-number }}
-          merge-method: squash # Choose the merge method: merge, squash, or rebase

.github/workflows/manage-label.yml

@@ -1,24 +0,0 @@
-name: Manage labels
-
-on:
-  schedule:
-    - cron: "30 20 * * *"
-
-permissions:
-  contents: read
-  issues: write
-
-jobs:
-  labeler:
-    name: Labeler
-    runs-on: ubuntu-latest
-    steps:
-      - name: Check out the repository
-        uses: actions/checkout@v4
-
-      - name: Run Labeler
-        uses: crazy-max/ghaction-github-labeler@v5
-        with:
-          github-token: ${{ secrets.GITHUB_TOKEN }}
-          yaml-file: .github/labels.yml
-          skip-delete: true

.github/workflows/push-docker.yml

@@ -1,139 +0,0 @@
-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@v4
-        with:
-          gradle-version: 8.7
-
-      - 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@v6
-        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@v6
-        if: github.ref != 'refs/heads/main'
-        with:
-          context: .
-          file: ./Dockerfile-ultra-lite
-          push: true
-          cache-from: type=gha
-          cache-to: type=gha,mode=max
-          tags: ${{ steps.meta2.outputs.tags }}
-          labels: ${{ steps.meta2.outputs.labels }}
-          build-args: VERSION_TAG=${{ steps.versionNumber.outputs.versionNumber }}
-          platforms: linux/amd64,linux/arm64/v8
-
-      - name: Generate tags fat
-        id: meta3
-        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 }}-fat,enable=${{ github.ref == 'refs/heads/master' }}
-            type=raw,value=latest-fat,enable=${{ github.ref == 'refs/heads/master' }}
-
-      - name: Build and push main Dockerfile fat
-        uses: docker/build-push-action@v6
-        if: github.ref != 'refs/heads/main'
-        with:
-          builder: ${{ steps.buildx.outputs.name }}
-          context: .
-          file: ./Dockerfile-fat
-          push: true
-          cache-from: type=gha
-          cache-to: type=gha,mode=max
-          tags: ${{ steps.meta3.outputs.tags }}
-          labels: ${{ steps.meta3.outputs.labels }}
-          build-args: VERSION_TAG=${{ steps.versionNumber.outputs.versionNumber }}
-          platforms: linux/amd64,linux/arm64/v8

.github/workflows/releaseArtifacts.yml

@@ -1,75 +0,0 @@
-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@v4
-        with:
-          gradle-version: 8.7
-
-      - 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/stale.yml

@@ -1,32 +0,0 @@
-name: Close stale issues
-
-on:
-  schedule:
-    - cron: "30 0 * * *"
-  workflow_dispatch:
-
-jobs:
-  stale:
-    runs-on: ubuntu-latest
-    permissions:
-      issues: write
-      pull-requests: write
-    steps:
-      - name: 30 days stale issues
-        uses: actions/stale@v9
-        with:
-          repo-token: ${{ secrets.GITHUB_TOKEN }}
-          days-before-stale: 30
-          days-before-close: 7
-          stale-issue-message: >
-            This issue has been automatically marked as stale because it has had no recent activity.
-            It will be closed if no further activity occurs. Thank you for your contributions.
-          close-issue-message: >
-            This issue has been automatically closed because it has had no recent activity after being marked as stale.
-            Please reopen if you need further assistance.
-          stale-issue-label: "Stale"
-          remove-stale-when-updated: true
-          only-issue-labels: "more-info-needed"
-          days-before-pr-stale: -1 # Prevents PRs from being marked as stale
-          days-before-pr-close: -1 # Prevents PRs from being closed
-          start-date: '2024-07-06T00:00:00Z'  # ISO 8601 Format

.github/workflows/swagger.yml

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

@@ -1,92 +0,0 @@
-name: Sync Files
-
-on:
-  push:
-    branches:
-      - main
-    paths:
-      - "build.gradle"
-      - "src/main/resources/messages_*.properties"
-      - "scripts/ignore_translation.toml"
-
-permissions:
-  contents: write
-  pull-requests: write
-
-jobs:
-  sync-versions:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - name: Set up Python
-        uses: actions/setup-python@v5
-        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.name "github-actions[bot]"
-          git config --global user.email "github-actions[bot]@users.noreply.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
-        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
-          labels: github-actions
-  sync-readme:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - name: Set up Python
-        uses: actions/setup-python@v5
-        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.name "github-actions[bot]"
-          git config --global user.email "github-actions[bot]@users.noreply.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
-        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
-          labels: Documentation,Translation,github-actions

.gitignore

@@ -1,162 +1,10 @@
-### 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
-*.tar.gz
-*.rar
-*.db
-/build
-
-# Byte-compiled / optimized / DLL files
-__pycache__/
-*.py[cod]
-*.pyo
-
-# Virtual environments
-.env*
-.venv*
-env*/
-venv*/
-ENV/
-env.bak/
-venv.bak/
-
-# VS Code
-/.vscode/**/*
-!/.vscode/settings.json
-
-# IntelliJ IDEA
+node_modules/
+*.code-workspace
 .idea/
-*.iml
-out/
-
-# Ignore Mac DS_Store files
-.DS_Store
-**/.DS_Store
-
-# cucumber
-/cucumber/reports/**
-
-# Certs
-*.p12
-*.pem
-*.crt
-*.cer
-*.der
-*.key
-*.csr
-
-# cache
-.ruff_cache
-.mypy_cache
-.pytest_cache
-.ipynb_checkpoints
-
+dist/
+android/
+ios/
+releases/
+.vscode/
+.env.local
+/server-node/jobs

.npmrc

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

.pre-commit-config.yaml

@@ -1,39 +0,0 @@
-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|scripts)/.+)?[^/]+\.py$
-        exclude: (split_photos.py)
-      - id: ruff-format
-        files: ^((.github/scripts|scripts)/.+)?[^/]+\.py$
-        exclude: (split_photos.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|src/main/resources/static/pdfjs-legacy)
-        files: ^.*(\.html|\.css|\.js)$

.vscode/settings.json

@@ -1,53 +0,0 @@
-{
-  "java.compile.nullAnalysis.mode": "automatic",
-  "files.eol": "auto",
-  "java.configuration.updateBuildConfiguration": "interactive",
-  "black-formatter.args": ["--line-length", "127"],
-  "flake8.args": ["--max-line-length", "127"],
-  "pylint.args": ["max-line-length", "127"],
-  "[java]": {
-    "editor.tabSize": 4,
-    "editor.detectIndentation": false,
-    "editor.rulers": [127]
-  },
-  "[python]": {
-    "editor.tabSize": 2,
-    "editor.detectIndentation": false,
-    "editor.rulers": [127]
-  },
-  "[gradle-build]": {
-    "editor.tabSize": 4,
-    "editor.detectIndentation": false,
-    "editor.rulers": [127]
-  },
-  "[gradle]": {
-    "editor.tabSize": 4,
-    "editor.detectIndentation": false,
-    "editor.rulers": [127]
-  },
-  "[html]": {
-    "editor.tabSize": 2,
-    "editor.rulers": [127],
-    "files.trimFinalNewlines": false,
-    "files.insertFinalNewline": false
-  },
-  "[javascript]": {
-    "editor.tabSize": 2,
-    "editor.rulers": [127]
-  },
-  "[yaml]": {
-    "files.trimFinalNewlines": false,
-    "files.insertFinalNewline": false
-  },
-  "diffEditor.maxComputationTime": 0,
-  "editor.wordSegmenterLocales": null,
-  "editor.guides.bracketPairs": "active",
-  "editor.guides.bracketPairsHorizontal": "active",
-  "files.insertFinalNewline": true,
-  "files.trimFinalNewlines": true,
-  "files.trimTrailingWhitespace": true,
-  "editor.indentSize": "tabSize",
-  "editor.stickyScroll.enabled": false,
-  "editor.minimap.enabled": false,
-  "editor.formatOnSave": true
-}

CONTRIBUTE.md

@@ -0,0 +1,35 @@
+# Contribute
+
+This file should introduce you with the concepts and tools used in this project.
+
+## Basic Setup
+
+- Install/Update **Node (v22.2.0, [nvm](https://github.com/coreybutler/nvm-windows))** & NPM(>10.2.1)
+- To install all dependecies `npm run update-all-dependencies` (in [root](/))
+- To test your current setup and boot a complete install of spdf v2 run `npm run dev-all` (in [root](/))
+
+## Nomenclature
+
+- API - Probably refers to the “normal“ API of spdf v2 without workflows unless otherwise noted.
+- Workflow - Either the express-endpoint for running workflows or the user defined workflow-json
+- Action - A sub-element of a workflow describing what operation should run on the inputted file / output of the last action.
+- Operation - The actual function that will run on the pdf, including parameters.
+- Operator - The actual code/implementation of the Operation (e.g. impose.ts) OR The parent class of every Operator.
+- Validator - A function that makes sure things are as they should be. Every Operator must have one.
+- Decorator - Explanations and Human Readable names of fields, these will be displayed in the frontend and used to provide better errors for the (workflow-)API
+
+## Folder structure
+
+- client-tauri - The frontend - Can be built to web and to a desktop app (with extra functions) using tauri.
+- server-node - The backend - Provides extra functionality for the web client.
+- shared-operatons - Components (e.g. Operators) that are shared between frontend and backend.
+
+## Adding a PDF Operator
+
+An Operator is either shared by the server and the client or it might have different implementations based on if its executed by the client, desktop-backend or web-backend. The current structure allows us to define where the Operator can be run.
+
+## PDF Library Docs
+- [pdf-lib](https://pdf-lib.js.org) - js
+- [mozilla's pdfjs-dist/pdf.js](https://www.npmjs.com/package/pdfjs-dist) - js
+- [pdfcpu](https://pdfcpu.io) - go-wasm
+- [opencv-wasm](https://www.npmjs.com/package/opencv-wasm) - c++-wasm

CONTRIBUTING.md

@@ -1,44 +0,0 @@
-# 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 separate 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://docs.stirlingpdf.com/](https://docs.stirlingpdf.com/).
-
-## 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 [MIT License](LICENSE).

DATABASE.md

@@ -1,40 +0,0 @@
-# New Database Backup and Import Functionality
-
-**Full activation will take place on approximately January 5th, 2025!**
-
-Why is the waiting time six months?
-
-There are users who only install updates sporadically; if they skip the preparation, it can/will lead to data loss in the database.
-
-## Functionality Overview
-
-The newly introduced feature enhances the application with robust database backup and import capabilities. This feature is designed to ensure data integrity and provide a straightforward way to manage database backups. Here's how it works:
-
-1. Automatic Backup Creation
-   - The system automatically creates a database backup every day at midnight. This ensures that there is always a recent backup available, minimizing the risk of data loss.
-2. Manual Backup Export
-   - Admin actions that modify the user database trigger a manual export of the database. This keeps the backup up-to-date with the latest changes and provides an extra layer of data security.
-3. Importing Database Backups
-   - Admin users can import a database backup either via the web interface or API endpoints. This allows for easy restoration of the database to a previous state in case of data corruption or other issues.
-   - The import process ensures that the database structure and data are correctly restored, maintaining the integrity of the application.
-4. Managing Backup Files
-   - Admins can view a list of all existing backup files, along with their creation dates and sizes. This helps in managing storage and identifying the most recent or relevant backups.
-   - Backup files can be downloaded for offline storage or transferred to other environments, providing flexibility in database management.
-   - Unnecessary backup files can be deleted through the interface to free up storage space and maintain an organized backup directory.
-
-## User Interface
-
-### Web Interface
-
-1. Upload SQL files to import database backups.
-2. View details of existing backups, such as file names, creation dates, and sizes.
-3. Download backup files for offline storage.
-4. Delete outdated or unnecessary backup files.
-
-### API Endpoints
-
-1. Import database backups by uploading SQL files.
-2. Download backup files.
-3. Delete backup files.
-
-This new functionality streamlines database management, ensuring that backups are always available and easy to manage, thus improving the reliability and resilience of the application.

DeveloperGuide.md

@@ -1,557 +0,0 @@
-# Stirling-PDF Developer Guide
-
-## 1. Introduction
-
-Stirling-PDF is a robust, locally hosted web-based PDF manipulation tool. This guide focuses on Docker-based development and testing, which is the recommended approach for working with the full version of Stirling-PDF.
-
-## 2. Project Overview
-
-Stirling-PDF is built using:
-- Spring Boot + Thymeleaf
-- PDFBox
-- LibreOffice
-- OcrMyPdf
-- HTML, CSS, JavaScript
-- Docker
-- PDF.js
-- PDF-LIB.js
-- Lombok
-
-## 3. Development Environment Setup
-
-### Prerequisites
-- Docker
-- Git
-- Java JDK 17 or later
-- Gradle 7.0 or later (Included within repo)
-
-### Setup Steps
-1. Clone the repository:
-   ```
-   git clone https://github.com/Stirling-Tools/Stirling-PDF.git
-   cd Stirling-PDF
-   ```
-
-2. Install Docker and JDK17 if not already installed.
-
-3. Install a recommended Java IDE such as Eclipse, IntelliJ or VSCode
-
-4. Lombok Setup
-Stirling-PDF uses Lombok to reduce boilerplate code. Some IDEs, like Eclipse, don't support Lombok out of the box. To set up Lombok in your development environment:
-Visit the [Lombok website](https://projectlombok.org/setup/) for installation instructions specific to your IDE.
-
-5. Add environment variable
-For local testing you should generally be testing the full 'Security' version of Stirling-PDF to do this you must add the environment flag DOCKER_ENABLE_SECURITY=true to your system and/or IDE build/run step
-
-
-## 4. Project Structure
-
-```
-Stirling-PDF/
-├── .github/               # GitHub-specific files (workflows, issue templates)
-├── configs/               # Configuration files used by stirling at runtime (generated at runtime)
-├── cucumber/              # Cucumber test files
-│   ├── features/
-├── customFiles/           # Custom static files and templates (generated at runtime used to replace existing files)
-├── docs/                  # Documentation files
-├── exampleYmlFiles/       # Example YAML configuration files
-├── images/                # Image assets
-├── pipeline/              # Pipeline-related files (generated at runtime)
-├── scripts/               # Utility scripts
-├── src/                   # Source code
-│   ├── main/
-│   │   ├── java/
-│   │   │   └── stirling/
-│   │   │       └── software/
-│   │   │           └── SPDF/
-│   │   │               ├── config/
-│   │   │               ├── controller/
-│   │   │               ├── model/
-│   │   │               ├── repository/
-│   │   │               ├── service/
-│   │   │               └── utils/
-│   │   └── resources/
-│   │       ├── static/
-│   │       │   ├── css/
-│   │       │   ├── js/
-│   │       │   └── pdfjs/
-│   │       └── templates/
-│   └── test/
-│       └── java/
-│           └── stirling/
-│               └── software/
-│                   └── SPDF/
-├── build.gradle           # Gradle build configuration
-├── Dockerfile             # Main Dockerfile
-├── Dockerfile-ultra-lite  # Dockerfile for ultra-lite version
-├── Dockerfile-fat         # Dockerfile for fat version
-├── docker-compose.yml     # Docker Compose configuration
-└── test.sh                # Test script to deploy all docker versions and run cuke tests
-```
-
-## 5. Docker-based Development
-
-Stirling-PDF offers several Docker versions:
-- Full: All features included
-- Ultra-Lite: Basic PDF operations only
-- Fat: Includes additional libraries and fonts predownloaded
-
-### Example Docker Compose Files
-
-Stirling-PDF provides several example Docker Compose files in the `exampleYmlFiles` directory such as :
-
-- `docker-compose-latest.yml`: Latest version without security features
-- `docker-compose-latest-security.yml`: Latest version with security features enabled
-- `docker-compose-latest-fat-security.yml`: Fat version with security features enabled
-
-These files provide pre-configured setups for different scenarios. For example, here's a snippet from `docker-compose-latest-security.yml`:
-
-```yaml
-services:
-  stirling-pdf:
-    container_name: Stirling-PDF-Security
-    image: frooodle/s-pdf:latest
-    deploy:
-      resources:
-        limits:
-          memory: 4G
-    healthcheck:
-      test: ["CMD-SHELL", "curl -f http://localhost:8080/api/v1/info/status | grep -q 'UP' && curl -fL http://localhost:8080/ | grep -q 'Please sign in'"]
-      interval: 5s
-      timeout: 10s
-      retries: 16
-    ports:
-      - "8080:8080"
-    volumes:
-      - /stirling/latest/data:/usr/share/tessdata:rw
-      - /stirling/latest/config:/configs:rw
-      - /stirling/latest/logs:/logs:rw
-    environment:
-      DOCKER_ENABLE_SECURITY: "true"
-      SECURITY_ENABLELOGIN: "true"
-      PUID: 1002
-      PGID: 1002
-      UMASK: "022"
-      SYSTEM_DEFAULTLOCALE: en-US
-      UI_APPNAME: Stirling-PDF
-      UI_HOMEDESCRIPTION: Demo site for Stirling-PDF Latest with Security
-      UI_APPNAMENAVBAR: Stirling-PDF Latest
-      SYSTEM_MAXFILESIZE: "100"
-      METRICS_ENABLED: "true"
-      SYSTEM_GOOGLEVISIBILITY: "true"
-    restart: on-failure:5
-```
-
-To use these example files, copy the desired file to your project root and rename it to `docker-compose.yml`, or specify the file explicitly when running Docker Compose:
-
-```bash
-docker-compose -f exampleYmlFiles/docker-compose-latest-security.yml up
-```
-
-### Building Docker Images
-
-Stirling-PDF uses different Docker images for various configurations. The build process is controlled by environment variables and uses specific Dockerfile variants. Here's how to build the Docker images:
-
-1. Set the security environment variable:
-   ```bash
-   export DOCKER_ENABLE_SECURITY=false  # or true for security-enabled builds
-   ```
-
-2. Build the project with Gradle:
-   ```bash
-   ./gradlew clean build
-   ```
-
-3. Build the Docker images:
-
-   For the latest version:
-   ```bash
-   docker build --no-cache --pull --build-arg VERSION_TAG=alpha -t frooodle/s-pdf:latest -f ./Dockerfile .
-   ```
-
-   For the ultra-lite version:
-   ```bash
-   docker build --no-cache --pull --build-arg VERSION_TAG=alpha -t frooodle/s-pdf:latest-ultra-lite -f ./Dockerfile-ultra-lite .
-   ```
-
-   For the fat version (with security enabled):
-   ```bash
-   export DOCKER_ENABLE_SECURITY=true
-   docker build --no-cache --pull --build-arg VERSION_TAG=alpha -t frooodle/s-pdf:latest-fat -f ./Dockerfile-fat .
-   ```
-
-Note: The `--no-cache` and `--pull` flags ensure that the build process uses the latest base images and doesn't use cached layers, which is useful for testing and ensuring reproducible builds. however to improve build times these can often be removed depending on your usecase
-
-
-
-## 6. Testing
-
-### Comprehensive Testing Script
-
-Stirling-PDF provides a `test.sh` script in the root directory. This script builds all versions of Stirling-PDF, checks that each version works, and runs Cucumber tests. It's recommended to run this script before submitting a final pull request.
-
-To run the test script:
-
-```bash
-./test.sh
-```
-
-This script performs the following actions:
-1. Builds all Docker images (full, ultra-lite, fat)
-2. Runs each version to ensure it starts correctly
-3. Executes Cucumber tests against main version and ensures feature compatibility, in the event these tests fail your PR will not be merged
-
-Note: The `test.sh` script will run automatically when you raise a PR. However, it's recommended to run it locally first to save resources and catch any issues early.
-
-### Full Testing with Docker
-
-1. Build and run the Docker container per the above instructions:
-
-2. Access the application at `http://localhost:8080` and manually test all features developed.
-
-
-### Local Testing (Java and UI Components)
-
-For quick iterations and development of Java backend, JavaScript, and UI components, you can run and test Stirling-PDF locally without Docker. This approach allows you to work on and verify changes to:
-
-- Java backend logic
-- RESTful API endpoints
-- JavaScript functionality
-- User interface components and styling
-- Thymeleaf templates
-
-To run Stirling-PDF locally:
-
-1. Compile and run the project using built in IDE methods or by running:
-   ```
-   ./gradlew bootRun
-   ```
-
-2. Access the application at `http://localhost:8080` in your web browser.
-
-3. Manually test the features you're working on through the UI.
-
-4. For API changes, use tools like Postman or curl to test endpoints directly.
-
-Important notes:
-- Local testing doesn't include features that depend on external tools like OCRmyPDF, LibreOffice, or Python scripts.
-- There are currently no automated unit tests. All testing is done manually through the UI or API calls. (You are welcome to add JUnits!)
-- Always verify your changes in the full Docker environment before submitting pull requests, as some integrations and features will only work in the complete setup.
-
-
-## 7. Contributing
-
-1. Fork the repository on GitHub.
-2. Create a new branch for your feature or bug fix.
-3. Make your changes and commit them with clear, descriptive messages and ensure any documentation is updated related to your changes.
-4. Test your changes thoroughly in the Docker environment.
-5. Run the `test.sh` script to ensure all versions build correctly and pass the Cucumber tests:
-   ```bash
-   ./test.sh
-   ```
-6. Push your changes to your fork.
-7. Submit a pull request to the main repository. 
-8. See additional [contributing guidelines](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/CONTRIBUTING.md)
-
-When you raise a PR:
-- The `test.sh` script will run automatically against your PR.
-- The PR checks will verify versioning and dependency updates.
-- Documentation will be automatically updated for dependency changes.
-- Security issues will be checked using Snyk and PixeeBot.
-
-Address any issues that arise from these checks before finalizing your pull request.
-
-## 8. API Documentation
-
-API documentation is available at `/swagger-ui/index.html` when running the application. You can also view the latest API documentation [here](https://app.swaggerhub.com/apis-docs/Stirling-Tools/Stirling-PDF/).
-
-## 9. Customization
-
-Stirling-PDF can be customized through environment variables or a `settings.yml` file. Key customization options include:
-- Application name and branding
-- Security settings
-- UI customization
-- Endpoint management
-
-When using Docker, pass environment variables using the `-e` flag or in your `docker-compose.yml` file.
-
-Example:
-```
-docker run -p 8080:8080 -e APP_NAME="My PDF Tool" stirling-pdf:full
-```
-
-Refer to the main README for a full list of customization options.
-
-## 10. Language Translations
-
-For managing language translations that affect multiple files, Stirling-PDF provides a helper script:
-
-```bash
-/scripts/replace_translation_line.sh
-```
-
-This script helps you make consistent replacements across language files.
-
-When contributing translations:
-1. Use the helper script for multi-file changes.
-2. Ensure all language files are updated consistently.
-3. The PR checks will verify consistency in language file updates.
-
-Remember to test your changes thoroughly to ensure they don't break any existing functionality.
-
-
-
-
-# Code examples
-
-### Overview of Thymeleaf
-
-Thymeleaf is a  server-side Java HTML template engine. It is used in Stirling-PDF to render dynamic web pages. Thymeleaf integrates heavily with Spring Boot
-
-### Thymeleaf overview
-
-In Stirling-PDF, Thymeleaf is used to create HTML templates that are rendered on the server side. These templates are located in the `src/main/resources/templates` directory. Thymeleaf templates use a combination of HTML and special Thymeleaf attributes to dynamically generate content.
-Some examples of this are 
-```html
-<th:block th:insert="~{fragments/navbar.html :: navbar}"></th:block>
-or
-<th:block th:insert="~{fragments/footer.html :: footer}"></th:block>
-```
-Where it uses the th:block, th: indicating its a special thymeleaf element to be used serverside in generating the html, and block being the actual element type.
-In this case we are inserting the ``navbar`` entry within the ``fragments/navbar.html`` fragment into the ``th:block`` element.
-
-They can be more complex such as
-```html
-<th:block th:insert="~{fragments/common :: head(title=#{pageExtracter.title}, header=#{pageExtracter.header})}"></th:block>
-```
-Which is the same as above but passes the parameters title and header into the fragment common.html to be used in its HTML generation
-
-Thymeleaf can also be used to loop through objects or pass things from java side into html side.
-```java
- @GetMapping
-       public String newFeaturePage(Model model) {
-           model.addAttribute("exampleData", exampleData);
-           return "new-feature";
-       }
-```
-in above example if exampleData is a list of  plain java objects of class Person and within it you had id, name, age etc. You can reference it like so
-```html
-<tbody>
-   <!-- Use th:each to iterate over the list -->
-   <tr th:each="person : ${exampleData}">
-       <td th:text="${person.id}"></td>
-       <td th:text="${person.name}"></td>
-       <td th:text="${person.age}"></td>
-       <td th:text="${person.email}"></td>
-   </tr>
-</tbody>
-```
-This would generate n entries of tr for each person in exampleData
-
-### Adding a New Feature to the Backend (API)
-
-1. **Create a New Controller:**
-   - Create a new Java class in the `src/main/java/stirling/software/SPDF/controller/api` directory.
-   - Annotate the class with `@RestController` and `@RequestMapping` to define the API endpoint.
-   - Ensure to add API documentation annotations like `@Tag(name = "General", description = "General APIs")` and `@Operation(summary = "Crops a PDF document", description = "This operation takes an input PDF file and crops it according to the given coordinates. Input:PDF Output:PDF Type:SISO")`.
-
-   ```java
-   package stirling.software.SPDF.controller.api;
-
-   import org.springframework.web.bind.annotation.GetMapping;
-   import org.springframework.web.bind.annotation.RequestMapping;
-   import org.springframework.web.bind.annotation.RestController;
-   import io.swagger.v3.oas.annotations.Operation;
-   import io.swagger.v3.oas.annotations.tags.Tag;
-
-   @RestController
-   @RequestMapping("/api/v1/new-feature")
-   @Tag(name = "General", description = "General APIs")
-   public class NewFeatureController {
-
-       @GetMapping
-       @Operation(summary = "New Feature", description = "This is a new feature endpoint.")
-       public String newFeature() {
-           return "NewFeatureResponse"; // This refers to the NewFeatureResponse.html template presenting the user with the generated html from that file when they navigate to /api/v1/new-feature
-       }
-   }
-   ```
-
-2. **Define the Service Layer:** (Not required but often useful)
-   - Create a new service class in the `src/main/java/stirling/software/SPDF/service` directory.
-   - Implement the business logic for the new feature.
-
-   ```java
-   package stirling.software.SPDF.service;
-
-   import org.springframework.stereotype.Service;
-
-   @Service
-   public class NewFeatureService {
-
-       public String getNewFeatureData() {
-           // Implement business logic here
-           return "New Feature Data";
-       }
-   }
-   ```
-
-2b. **Integrate the Service with the Controller:**
-   - Autowire the service class in the controller and use it to handle the API request.
-
-   ```java
-   package stirling.software.SPDF.controller.api;
-
-   import org.springframework.beans.factory.annotation.Autowired;
-   import org.springframework.web.bind.annotation.GetMapping;
-   import org.springframework.web.bind.annotation.RequestMapping;
-   import org.springframework.web.bind.annotation.RestController;
-   import stirling.software.SPDF.service.NewFeatureService;
-   import io.swagger.v3.oas.annotations.Operation;
-   import io.swagger.v3.oas.annotations.tags.Tag;
-
-   @RestController
-   @RequestMapping("/api/v1/new-feature")
-   @Tag(name = "General", description = "General APIs")
-   public class NewFeatureController {
-
-       @Autowired
-       private NewFeatureService newFeatureService;
-
-       @GetMapping
-       @Operation(summary = "New Feature", description = "This is a new feature endpoint.")
-       public String newFeature() {
-           return newFeatureService.getNewFeatureData();
-       }
-   }
-   ```
-
-### Adding a New Feature to the Frontend (UI)
-
-1. **Create a New Thymeleaf Template:**
-   - Create a new HTML file in the `src/main/resources/templates` directory.
-   - Use Thymeleaf attributes to dynamically generate content.
-   - Use `extract-page.html` as a base example for the HTML template, useful to ensure importing of the general layout, navbar and footer.
-
-   ```html
-   <!DOCTYPE html>
-   <html th:lang="${#locale.language}" th:dir="#{language.direction}" th:data-language="${#locale.toString()}" xmlns:th="https://www.thymeleaf.org">
-     <head>
-     <th:block th:insert="~{fragments/common :: head(title=#{newFeature.title}, header=#{newFeature.header})}"></th:block>
-     </head>
-
-     <body>
-       <div id="page-container">
-         <div id="content-wrap">
-           <th:block th:insert="~{fragments/navbar.html :: navbar}"></th:block>
-           <br><br>
-           <div class="container">
-             <div class="row justify-content-center">
-               <div class="col-md-6 bg-card">
-                 <div class="tool-header">
-                   <span class="material-symbols-rounded tool-header-icon organize">upload</span>
-                   <span class="tool-header-text" th:text="#{newFeature.header}"></span>
-                 </div>
-                 <form th:action="@{'/api/v1/new-feature'}" method="post" enctype="multipart/form-data">
-                   <div th:replace="~{fragments/common :: fileSelector(name='fileInput', multipleInputsForSingleRequest=false, accept='application/pdf')}"></div>
-                   <input type="hidden" id="customMode" name="customMode" value="">
-                   <div class="mb-3">
-                     <label for="featureInput" th:text="#{newFeature.prompt}"></label>
-                     <input type="text" class="form-control" id="featureInput" name="featureInput" th:placeholder="#{newFeature.placeholder}" required>
-                   </div>
-
-                   <button type="submit" id="submitBtn" class="btn btn-primary" th:text="#{newFeature.submit}"></button>
-                 </form>
-               </div>
-             </div>
-           </div>
-         </div>
-         <th:block th:insert="~{fragments/footer.html :: footer}"></th:block>
-       </div>
-     </body>
-   </html>
-   ```
-
-2. **Create a New Controller for the UI:**
-   - Create a new Java class in the `src/main/java/stirling/software/SPDF/controller/ui` directory.
-   - Annotate the class with `@Controller` and `@RequestMapping` to define the UI endpoint.
-
-   ```java
-   package stirling.software.SPDF.controller.ui;
-
-   import org.springframework.beans.factory.annotation.Autowired;
-   import org.springframework.stereotype.Controller;
-   import org.springframework.ui.Model;
-   import org.springframework.web.bind.annotation.GetMapping;
-   import org.springframework.web.bind.annotation.RequestMapping;
-   import stirling.software.SPDF.service.NewFeatureService;
-
-   @Controller
-   @RequestMapping("/new-feature")
-   public class NewFeatureUIController {
-
-       @Autowired
-       private NewFeatureService newFeatureService;
-
-       @GetMapping
-       public String newFeaturePage(Model model) {
-           model.addAttribute("newFeatureData", newFeatureService.getNewFeatureData());
-           return "new-feature";
-       }
-   }
-   ```
-
-3. **Update the Navigation Bar:**
-   - Add a link to the new feature page in the navigation bar.
-   - Update the `src/main/resources/templates/fragments/navbar.html` file.
-
-   ```html
-   <li class="nav-item">
-       <a class="nav-link" th:href="@{/new-feature}">New Feature</a>
-   </li>
-   ```
-
-
-## Adding New Translations to Existing Language Files in Stirling-PDF
-
-When adding a new feature or modifying existing ones in Stirling-PDF, you'll need to add new translation entries to the existing language files. Here's a step-by-step guide:
-
-### 1. Locate Existing Language Files
-
-Find the existing `messages.properties` files in the `src/main/resources` directory. You'll see files like:
-
-- `messages.properties` (default, usually English)
-- `messages_en_GB.properties`
-- `messages_fr.properties`
-- `messages_de.properties`
-- etc.
-
-### 2. Add New Translation Entries
-
-Open each of these files and add your new translation entries. For example, if you're adding a new feature called "PDF Splitter", 
-Use descriptive, hierarchical keys (e.g., `feature.element.description`)
-you might add:
-
-```properties
-pdfSplitter.title=PDF Splitter
-pdfSplitter.description=Split your PDF into multiple documents
-pdfSplitter.button.split=Split PDF
-pdfSplitter.input.pages=Enter page numbers to split
-```
-
-Add these entries to the default GB language file and any others you wish, translating the values as appropriate for each language.
-
-### 3. Use Translations in Thymeleaf Templates
-
-In your Thymeleaf templates, use the `#{key}` syntax to reference the new translations:
-
-```html
-<h1 th:text="#{pdfSplitter.title}">PDF Splitter</h1>
-<p th:text="#{pdfSplitter.description}">Split your PDF into multiple documents</p>
-<input type="text" th:placeholder="#{pdfSplitter.input.pages}">
-<button th:text="#{pdfSplitter.button.split}">Split PDF</button>
-```
-
-
-
-Remember, never hard-code text in your templates or Java code. Always use translation keys to ensure proper localization.

Dockerfile

@@ -1,67 +0,0 @@
-# Main stage
-FROM alpine:3.20.3
-
-# 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 upgrade --no-cache -a && \
-    apk add --no-cache \
-        ca-certificates \
-        tzdata \
-        tini \
-        bash \
-        curl \
-        shadow \
-        su-exec \
-        openssl \
-        openssl-dev \
-        openjdk21-jre \
-# Doc conversion
-        libreoffice \
-# pdftohtml
-        poppler-utils \
-# OCR MY PDF (unpaper for descew and other advanced features)
-        ocrmypdf \
-        tesseract-ocr-data-eng \
-# CV
-        py3-opencv \
-# python3/pip
-        python3 \
-        py3-pip && \
-# uno unoconv and HTML
-    pip install --break-system-packages --no-cache-dir --upgrade unoconv WeasyPrint pdf2image pillow && \
-    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
-
-EXPOSE 8080/tcp
-
-# Set user and run command
-ENTRYPOINT ["tini", "--", "/scripts/init.sh"]
-CMD ["java", "-Dfile.encoding=UTF-8", "-jar", "/app.jar"]

Dockerfile-fat

@@ -1,83 +0,0 @@
-# Build the application
-FROM gradle:8.7-jdk17 AS build
-
-# Set the working directory
-WORKDIR /app
-
-# Copy the entire project to the working directory
-COPY . .
-
-# Build the application with DOCKER_ENABLE_SECURITY=false
-RUN DOCKER_ENABLE_SECURITY=true \
-./gradlew clean build
-
-# Main stage
-FROM alpine:3.20.3
-
-# Copy necessary files
-COPY scripts /scripts
-COPY pipeline /pipeline
-COPY src/main/resources/static/fonts/*.ttf /usr/share/fonts/opentype/noto/
-COPY --from=build /app/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 \
-    FAT_DOCKER=true \
-    INSTALL_BOOK_AND_ADVANCED_HTML_OPS=false
-
-
-# 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 upgrade --no-cache -a && \
-    apk add --no-cache \
-        ca-certificates \
-        tzdata \
-        tini \
-        bash \
-        curl \
-        shadow \
-        su-exec \
-        openssl \
-        openssl-dev \
-        openjdk21-jre \
-# Doc conversion
-        libreoffice \
-# pdftohtml
-        poppler-utils \
-# OCR MY PDF (unpaper for descew and other advanced featues)
-        ocrmypdf \
-        tesseract-ocr-data-eng \
-        font-terminus font-dejavu font-noto font-noto-cjk font-awesome font-noto-extra \
-# CV
-        py3-opencv \
-# python3/pip
-        python3 \
-    py3-pip && \
-# uno unoconv and HTML
-    pip install --break-system-packages --no-cache-dir --upgrade unoconv WeasyPrint pdf2image pillow && \
-    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
-
-EXPOSE 8080/tcp
-
-# Set user and run command
-ENTRYPOINT ["tini", "--", "/scripts/init.sh"]
-CMD ["java", "-Dfile.encoding=UTF-8", "-jar", "/app.jar"]

Dockerfile-ultra-lite

@@ -1,50 +0,0 @@
-# use alpine
-FROM alpine:3.20.3
-
-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 scripts/installFonts.sh /scripts/installFonts.sh
-COPY pipeline /pipeline
-COPY build/libs/*.jar app.jar
-
-# Set up necessary directories and permissions
-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 upgrade --no-cache -a && \
-    apk add --no-cache \
-        ca-certificates \
-        tzdata \
-        tini \
-        bash \
-        curl \
-        shadow \
-        su-exec \
-        openjdk21-jre && \
-    # User permissions
-    mkdir -p /configs /logs /customFiles /usr/share/fonts/opentype/noto && \
-    chmod +x /scripts/*.sh && \
-    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/tcp
-
-# Run the application
-ENTRYPOINT ["tini", "--", "/scripts/init-without-ocr.sh"]
-CMD ["java", "-Dfile.encoding=UTF-8", "-jar", "/app.jar"]

Endpoint-groups.md

@@ -1,47 +0,0 @@
-| 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           |         |         | ✔️        |       |     |        |        |             |          | ✔️    |            |
-| remove-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

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

@@ -1,56 +0,0 @@
-<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
-]
-```
-
-## Add New Translation Tags
-
-- **Important**: If you add any new translation tags, they must first be added to the `messages_en_GB.properties` file. This ensures consistency across all language files.
-- New translation tags **must be added** to the `messages_en_GB.properties` file to maintain a reference for other languages.
-- After adding the new tags to `messages_en_GB.properties`, add and translate them in the respective language file (e.g., `messages_pl_PL.properties`).
-
-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

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

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

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2024 Stirling Tools
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

LocalRunGuide.md

@@ -1,337 +0,0 @@
-
-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 # Not working - use instead address
-  address: 0.0.0.0
-  port: 3000
-```
-'-Djava.net.preferIPv4Stack=true' --> To force ipv4 only in the java starting command
-
-**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

@@ -1,44 +0,0 @@
-# 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,357 +1,159 @@
-<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>
+# StirlingPDF rewrite
 
-[![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)
+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.
 
-[![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)
-[<img src="https://www.ssdnodes.com/wp-content/uploads/2023/11/footer-logo.svg" alt="Name" height="40">](https://www.ssdnodes.com/manage/aff.php?aff=2216&register=true)
+![alt text](https://media.discordapp.net/attachments/1174462312904663120/1272615545719619674/image.png?ex=6700d5d6&is=66ff8456&hm=3e36a0c2214f2de07ba4ff4833f86aed5f2f3447f61fe80f5396654b202139b8&=&format=webp&quality=lossless)
+This image is here to reflect current progress and will be updated accordingly.
 
-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.
+## Try the new API!
 
-Stirling PDF does not initiate any outbound calls for record-keeping or tracking purposes.
+[![Run in Postman](https://run.pstmn.io/button.svg)](https://documenter.getpostman.com/view/30633786/2s9YRB1Wto)
 
-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.
+## Understanding Workflows
 
-![stirling-home](images/stirling-home.jpg)
+Workflows define how to apply operations to a PDF, including their order and relations with eachother.
+
+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
+  },
+  "actions": [
+    {
+      "type": "extract",
+      "values": {
+        "pageIndexes": [0, 2]
+      },
+      "actions": []
+    }
+  ]
+}
+```
+
+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
+  },
+  "actions": [
+    {
+      "type": "extract",
+      "values": {
+        "pageIndexes": [0, 2]
+      },
+      "actions": [
+        {
+          "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. 
+          },
+          "actions": []
+        }
+      ]
+    }
+  ]
+}
+```
+
+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.
 
 ## Features
 
-- Dark mode support.
-- Custom download options
-- Parallel file processing and downloads
-- Custom 'Pipelines' to run multiple features in a queue
-- 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)
-- Database Backup and Import (see [here](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/DATABASE.md) for documentation)
-
-## **PDF Features**
-
-### **Page Operations**
-
-- View and modify PDFs - View multi page PDFs with custom viewing sorting and searching. Plus on page edit features like annotate, draw and adding text and images. (Using PDF.js with Joxit and Liberation.Liberation fonts)
-- Full interactive GUI for merging/splitting/rotating/moving PDFs and their pages.
-- Merge multiple PDFs together into a single resultant file.
-- Split PDFs into multiple files at specified page numbers or extract all pages as individual files.
-- Reorganize PDF pages into different orders.
-- Rotate PDFs in 90-degree increments.
-- Remove pages.
-- Multi-page layout (Format PDFs into a multi-paged page).
-- Scale page contents size by set %.
-- Adjust Contrast.
-- Crop PDF.
-- Auto Split PDF (With physically scanned page dividers).
-- Extract page(s).
-- Convert PDF to a single page.
-- Overlay PDFs ontop of each other
-
-### **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.
-- Show/Detect embedded Javascript
-
-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).
-
-## 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
-### Windows
-For windows users download the latest Stirling-PDF.exe from our [release](https://github.com/Stirling-Tools/Stirling-PDF/releases) section or by clicking [here](https://github.com/Stirling-Tools/Stirling-PDF/releases/latest/download/Stirling-PDF.exe)
-
-### 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 3 different versions, a Full version and ultra-Lite version as well as a 'Fat' 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 Image Size (tag)](https://img.shields.io/docker/image-size/frooodle/s-pdf/latest-fat?label=Stirling-PDF%20Fat)
-
-Please note in below examples you may need to change the volume paths as needed, current examples install them to the current working directory
-eg ``./extraConfigs:/configs`` to ``/opt/stirlingpdf/extraConfigs:/configs``
-
-### Docker Run
-
-```bash
-docker run -d \
-  -p 8080:8080 \
-  -v ./trainingData:/usr/share/tessdata \
-  -v ./extraConfigs:/configs \
-  -v ./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
-
-  Can also add these for customisation but are not required
-
-  -v /location/of/customFiles:/customFiles \
-```
-
-### Docker Compose
-
-```yaml
-version: '3.3'
-services:
-  stirling-pdf:
-    image: frooodle/s-pdf:latest
-    ports:
-      - '8080:8080'
-    volumes:
-      - ./trainingData:/usr/share/tessdata #Required for extra OCR languages
-      - ./extraConfigs:/configs
-#      - ./customFiles:/customFiles/
-#      - ./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
-
-Please view https://github.com/Stirling-Tools/Stirling-PDF/blob/main/HowToUseOCR.md
-
-## Supported Languages
-
-Stirling PDF currently supports 38!
-
-| Language                                    | Progress                               |
-| ------------------------------------------- | -------------------------------------- |
-| Arabic (العربية) (ar_AR)                    | ![93%](https://geps.dev/progress/93)   |
-| Basque (Euskara) (eu_ES)                    | ![57%](https://geps.dev/progress/57)   |
-| Bulgarian (Български) (bg_BG)               | ![86%](https://geps.dev/progress/86)   |
-| Catalan (Català) (ca_CA)                    | ![44%](https://geps.dev/progress/44)   |
-| Croatian (Hrvatski) (hr_HR)                 | ![87%](https://geps.dev/progress/87)   |
-| Czech (Česky) (cs_CZ)                       | ![82%](https://geps.dev/progress/82)   |
-| Danish (Dansk) (da_DK)                      | ![91%](https://geps.dev/progress/91)   |
-| Dutch (Nederlands) (nl_NL)                  | ![88%](https://geps.dev/progress/88)   |
-| English (English) (en_GB)                   | ![100%](https://geps.dev/progress/100) |
-| English (US) (en_US)                        | ![100%](https://geps.dev/progress/100) |
-| French (Français) (fr_FR)                   | ![85%](https://geps.dev/progress/85)   |
-| German (Deutsch) (de_DE)                    | ![93%](https://geps.dev/progress/93) |
-| Greek (Ελληνικά) (el_GR)                    | ![75%](https://geps.dev/progress/75)   |
-| Hindi (हिंदी) (hi_IN)                          | ![72%](https://geps.dev/progress/72)   |
-| Hungarian (Magyar) (hu_HU)                  | ![69%](https://geps.dev/progress/69)   |
-| Indonesia (Bahasa Indonesia) (id_ID)        | ![70%](https://geps.dev/progress/70)   |
-| Irish (Gaeilge) (ga_IE)                     | ![90%](https://geps.dev/progress/90)   |
-| Italian (Italiano) (it_IT)                  | ![99%](https://geps.dev/progress/99)   |
-| Japanese (日本語) (ja_JP)                   | ![87%](https://geps.dev/progress/87)   |
-| Korean (한국어) (ko_KR)                     | ![77%](https://geps.dev/progress/77)   |
-| Norwegian (Norsk) (no_NB)                   | ![90%](https://geps.dev/progress/90)   |
-| Polish (Polski) (pl_PL)                     | ![84%](https://geps.dev/progress/84)   |
-| Portuguese (Português) (pt_PT)              | ![72%](https://geps.dev/progress/72)   |
-| Portuguese Brazilian (Português) (pt_BR)    | ![99%](https://geps.dev/progress/99)   |
-| Romanian (Română) (ro_RO)                   | ![92%](https://geps.dev/progress/92)   |
-| Russian (Русский) (ru_RU)                   | ![77%](https://geps.dev/progress/77)   |
-| Serbian Latin alphabet (Srpski) (sr_LATN_RS) | ![72%](https://geps.dev/progress/72)   |
-| Simplified Chinese (简体中文) (zh_CN)       | ![93%](https://geps.dev/progress/93)   |
-| Slovakian (Slovensky) (sk_SK)               | ![84%](https://geps.dev/progress/84)   |
-| Spanish (Español) (es_ES)                   | ![93%](https://geps.dev/progress/93)   |
-| Swedish (Svenska) (sv_SE)                   | ![92%](https://geps.dev/progress/92)   |
-| Thai (ไทย) (th_TH)                          | ![91%](https://geps.dev/progress/91) |
-| Traditional Chinese (繁體中文) (zh_TW)      | ![99%](https://geps.dev/progress/99)   |
-| Turkish (Türkçe) (tr_TR)                    | ![94%](https://geps.dev/progress/94)   |
-| Ukrainian (Українська) (uk_UA)              | ![82%](https://geps.dev/progress/82)   |
-| Vietnamese (Tiếng Việt) (vi_VN)             | ![90%](https://geps.dev/progress/90)   |
-
-## Contributing (creating issues, translations, fixing bugs, etc.)
-
-Please see our [Contributing Guide](CONTRIBUTING.md)!
-
-## Customisation
-
-Stirling PDF allows easy customization of the app.
-Includes things like
-
-- Custom application name
-- Custom slogans, icons, HTML, images CSS etc (via file overrides)
-
-There are two options for this, either using the generated settings file ``settings.yml``
-This file is located in the ``/configs`` directory and follows standard YAML formatting
-
-Environment variables are also supported and would override the settings file
-For example in the settings.yml you have
-
-```yaml
-security:
-  enableLogin: 'true'
-```
-
-To have this via an environment variable you would have ``SECURITY_ENABLELOGIN``
-
-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; when using e.g. Fail2Ban you can deactivate the function with -1
-  loginResetTimeMinutes: 120 # lock account for 2 hours after x attempts
-  loginMethod: all # 'all' (Login Username/Password and OAuth2[must be enabled and configured]), 'normal'(only Login with Username/Password) or 'oauth2'(only Login with OAuth2)
-  initialLogin:
-    username: '' # Initial username for the first login
-    password: '' # 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)
-    client:
-      keycloak:
-        issuer: '' # URL of the Keycloak realm's OpenID Connect Discovery endpoint
-        clientId: '' # Client ID for Keycloak OAuth2
-        clientSecret: '' # Client Secret for Keycloak OAuth2
-        scopes: openid, profile, email # Scopes for Keycloak OAuth2
-        useAsUsername: preferred_username # Field to use as the username for Keycloak OAuth2
-      google:
-        clientId: '' # Client ID for Google OAuth2
-        clientSecret: '' # Client Secret for Google OAuth2
-        scopes: https://www.googleapis.com/auth/userinfo.email, https://www.googleapis.com/auth/userinfo.profile # Scopes for Google OAuth2
-        useAsUsername: email # Field to use as the username for Google OAuth2
-      github:
-        clientId: '' # Client ID for GitHub OAuth2
-        clientSecret: '' # Client Secret for GitHub OAuth2
-        scopes: read:user # Scope for GitHub OAuth2
-        useAsUsername: login # Field to use as the username for GitHub OAuth2
-    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
-    blockRegistration: false # set to 'true' to deny login with SSO without prior registration by an admin
-    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: '' # Application's visible name
-  homeDescription: '' # Short description or tagline shown on homepage.
-  appNameNavbar: '' # 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;``
+### Rewrite Roadmap
+
+* [X] Client side PDF-Manipulation
+* [X] Workflows
+* [X] passportjs backend (auth)
+* [ ] Auth in frontend
+* [ ] Feature equivalent with S-PDF v1
+* [ ] Stateful UI
+* [ ] Node based editing of Workflows
+
+### Functions
+
+Current functions of spdf and their progress in this repo.
+
+#### PDF Functions
+
+| Status | Feature                                            | Description |
+| ------ | -------------------------------------------------- | ----------- |
+| ✔️   | arrange                                            |             |
+| ✔️   | extract                                            |             |
+| ✔️   | impose                                             |             |
+| ✔️   | merge                                              |             |
+| ✔️   | remove blank                                       |             |
+| ✔️   | remove                                             |             |
+| ✔️   | rotate pages                                       |             |
+| ✔️   | scale content                                      |             |
+| ✔️   | scale pages                                        |             |
+| ✔️   | split by preset                                    |             |
+| ✔️   | split by index                                     |             |
+| ✔️   | update metadata                                    |             |
+| ✔️   | pdf to single large page                           |             |
+| 🚧    | remove annotations                                 |             |
+| 🚧    | flatten                                            |             |
+| 🚧    | overlay pdfs                                       |             |
+| 🚧    | compress                                           |             |
+| 🚧    | change permissions                                 |             |
+| 🚧    | pdf to pdf/a                                       |             |
+| 🚧    | add page numbers                                   |             |
+| 🚧    | add image                                          |             |
+| 🚧    | add watermark                                      |             |
+| 🚧    | auto rename                                        |             |
+| 🚧    | add stamp                                          |             |
+| ❌     | repair                                             |             |
+| ❌     | sign with cert                                     |             |
+| ❌     | ocr                                                |             |
+| ❌     | auto split by size/count (+split by preset)        |             |
+| ❌     | split pdfs by sections/chapters (+split by preset) |             |
+| ❌     | adjust colors/contrast                             |             |
+| ❌     | adjust colors/contrast                             |             |
+| ❌     | sanitize                                           |             |
+| ❌     | sign                                               |             |
+| ❌     | basic text editing                                 |             |
+| ❌     | auto redact                                        |             |
+
+#### Generic Filetype (Filetypes are not supported by workflows yet. Coming Soon™)
+
+| Status | Feature             | Description |
+| ------ | ------------------- | ----------- |
+| 🚧    | image to pdf        |             |
+| 🚧    | pdf to image        |             |
+| 🚧    | extract images      |             |
+| 🚧    | show javascript     |             |
+| ❌     | convert file to pdf |             |
+| ❌     | pdf to word         |             |
+| ❌     | pdf to presentation |             |
+| ❌     | pdf to rtf          |             |
+| ❌     | pdf to html         |             |
+| ❌     | pdf to xml          |             |
+| ❌     | url/website to pdf  |             |
+| ❌     | markdown to pdf     |             |
+| ❌     | pdf to csv          |             |
+| ❌     | get all info        |             |
+| ❌     | compare             |             |
+
+✔️: Done, 🚧: Possible with current Libraries, ❌: Planned Feature
+
+## Contribute
+
+For initial instructions look at [CONTRIBUTE.md](./CONTRIBUTE.md)

Version-groups.md

@@ -1,56 +0,0 @@
-|All versions in a Docker environment can download Calibre as a optional extra at runtime to support `book-to-pdf` and `pdf-to-book` using parameter ``INSTALL_BOOK_AND_ADVANCED_HTML_OPS``.
-The 'Fat' container contains all those found in 'Full' with security jar along with this Calibre install. 
-
-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              | ✔️          | ✔️    |
-| remove-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

@@ -1,260 +0,0 @@
-plugins {
-    id "java"
-    id "org.springframework.boot" version "3.3.4"
-    id "io.spring.dependency-management" version "1.1.6"
-    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.6"
-    id "com.diffplug.spotless" version "6.25.0"
-    id "com.github.jk1.dependency-license-report" version "2.9"
-	//id "nebula.lint" version "19.0.3"
-}
-
-import com.github.jk1.license.render.*
-
-ext {
-    springBootVersion = "3.3.4"
-    pdfboxVersion = "3.0.3"
-    logbackVersion = "1.5.7"
-    imageioVersion = "3.12.0"
-    lombokVersion = "1.18.34"
-    bouncycastleVersion = "1.78.1"
-}
-
-group = "stirling.software"
-version = "0.30.0"
-
-java {
-    // 17 is lowest but we support and recommend 21
-    sourceCompatibility = JavaVersion.VERSION_17
-}
-
-repositories {
-    mavenCentral()
-    maven { url "https://jitpack.io" }
-    maven { url "https://build.shibboleth.net/nexus/content/repositories/releases/" }
-    maven {
-        url 'https://build.shibboleth.net/maven/releases'
-    }
-}
-
-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/api/DatabaseController.java"
-                exclude "stirling/software/SPDF/controller/web/AccountWebController.java"
-                exclude "stirling/software/SPDF/controller/web/DatabaseWebController.java"
-                exclude "stirling/software/SPDF/model/ApiKeyAuthenticationToken.java"
-                exclude "stirling/software/SPDF/model/AttemptCounter.java"
-                exclude "stirling/software/SPDF/model/Authority.java"
-                exclude "stirling/software/SPDF/model/PersistentLogin.java"
-                exclude "stirling/software/SPDF/model/SessionEntity.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.22.0").aosp().reorderImports(false)
-
-        importOrder("java", "javax", "org", "com", "net", "io")
-        toggleOffOn()
-        trimTrailingWhitespace()
-        indentWithSpaces()
-        endWithNewline()
-    }
-}
-
-//gradleLint {
-//        rules=['unused-dependency']
-//    }
-tasks.wrapper {
-    gradleVersion = "8.7"
-}
-//tasks.withType(JavaCompile) {
-//    options.compilerArgs << "-Xlint:deprecation"
-//}
-configurations.all {
-    exclude group: "org.springframework.boot", module: "spring-boot-starter-tomcat"
-}
-dependencies {
-    //security updates
-    implementation "org.springframework:spring-webmvc:6.1.13"
-
-    implementation("io.github.pixee:java-security-toolkit:1.2.0")
-
-    // implementation "org.yaml:snakeyaml:2.2"
-    implementation 'com.github.Carleslc.Simple-YAML:Simple-Yaml:1.8.4'
-
-    // Exclude Tomcat and include Jetty
-    implementation("org.springframework.boot:spring-boot-starter-web:$springBootVersion")
-    implementation "org.springframework.boot:spring-boot-starter-jetty:$springBootVersion"
-
-    implementation "org.springframework.boot:spring-boot-starter-thymeleaf:$springBootVersion"
-    implementation 'com.posthog.java:posthog:1.1.1'
-    implementation 'com.googlecode.owasp-java-html-sanitizer:owasp-java-html-sanitizer:20240325.1'
-
-
-    if (System.getenv("DOCKER_ENABLE_SECURITY") != "false") {
-        implementation "org.springframework.boot:spring-boot-starter-security:$springBootVersion"
-        runtimeOnly "org.thymeleaf.extras:thymeleaf-extras-springsecurity5:3.1.2.RELEASE"
-        implementation "org.springframework.boot:spring-boot-starter-data-jpa:$springBootVersion"
-        implementation "org.springframework.boot:spring-boot-starter-oauth2-client:$springBootVersion"
-
-		implementation 'org.springframework.security:spring-security-saml2-service-provider:6.3.3'
-	    implementation 'com.unboundid.product.scim2:scim2-sdk-client:2.3.5'
-        //2.2.x requires rebuild of DB file.. need migration path
-        runtimeOnly "com.h2database:h2:2.1.214"
-        // implementation "com.h2database:h2:2.2.224"
-        constraints {
-            implementation "org.opensaml:opensaml-core"
-            implementation "org.opensaml:opensaml-saml-api"
-            implementation "org.opensaml:opensaml-saml-impl"
-        }
-        implementation "org.springframework.security:spring-security-saml2-service-provider"
-
-        implementation 'com.coveo:saml-client:5.0.0'
-    }
-
-    testImplementation "org.springframework.boot:spring-boot-starter-test:$springBootVersion"
-
-    // Batik
-    implementation "org.apache.xmlgraphics:batik-all:1.18"
-
-    // TwelveMonkeys
-    runtimeOnly "com.twelvemonkeys.imageio:imageio-batik:$imageioVersion"
-    runtimeOnly "com.twelvemonkeys.imageio:imageio-bmp:$imageioVersion"
-    // runtimeOnly "com.twelvemonkeys.imageio:imageio-hdr:$imageioVersion"
-    // runtimeOnly "com.twelvemonkeys.imageio:imageio-icns:$imageioVersion"
-    // runtimeOnly "com.twelvemonkeys.imageio:imageio-iff:$imageioVersion"
-    runtimeOnly "com.twelvemonkeys.imageio:imageio-jpeg:$imageioVersion"
-    // runtimeOnly "com.twelvemonkeys.imageio:imageio-pcx:$imageioVersion@
-    // runtimeOnly "com.twelvemonkeys.imageio:imageio-pict:$imageioVersion"
-    // runtimeOnly "com.twelvemonkeys.imageio:imageio-pnm:$imageioVersion"
-    // runtimeOnly "com.twelvemonkeys.imageio:imageio-psd:$imageioVersion"
-    // runtimeOnly "com.twelvemonkeys.imageio:imageio-sgi:$imageioVersion"
-    // runtimeOnly "com.twelvemonkeys.imageio:imageio-tga:$imageioVersion"
-    // runtimeOnly "com.twelvemonkeys.imageio:imageio-thumbsdb:$imageioVersion"
-    runtimeOnly "com.twelvemonkeys.imageio:imageio-tiff:$imageioVersion"
-    runtimeOnly "com.twelvemonkeys.imageio:imageio-webp:$imageioVersion"
-    // runtimeOnly "com.twelvemonkeys.imageio:imageio-xwd:$imageioVersion"
-
-    implementation "commons-io:commons-io:2.17.0"
-    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:$pdfboxVersion") {
-        exclude group: "commons-logging", module: "commons-logging"
-    }
-
-    implementation ("org.apache.pdfbox:xmpbox:$pdfboxVersion") {
-        exclude group: "commons-logging", module: "commons-logging"
-    }
-
-    implementation 'org.apache.pdfbox:jbig2-imageio:3.0.4'
-
-    implementation "org.bouncycastle:bcprov-jdk18on:$bouncycastleVersion"
-    implementation "org.bouncycastle:bcpkix-jdk18on:$bouncycastleVersion"
-    implementation "org.springframework.boot:spring-boot-starter-actuator:$springBootVersion"
-    implementation "io.micrometer:micrometer-core:1.13.6"
-    implementation group: "com.google.zxing", name: "core", version: "3.5.3"
-    // https://mvnrepository.com/artifact/org.commonmark/commonmark
-    implementation "org.commonmark:commonmark:0.23.0"
-    implementation "org.commonmark:commonmark-ext-gfm-tables:0.23.0"
-    // https://mvnrepository.com/artifact/com.bucket4j/bucket4j_jdk17
-    implementation "com.bucket4j:bucket4j_jdk17-core:8.14.0"
-    implementation "com.fathzer:javaluator:3.0.5"
-
-    developmentOnly("org.springframework.boot:spring-boot-devtools:$springBootVersion")
-    compileOnly "org.projectlombok:lombok:$lombokVersion"
-    annotationProcessor "org.projectlombok:lombok:$lombokVersion"
-
-    testRuntimeOnly 'org.mockito:mockito-inline:5.2.0'
-}
-
-tasks.withType(JavaCompile).configureEach {
-    options.encoding = "UTF-8"
-    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

@@ -1,16 +0,0 @@
-apiVersion: v2
-appVersion: 0.30.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

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

@@ -1,129 +0,0 @@
-{{/*
-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

@@ -1,131 +0,0 @@
-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 }}
-        env:
-        - name: SYSTEM_ROOTURIPATH
-          value: {{ .Values.rootPath}}
-{{- if .Values.envs }}
-{{ toYaml .Values.envs | indent 8 }}
-{{- end }}
-{{- if .Values.extraArgs }}
-        args:
-{{ toYaml .Values.extraArgs | indent 8 }}
-{{- end }}
-        ports:
-        - name: http
-          containerPort: 8080
-        livenessProbe:
-          httpGet:
-            path: {{ .Values.rootPath}}
-            port: http
-{{ toYaml .Values.probes.livenessHttpGetConfig | indent 12 }}
-{{ toYaml .Values.probes.liveness | indent 10 }}
-        readinessProbe:
-          httpGet:
-            path: {{ .Values.rootPath}}
-            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

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

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

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

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

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

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

@@ -1,240 +0,0 @@
-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
-
-# rootpath for the application
-rootPath: /
-
-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_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-tauri/.env

@@ -0,0 +1,2 @@
+VITE_USE_AUTH=False
+VITE_BACKEND=""

client-tauri/.gitignore

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

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

client-tauri/Dockerfile

@@ -0,0 +1,15 @@
+# Use an existing image as a base
+FROM node:22.2.0-alpine
+
+WORKDIR /app
+
+COPY package*.json ./
+RUN npm ci --legacy-peer-deps
+
+RUN npm i -g serve
+
+COPY ./dist ./dist
+
+EXPOSE 3000
+
+CMD [ "serve", "-s", "dist", "-p", "3000" ]

client-tauri/Makefile

@@ -0,0 +1,13 @@
+vite-build:
+	npx tsc
+	npx vite build
+
+vite-dockerize:
+	make vite-build
+	bash -c "cp ../package-lock.json ./"
+	docker build . -t stirling-pdf:latest
+	bash -c "rm ./package-lock.json"
+	docker image prune
+
+tauri-build:
+	npx tauri build

client-tauri/README.md

@@ -0,0 +1,11 @@
+# Stirling-PDF frontend
+
+Tauri + Vite + React + Typescript
+
+## Development 
+
+Use the package scripts to start developement
+
+## Production
+
+Use the make file to build for the correct platform

client-tauri/index.html

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

@@ -0,0 +1,43 @@
+{
+  "name": "@stirling-pdf/client-tauri",
+  "private": true,
+  "version": "0.0.0",
+  "type": "module",
+  "scripts": {
+    "vite:dev": "vite",
+    "vite:preview-prod": "make vite-build && vite preview",
+    "tauri:build-debug": "npx tauri build --debug",
+    "tauri:dev": "tauri dev"
+  },
+  "dependencies": {
+    "@stirling-pdf/shared-operations": "^0.0.0",
+    "@tauri-apps/api": "^1.5.1",
+    "@types/semver": "^7.5.8",
+    "archiver": "^6.0.1",
+    "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-dom": "^18.2.0",
+    "react-i18next": "^15.0.1",
+    "react-icons": "^4.11.0",
+    "react-material-symbols": "^4.4.0",
+    "react-router-bootstrap": "^0.26.2",
+    "react-router-dom": "^6.18.0",
+    "vite": "^5.4.2",
+    "vite-plugin-node-polyfills": "^0.22.0",
+    "vite-plugin-top-level-await": "^1.3.1"
+  },
+  "devDependencies": {
+    "@tauri-apps/cli": "^1.5.0",
+    "@types/archiver": "^6.0.2",
+    "@types/react": "^18.2.15",
+    "@types/react-dom": "^18.2.7",
+    "@types/react-router-bootstrap": "^0.26.5",
+    "@vitejs/plugin-react": "^4.3.1",
+    "typescript": "^5.0.2",
+    "vite-plugin-compile-time": "^0.2.1",
+    "vite-plugin-dynamic-import": "^1.5.0"
+  }
+}

client-tauri/public/stirling-pdf-logo.svg

@@ -0,0 +1,298 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!-- Created with Inkscape (http://www.inkscape.org/) -->
+
+<svg
+   width="99.537987mm"
+   height="95.209366mm"
+   viewBox="0 0 99.537987 95.209366"
+   version="1.1"
+   id="svg745"
+   xml:space="preserve"
+   inkscape:version="1.2.2 (b0a8486541, 2022-12-01)"
+   sodipodi:docname="stirling-transparent.svg"
+   inkscape:export-filename="stirling.png"
+   inkscape:export-xdpi="80"
+   inkscape:export-ydpi="80"
+   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+   xmlns:xlink="http://www.w3.org/1999/xlink"
+   xmlns="http://www.w3.org/2000/svg"
+   xmlns:svg="http://www.w3.org/2000/svg"><sodipodi:namedview
+     id="namedview747"
+     pagecolor="#ffffff"
+     bordercolor="#666666"
+     borderopacity="1.0"
+     inkscape:showpageshadow="2"
+     inkscape:pageopacity="0.0"
+     inkscape:pagecheckerboard="0"
+     inkscape:deskcolor="#d1d1d1"
+     inkscape:document-units="mm"
+     showgrid="false"
+     inkscape:zoom="0.914906"
+     inkscape:cx="175.42786"
+     inkscape:cy="510.43495"
+     inkscape:window-width="2256"
+     inkscape:window-height="1428"
+     inkscape:window-x="0"
+     inkscape:window-y="40"
+     inkscape:window-maximized="1"
+     inkscape:current-layer="svg745" /><defs
+     id="defs742"><linearGradient
+       inkscape:collect="always"
+       id="linearGradient72198"><stop
+         style="stop-color:#ccd6d7;stop-opacity:1;"
+         offset="0"
+         id="stop72194" /><stop
+         style="stop-color:#0f3a3f;stop-opacity:1;"
+         offset="1"
+         id="stop72196" /></linearGradient><linearGradient
+       inkscape:collect="always"
+       id="linearGradient71928"><stop
+         style="stop-color:#4b0005;stop-opacity:1;"
+         offset="0"
+         id="stop71924" /><stop
+         style="stop-color:#8f000c;stop-opacity:1;"
+         offset="1"
+         id="stop71926" /></linearGradient><linearGradient
+       inkscape:collect="always"
+       id="linearGradient71920"><stop
+         style="stop-color:#4b0005;stop-opacity:1;"
+         offset="0"
+         id="stop71916" /><stop
+         style="stop-color:#8f000c;stop-opacity:1;"
+         offset="1"
+         id="stop71918" /></linearGradient><linearGradient
+       inkscape:collect="always"
+       id="linearGradient69598"><stop
+         style="stop-color:#6a0007;stop-opacity:1;"
+         offset="0"
+         id="stop69594" /><stop
+         style="stop-color:#b8000f;stop-opacity:1;"
+         offset="1"
+         id="stop69596" /></linearGradient><linearGradient
+       inkscape:collect="always"
+       id="linearGradient46361"><stop
+         style="stop-color:#f7f6f8;stop-opacity:1;"
+         offset="0"
+         id="stop46359" /><stop
+         style="stop-color:#b7b7b5;stop-opacity:1;"
+         offset="1"
+         id="stop46357" /></linearGradient><linearGradient
+       inkscape:collect="always"
+       id="linearGradient40554"><stop
+         style="stop-color:#f4f2f4;stop-opacity:1;"
+         offset="0"
+         id="stop40550" /><stop
+         style="stop-color:#57767b;stop-opacity:1;"
+         offset="1"
+         id="stop40552" /></linearGradient><linearGradient
+       inkscape:collect="always"
+       id="linearGradient39095"><stop
+         style="stop-color:#285459;stop-opacity:1;"
+         offset="0"
+         id="stop39093" /><stop
+         style="stop-color:#a6b6af;stop-opacity:1;"
+         offset="1"
+         id="stop39091" /></linearGradient><linearGradient
+       inkscape:collect="always"
+       id="linearGradient36672"><stop
+         style="stop-color:#da453f;stop-opacity:1;"
+         offset="0"
+         id="stop36668" /><stop
+         style="stop-color:#a60008;stop-opacity:1;"
+         offset="1"
+         id="stop36670" /></linearGradient><linearGradient
+       inkscape:collect="always"
+       id="linearGradient19524"><stop
+         style="stop-color:#3a4b4f;stop-opacity:1;"
+         offset="0"
+         id="stop19522" /><stop
+         style="stop-color:#617979;stop-opacity:0.97461927;"
+         offset="1"
+         id="stop19520" /></linearGradient><linearGradient
+       inkscape:collect="always"
+       id="linearGradient17996"><stop
+         style="stop-color:#401016;stop-opacity:1;"
+         offset="0"
+         id="stop17994" /><stop
+         style="stop-color:#761f19;stop-opacity:1;"
+         offset="1"
+         id="stop17992" /></linearGradient><linearGradient
+       inkscape:collect="always"
+       id="linearGradient15569"><stop
+         style="stop-color:#8ea8ad;stop-opacity:1;"
+         offset="0"
+         id="stop15565" /><stop
+         style="stop-color:#e9e7eb;stop-opacity:1;"
+         offset="1"
+         id="stop15567" /></linearGradient><linearGradient
+       inkscape:collect="always"
+       id="linearGradient15557"><stop
+         style="stop-color:#9b0e11;stop-opacity:1;"
+         offset="0"
+         id="stop15553" /><stop
+         style="stop-color:#370707;stop-opacity:1;"
+         offset="1"
+         id="stop15555" /></linearGradient><linearGradient
+       inkscape:collect="always"
+       xlink:href="#linearGradient15557"
+       id="linearGradient15559"
+       x1="120.06672"
+       y1="63.25761"
+       x2="135.16347"
+       y2="78.078682"
+       gradientUnits="userSpaceOnUse" /><linearGradient
+       inkscape:collect="always"
+       xlink:href="#linearGradient15569"
+       id="linearGradient15571"
+       x1="127.97037"
+       y1="101.66144"
+       x2="133.88971"
+       y2="104.77026"
+       gradientUnits="userSpaceOnUse" /><linearGradient
+       inkscape:collect="always"
+       xlink:href="#linearGradient17996"
+       id="linearGradient17998"
+       x1="117.9284"
+       y1="86.055084"
+       x2="130.67392"
+       y2="76.945541"
+       gradientUnits="userSpaceOnUse" /><linearGradient
+       inkscape:collect="always"
+       xlink:href="#linearGradient19524"
+       id="linearGradient19528"
+       x1="130.98172"
+       y1="82.402977"
+       x2="135.72115"
+       y2="86.45166"
+       gradientUnits="userSpaceOnUse" /><linearGradient
+       inkscape:collect="always"
+       xlink:href="#linearGradient36672"
+       id="linearGradient36674"
+       x1="63.797714"
+       y1="74.81752"
+       x2="96.636673"
+       y2="120.29293"
+       gradientUnits="userSpaceOnUse" /><linearGradient
+       inkscape:collect="always"
+       xlink:href="#linearGradient39095"
+       id="linearGradient39097"
+       x1="120.54506"
+       y1="124.76902"
+       x2="128.04152"
+       y2="126.0704"
+       gradientUnits="userSpaceOnUse" /><linearGradient
+       inkscape:collect="always"
+       xlink:href="#linearGradient40554"
+       id="linearGradient40556"
+       x1="113.84585"
+       y1="114.04285"
+       x2="119.65858"
+       y2="128.50244"
+       gradientUnits="userSpaceOnUse" /><linearGradient
+       inkscape:collect="always"
+       xlink:href="#linearGradient46361"
+       id="linearGradient46363"
+       x1="73.993439"
+       y1="114.13906"
+       x2="94.845322"
+       y2="71.247383"
+       gradientUnits="userSpaceOnUse" /><linearGradient
+       inkscape:collect="always"
+       xlink:href="#linearGradient69598"
+       id="linearGradient69600"
+       x1="95.854446"
+       y1="114.66749"
+       x2="103.77842"
+       y2="120.1887"
+       gradientUnits="userSpaceOnUse" /><linearGradient
+       inkscape:collect="always"
+       xlink:href="#linearGradient71920"
+       id="linearGradient71922"
+       x1="98.580376"
+       y1="87.186958"
+       x2="118.09738"
+       y2="101.19449"
+       gradientUnits="userSpaceOnUse" /><linearGradient
+       inkscape:collect="always"
+       xlink:href="#linearGradient71928"
+       id="linearGradient71930"
+       x1="78.278267"
+       y1="97.433273"
+       x2="92.313202"
+       y2="104.33479"
+       gradientUnits="userSpaceOnUse" /><linearGradient
+       inkscape:collect="always"
+       xlink:href="#linearGradient72198"
+       id="linearGradient72200"
+       x1="125.76636"
+       y1="138.46817"
+       x2="123.3327"
+       y2="126.03291"
+       gradientUnits="userSpaceOnUse" /></defs><g
+     inkscape:groupmode="layer"
+     id="layer5"
+     inkscape:label="shadow"
+     style="display:inline"
+     sodipodi:insensitive="true"
+     transform="translate(-51.420144,-44.470286)"><path
+       style="display:inline;fill:url(#linearGradient72200);fill-opacity:1;stroke:none;stroke-width:0.264583px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+       d="m 84.146049,134.73858 c 0,0 11.721038,2.48294 17.938661,2.91673 6.21763,0.43378 14.75251,0.59994 22.41237,-0.43379 8.01008,-1.081 13.19907,-2.22733 14.50043,-2.66112 1.30136,-0.43379 4.00784,-1.24297 4.15244,-2.25514 0.1446,-1.01217 -3.4703,-2.74733 -6.21763,-3.32571 -2.74732,-0.57838 -12.72444,-1.44596 -14.89337,-1.44596 -2.16894,0 -37.892901,7.20499 -37.892901,7.20499 z"
+       id="path72192"
+       sodipodi:nodetypes="cssssssc" /></g><g
+     inkscape:groupmode="layer"
+     id="layer2"
+     inkscape:label="Origami"
+     style="display:inline"
+     sodipodi:insensitive="true"
+     transform="translate(-51.420144,-44.470286)"><path
+       style="display:inline;fill:url(#linearGradient40556);fill-opacity:1;stroke:none;stroke-width:0.264583px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+       d="m 84.460552,134.86721 35.165798,-6.85679 16.15467,-42.7383 z"
+       id="path960"
+       sodipodi:nodetypes="cccc" /><path
+       style="fill:url(#linearGradient15571);fill-opacity:1;stroke:none;stroke-width:0.264583px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+       d="m 135.71493,85.428056 0.3984,45.049024 -9.66213,-20.46173 z"
+       id="path964"
+       sodipodi:nodetypes="cccc" /><path
+       style="display:inline;fill:url(#linearGradient39097);fill-opacity:1;stroke:none;stroke-width:0.264583px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+       d="m 119.60518,128.00293 16.5337,2.48693 -9.68769,-20.5512 z"
+       id="path966"
+       sodipodi:nodetypes="cccc" /><path
+       style="display:inline;fill:url(#linearGradient15559);fill-opacity:1;stroke:none;stroke-width:0.264583px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+       d="m 118.42209,57.022622 12.70423,-2.766809 -0.0785,25.087175 -12.43878,-13.376518 z"
+       id="path968"
+       sodipodi:nodetypes="ccccc" /><path
+       style="display:inline;fill:url(#linearGradient19528);fill-opacity:1;stroke:none;stroke-width:0.264583px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+       d="m 135.72114,85.386768 -4.84219,-6.459493 0.0305,11.126604 z"
+       id="path970"
+       sodipodi:nodetypes="cccc" /><path
+       style="display:inline;fill:url(#linearGradient17998);fill-opacity:1;stroke:none;stroke-width:0.264583px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+       d="m 119.10273,65.682415 11.96883,13.44935 -0.0899,10.819868 -11.88577,11.430427 z"
+       id="path972"
+       sodipodi:nodetypes="ccccc" /><path
+       style="display:inline;fill:url(#linearGradient36674);fill-opacity:1;stroke:none;stroke-width:0.264583px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+       d="M 62.145635,130.15618 62.043392,65.435258 c 0,0 0.179321,-2.778132 1.89516,-4.036097 1.874923,-1.374597 4.341768,-1.894096 4.341768,-1.894096 l 50.91788,-11.349167 -0.0113,53.144272 -34.733274,33.56547 z"
+       id="path958"
+       sodipodi:nodetypes="ccsccccc" /></g><g
+     inkscape:groupmode="layer"
+     id="layer3"
+     inkscape:label="Letter"
+     style="display:inline"
+     sodipodi:insensitive="true"
+     transform="translate(-51.420144,-44.470286)"><path
+       style="display:inline;fill:url(#linearGradient69600);fill-opacity:1;stroke:none;stroke-width:0.264583px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+       d="m 94.780881,91.406803 16.870379,17.074877 -23.723345,23.00249 -18.122131,-17.99816 5.497473,-2.80607 18.404054,-0.0511 2.35163,-8.23071 z"
+       id="path54894"
+       sodipodi:nodetypes="cccccccc" /><path
+       style="display:inline;fill:url(#linearGradient71930);fill-opacity:1;stroke:none;stroke-width:0.264583px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+       d="m 72.440405,92.224764 16.15467,15.745686 4.089788,-6.79927 z"
+       id="path54892" /><path
+       style="display:inline;fill:url(#linearGradient71922);fill-opacity:1;stroke:none;stroke-width:0.264583px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+       d="m 95.138739,84.965385 1.124691,-14.109776 22.92453,22.286787 0.008,8.164604 -3.28863,3.16649 z"
+       id="path54890"
+       sodipodi:nodetypes="cccccc"
+       inkscape:label="path54890" /><path
+       style="display:inline;fill:url(#linearGradient46363);fill-opacity:1;stroke:none;stroke-width:0.264583px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+       d="m 95.138739,84.965385 h 1.226936 l -0.05112,-14.109776 c 0,0 -5.776827,-3.220709 -12.167126,-2.40275 -6.390296,0.817957 -8.151582,2.1248 -10.58233,4.396523 -1.90229,1.777838 -2.913974,3.527446 -3.987546,7.157132 -0.512646,1.733226 -0.281963,5.988892 0.613471,8.537436 0.664591,1.891528 2.453873,4.294281 4.958868,6.134686 2.662335,1.956002 8.281825,3.527443 8.281825,3.527443 0,0 5.134614,1.887351 5.572338,4.294281 0.308137,1.69437 -0.102243,3.22071 -1.635914,4.95887 -1.258314,1.42609 -3.62969,1.99377 -6.288054,1.07357 -2.658364,-0.92021 -6.139514,-3.85065 -7.106009,-4.90775 -0.817958,-0.89464 -2.820665,-3.06173 -2.890231,-4.294021 -0.01209,-0.214205 -1.229505,-0.0963 -1.229505,-0.0963 l -0.0723,14.256941 5.879073,2.24938 c 0,0 5.214483,1.78929 8.946415,1.43143 3.731934,-0.35786 7.617235,-0.51122 11.604778,-5.16336 3.987542,-4.65213 3.680812,-12.831715 2.147141,-15.899056 -1.533673,-3.067344 -3.561212,-6.138812 -10.480087,-8.281826 -5.776829,-1.789283 -7.872846,-3.01622 -8.128458,-4.396524 -0.255611,-1.380305 0.0091,-4.253646 2.760607,-5.214481 3.220711,-1.124693 5.623462,-0.05112 7.05489,1.12469 1.431425,1.175817 5.572339,5.623462 5.572339,5.623462 z"
+       id="path46355"
+       sodipodi:nodetypes="cccssssscssssscccssssssscc" /></g></svg>

client-tauri/src-tauri/.gitignore

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

client-tauri/src-tauri/Cargo.toml

@@ -0,0 +1,23 @@
+[package]
+name = "StirlingPDF"
+version = "2.0.0" # needed for dev build?
+description = "Selfhosted PDF processing"
+authors = ["LaserKaspar, SaudF"]
+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

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

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

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

@@ -0,0 +1,78 @@
+{
+  "build": {
+    "beforeDevCommand": "npm run vite:dev",
+    "beforeBuildCommand": "make vite-build",
+    "devPath": "http://localhost:1420",
+    "distDir": "../dist",
+    "withGlobalTauri": false
+  },
+  "package": {
+    "productName": "StirlingPDF",
+    "version": "2.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
+      }
+    ]
+  }
+}

client-tauri/src/App.tsx

@@ -0,0 +1,82 @@
+import { Fragment, Suspense } from "react";
+
+import { Routes, Route, Outlet, Navigate } from "react-router-dom";
+import Home from "./pages/Home";
+import Operators from "./pages/Operators";
+import NoMatch from "./pages/NoMatch";
+import NavBar from "./components/NavBar";
+
+import { useTranslation, initReactI18next } from "react-i18next";
+import LanguageDetector from "i18next-browser-languagedetector";
+
+import i18next from "i18next";
+import resourcesToBackend from "i18next-resources-to-backend";
+import { listOperatorNames } from "@stirling-pdf/shared-operations/src/workflow/operatorAccessor";
+import AuthenticatedRoute from "./components/AuthenticatedRoute";
+import Login from "./pages/Auth/Login";
+import Logout from "./pages/Auth/Logout";
+import Register from "./pages/Auth/Register";
+
+i18next.use(LanguageDetector).use(initReactI18next).use(resourcesToBackend((language: string, namespace: string) => import(`@stirling-pdf/shared-operations/public/locales/${namespace}/${language}.json`).catch((e) => console.warn("some component tried to render with an unsupported language, falling back to en", e))))
+.init({
+    debug: false,
+    ns: ["common"], // Preload this namespace, no need to add the others, they will load once their module is loaded
+    defaultNS: "common",
+    fallbackLng: "en",
+    interpolation: {
+        escapeValue: false,
+    },
+    initImmediate: false // Makes loading blocking but sync
+}); // TODO: use i18next.config.ts instead
+
+export default function App() {
+    return (
+        <Suspense fallback={<Loading/>}>
+            {/* Routes nest inside one another. Nested route paths build upon
+            parent route paths, and nested route elements render inside
+            parent route elements. See the note about <Outlet> below. */}
+            <Routes>
+                <Route path="/auth" element={<Layout />}>
+                    <Route index element={<Navigate to="/auth/login" />}/>
+                    <Route path="login" element={<Login />}></Route>
+                    <Route path="logout" element={<Logout />}></Route>
+                    <Route path="register" element={<Register />}></Route>
+                    <Route path="*" element={<NoMatch />} />
+                </Route>
+
+                <Route element={<AuthenticatedRoute />}>
+                    <Route path="/" element={<Layout />}>
+                        <Route index element={<Home />} />
+                        <Route path="*" element={<NoMatch />} />
+                    </Route>
+
+                    <Route path="/operators" element={<Layout />}>
+                        <Route index element={<NoMatch />} />
+                        {listOperatorNames().map((name) => {
+                            return <Route key={name} path={name} element={<Operators/>} />;
+                        })}
+                        <Route path="*" element={<NoMatch />} />
+                    </Route>
+                </Route>
+            </Routes>
+        </Suspense>
+    );
+}
+
+function Loading() {
+    return "Loading";
+}
+
+function Layout() {
+    const { t } = useTranslation();
+    return (
+        <div lang-direction={t("language.direction")}>
+            <NavBar/>
+
+            {/* An <Outlet> renders whatever child route is currently active,
+          so you can think about this <Outlet> as a placeholder for
+          the child routes we defined above. */}
+            <Outlet/>
+        </div>
+    );
+}

client-tauri/src/assets/favicon.svg

@@ -0,0 +1,110 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!-- Generator: Adobe Illustrator 19.0.0, SVG Export Plug-In . SVG Version: 6.00 Build 0)  -->
+
+<svg
+   version="1.1"
+   id="Layer_1"
+   x="0px"
+   y="0px"
+   viewBox="0 0 512 512"
+   style="enable-background:new 0 0 512 512;"
+   xml:space="preserve"
+   sodipodi:docname="favicon.svg"
+   inkscape:version="1.2.2 (732a01da63, 2022-12-09)"
+   inkscape:export-filename="favicon.png"
+   inkscape:export-xdpi="96"
+   inkscape:export-ydpi="96"
+   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+   xmlns="http://www.w3.org/2000/svg"
+   xmlns:svg="http://www.w3.org/2000/svg"><defs
+   id="defs173">
+
+
+		<linearGradient
+   id="XMLID_5_"
+   gradientUnits="userSpaceOnUse"
+   x1="304.496"
+   y1="422.9102"
+   x2="316.036"
+   y2="326.2626">
+			<stop
+   offset="0"
+   style="stop-color:#DCF1F3"
+   id="stop156" />
+			<stop
+   offset="1"
+   style="stop-color:#C2C2C9"
+   id="stop158" />
+		</linearGradient>
+
+	</defs><sodipodi:namedview
+   id="namedview171"
+   pagecolor="#ffffff"
+   bordercolor="#000000"
+   borderopacity="0.25"
+   inkscape:showpageshadow="2"
+   inkscape:pageopacity="0.0"
+   inkscape:pagecheckerboard="0"
+   inkscape:deskcolor="#d1d1d1"
+   showgrid="false"
+   inkscape:zoom="1.4142136"
+   inkscape:cx="219.91021"
+   inkscape:cy="232.63813"
+   inkscape:window-width="3840"
+   inkscape:window-height="2054"
+   inkscape:window-x="2869"
+   inkscape:window-y="-11"
+   inkscape:window-maximized="1"
+   inkscape:current-layer="XMLID_4_" />
+<style
+   type="text/css"
+   id="style150">
+	.st0{fill:#FFFFFF;}
+	.st1{fill:#C02223;}
+	.st2{fill:#882425;}
+	.st3{fill:url(#XMLID_5_);}
+	.st4{fill:url(#XMLID_7_);}
+</style>
+
+<g
+   id="XMLID_4_">
+	<path
+   id="XMLID_131_"
+   class="st1"
+   d="M 347.01402,14.355825 98.978019,69.02261 C 73.825483,74.547445 55.942464,96.792175 55.942464,122.52628 v 315.06096 c 0,22.39012 16.719895,41.14548 38.819234,43.76251 L 224.8861,498.36042 339.48636,384.26465 455.76603,265.15425 453.73057,84.870162 C 453.43979,62.916214 433.08513,46.632491 411.71274,51.284984 l -28.78729,6.251786 0.14539,-13.666697 C 383.36162,24.678542 365.62399,10.284894 347.01402,14.355825 Z"
+   sodipodi:nodetypes="ccssccccccccc"
+   style="stroke-width:1.45391" /><path
+   id="XMLID_117_"
+   class="st2"
+   d="m 383.21622,57.53677 v 285.8375 L 456.05681,265.00885 454.02135,78.763767 C 453.87595,59.863016 436.28372,45.905539 417.81914,49.97647 Z"
+   style="stroke-width:1.45391" /><polygon
+   id="XMLID_18_"
+   class="st3"
+   points="234.7,422.6 368.5,387.7 393.5,262.2 "
+   style="fill:url(#XMLID_5_)"
+   transform="matrix(1.4556308,0,0,1.4548265,-116.73161,-116.45231)" />
+	<linearGradient
+   id="XMLID_7_"
+   gradientUnits="userSpaceOnUse"
+   x1="223.0838"
+   y1="372.7559"
+   x2="241.4174"
+   y2="114.557"
+   gradientTransform="matrix(1.4539039,0,0,1.4539039,-116.19976,-116.20474)">
+		<stop
+   offset="0"
+   style="stop-color:#DCF1F3"
+   id="stop163" />
+		<stop
+   offset="1"
+   style="stop-color:#C2C2C9"
+   id="stop165" />
+	</linearGradient>
+	<path
+   id="XMLID_6_"
+   class="st4"
+   d="m 282.89686,214.84917 c 0,0 -22.24473,-28.93269 -38.67384,-36.78377 -10.46811,-4.94327 -26.02489,-6.83335 -38.23768,-0.72695 -18.02841,9.0142 -19.91848,34.31213 -3.34397,44.34406 3.92553,2.47165 9.15959,4.50711 15.99294,6.10641 36.63838,8.43264 97.12077,25.87949 89.70587,96.10304 0,0 -4.21633,65.86185 -73.56753,73.42215 -12.2128,1.30851 -24.57098,0.43617 -36.493,-2.32625 -16.42911,-3.63476 -45.50719,-11.04967 -59.75545,-19.91849 l -2.61703,-75.16682 h 6.97875 c 0,0 13.81208,33.43978 53.06749,49.57812 7.26952,2.90781 15.26599,4.07093 22.97168,2.90781 9.74116,-1.45391 21.22699,-6.68796 25.87949,-22.53551 0,0 7.85108,-23.11707 -32.85823,-35.76604 -32.56744,-10.17733 -63.24481,-20.64543 -75.89378,-54.95757 -5.961,-16.28371 -6.97874,-34.31212 -2.90781,-51.61358 5.37944,-22.53551 20.79082,-54.23062 64.40794,-67.89732 0,0 57.28381,-15.55677 96.53922,5.52484 l -1.74468,89.70587 z"
+   style="fill:url(#XMLID_7_);stroke-width:1.45391" />
+</g>
+</svg>

client-tauri/src/assets/react.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" class="iconify iconify--logos" width="35.93" height="32" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 228"><path fill="#00D8FF" d="M210.483 73.824a171.49 171.49 0 0 0-8.24-2.597c.465-1.9.893-3.777 1.273-5.621c6.238-30.281 2.16-54.676-11.769-62.708c-13.355-7.7-35.196.329-57.254 19.526a171.23 171.23 0 0 0-6.375 5.848a155.866 155.866 0 0 0-4.241-3.917C100.759 3.829 77.587-4.822 63.673 3.233C50.33 10.957 46.379 33.89 51.995 62.588a170.974 170.974 0 0 0 1.892 8.48c-3.28.932-6.445 1.924-9.474 2.98C17.309 83.498 0 98.307 0 113.668c0 15.865 18.582 31.778 46.812 41.427a145.52 145.52 0 0 0 6.921 2.165a167.467 167.467 0 0 0-2.01 9.138c-5.354 28.2-1.173 50.591 12.134 58.266c13.744 7.926 36.812-.22 59.273-19.855a145.567 145.567 0 0 0 5.342-4.923a168.064 168.064 0 0 0 6.92 6.314c21.758 18.722 43.246 26.282 56.54 18.586c13.731-7.949 18.194-32.003 12.4-61.268a145.016 145.016 0 0 0-1.535-6.842c1.62-.48 3.21-.974 4.76-1.488c29.348-9.723 48.443-25.443 48.443-41.52c0-15.417-17.868-30.326-45.517-39.844Zm-6.365 70.984c-1.4.463-2.836.91-4.3 1.345c-3.24-10.257-7.612-21.163-12.963-32.432c5.106-11 9.31-21.767 12.459-31.957c2.619.758 5.16 1.557 7.61 2.4c23.69 8.156 38.14 20.213 38.14 29.504c0 9.896-15.606 22.743-40.946 31.14Zm-10.514 20.834c2.562 12.94 2.927 24.64 1.23 33.787c-1.524 8.219-4.59 13.698-8.382 15.893c-8.067 4.67-25.32-1.4-43.927-17.412a156.726 156.726 0 0 1-6.437-5.87c7.214-7.889 14.423-17.06 21.459-27.246c12.376-1.098 24.068-2.894 34.671-5.345a134.17 134.17 0 0 1 1.386 6.193ZM87.276 214.515c-7.882 2.783-14.16 2.863-17.955.675c-8.075-4.657-11.432-22.636-6.853-46.752a156.923 156.923 0 0 1 1.869-8.499c10.486 2.32 22.093 3.988 34.498 4.994c7.084 9.967 14.501 19.128 21.976 27.15a134.668 134.668 0 0 1-4.877 4.492c-9.933 8.682-19.886 14.842-28.658 17.94ZM50.35 144.747c-12.483-4.267-22.792-9.812-29.858-15.863c-6.35-5.437-9.555-10.836-9.555-15.216c0-9.322 13.897-21.212 37.076-29.293c2.813-.98 5.757-1.905 8.812-2.773c3.204 10.42 7.406 21.315 12.477 32.332c-5.137 11.18-9.399 22.249-12.634 32.792a134.718 134.718 0 0 1-6.318-1.979Zm12.378-84.26c-4.811-24.587-1.616-43.134 6.425-47.789c8.564-4.958 27.502 2.111 47.463 19.835a144.318 144.318 0 0 1 3.841 3.545c-7.438 7.987-14.787 17.08-21.808 26.988c-12.04 1.116-23.565 2.908-34.161 5.309a160.342 160.342 0 0 1-1.76-7.887Zm110.427 27.268a347.8 347.8 0 0 0-7.785-12.803c8.168 1.033 15.994 2.404 23.343 4.08c-2.206 7.072-4.956 14.465-8.193 22.045a381.151 381.151 0 0 0-7.365-13.322Zm-45.032-43.861c5.044 5.465 10.096 11.566 15.065 18.186a322.04 322.04 0 0 0-30.257-.006c4.974-6.559 10.069-12.652 15.192-18.18ZM82.802 87.83a323.167 323.167 0 0 0-7.227 13.238c-3.184-7.553-5.909-14.98-8.134-22.152c7.304-1.634 15.093-2.97 23.209-3.984a321.524 321.524 0 0 0-7.848 12.897Zm8.081 65.352c-8.385-.936-16.291-2.203-23.593-3.793c2.26-7.3 5.045-14.885 8.298-22.6a321.187 321.187 0 0 0 7.257 13.246c2.594 4.48 5.28 8.868 8.038 13.147Zm37.542 31.03c-5.184-5.592-10.354-11.779-15.403-18.433c4.902.192 9.899.29 14.978.29c5.218 0 10.376-.117 15.453-.343c-4.985 6.774-10.018 12.97-15.028 18.486Zm52.198-57.817c3.422 7.8 6.306 15.345 8.596 22.52c-7.422 1.694-15.436 3.058-23.88 4.071a382.417 382.417 0 0 0 7.859-13.026a347.403 347.403 0 0 0 7.425-13.565Zm-16.898 8.101a358.557 358.557 0 0 1-12.281 19.815a329.4 329.4 0 0 1-23.444.823c-7.967 0-15.716-.248-23.178-.732a310.202 310.202 0 0 1-12.513-19.846h.001a307.41 307.41 0 0 1-10.923-20.627a310.278 310.278 0 0 1 10.89-20.637l-.001.001a307.318 307.318 0 0 1 12.413-19.761c7.613-.576 15.42-.876 23.31-.876H128c7.926 0 15.743.303 23.354.883a329.357 329.357 0 0 1 12.335 19.695a358.489 358.489 0 0 1 11.036 20.54a329.472 329.472 0 0 1-11 20.722Zm22.56-122.124c8.572 4.944 11.906 24.881 6.52 51.026c-.344 1.668-.73 3.367-1.15 5.09c-10.622-2.452-22.155-4.275-34.23-5.408c-7.034-10.017-14.323-19.124-21.64-27.008a160.789 160.789 0 0 1 5.888-5.4c18.9-16.447 36.564-22.941 44.612-18.3ZM128 90.808c12.625 0 22.86 10.235 22.86 22.86s-10.235 22.86-22.86 22.86s-22.86-10.235-22.86-22.86s10.235-22.86 22.86-22.86Z"></path></svg>

client-tauri/src/components/AuthenticatedRoute.tsx

@@ -0,0 +1,22 @@
+import { ReactNode } from "react";
+import { Navigate, Outlet } from "react-router-dom";
+
+interface AuthenticatedRouteProps {
+    isAuthenticated: boolean;
+    children?: ReactNode;  // Accepting children
+}
+
+
+function isAuthenticated() {
+    if (import.meta.env.VITE_USE_AUTH == "True") {
+        // TODO: if user is set in localstorage and is valid (either by time or by checking online) return true
+        return false;
+    }
+    return true;
+}
+
+function AuthenticatedRoute({}: {}): JSX.Element {
+    return isAuthenticated() ? <Outlet /> : <Navigate to="/auth/login" />;
+};
+
+export default AuthenticatedRoute;

client-tauri/src/components/BuildForm.module.css

@@ -0,0 +1,22 @@
+.fields {
+    margin: 20px 0;
+}
+
+.fields input, select {
+    width: 100%;
+    padding: 12px 20px;
+    margin: 8px 0;
+    display: inline-block;
+    border: 1px solid #ccc;
+    border-radius: 4px;
+    box-sizing: border-box;
+}
+
+.submit {
+    background-color: var(--md-sys-color-primary);;
+    border: none;
+    color: white;
+    padding: 16px 32px;
+    text-decoration: none;
+    cursor: pointer;
+}

client-tauri/src/components/BuildForm.tsx

@@ -0,0 +1,28 @@
+import Joi from "@stirling-tools/joi";
+import { GenericField } from "./fields/GenericField";
+import React from "react";
+
+import styles from "./BuildForm.module.css";
+
+interface BuildFormProps {
+    /** The text to display inside the button */
+    schemaDescription: Joi.Description | undefined;
+    onSubmit: React.FormEventHandler<HTMLFormElement>;
+}
+
+export function BuildForm({ schemaDescription, onSubmit }: BuildFormProps) {
+    console.log("Render Build Fields", schemaDescription);
+    const values = (schemaDescription?.keys as any)?.values.keys as { [key: string]: Joi.Description};
+    return (
+        <form onSubmit={(e) => { onSubmit(e); e.preventDefault(); }}>
+            <div className={styles.fields}>
+            {
+                values ? Object.keys(values).map((key) => {  
+                    return (<GenericField key={key} fieldName={key} joiDefinition={values[key]} />) 
+                }) : undefined
+            }
+            </div>
+            <input className={styles.submit} type="submit" value="Submit" />
+        </form>
+    );
+}

client-tauri/src/components/NavBar.module.css

@@ -0,0 +1,19 @@
+.navbar_brand {
+    color: var(--md-sys-color-on-surface) !important;
+}
+
+.main_icon {
+    width: 36px;
+    height: 42px;
+    vertical-align: middle;
+    transform: translateY(-2px);
+}
+
+.icon_text {
+    margin-left: 8px;
+    margin-right: 4px;
+    display: inline-flex;
+    flex-direction: column;
+    justify-content: space-between;
+    vertical-align: middle;
+}

client-tauri/src/components/NavBar.tsx

@@ -0,0 +1,15 @@
+import StirlingLogo from "../assets/favicon.svg";
+import NavBarStyles from "./NavBar.module.css";
+
+function NavBar() {
+    return (
+        <nav>
+            <a className={NavBarStyles.navbar_brand} href="/">
+                <img className={NavBarStyles.main_icon} src={StirlingLogo} alt="icon"/>
+                <span className={NavBarStyles.icon_text}>Stirling PDF</span>
+            </a>
+        </nav>
+    );
+}
+
+export default NavBar;

client-tauri/src/components/OperatorCard.module.css

@@ -0,0 +1,22 @@
+.operator_card {
+    border: 1px solid var(--md-sys-color-surface-5);
+    border-radius: 1.75rem;
+    padding: 1.25rem;
+    display: flex;
+    flex-direction: column;
+    align-items: flex-start;
+    background: var(--md-sys-color-surface-5);
+    transition: transform 0.3s, border 0.3s;
+    transform-origin: center center;
+    outline: 0px solid transparent;
+}
+
+.operator_card h3 {
+    margin-top: 0;
+}
+
+.operator_card:hover {
+    cursor: pointer;
+    transform: scale(1.08);
+    box-shadow: var(--md-sys-elevation-2);
+}

client-tauri/src/components/OperatorCard.tsx

@@ -0,0 +1,34 @@
+import { useEffect, useState } from 'react';
+
+import { getSchemaByName } from "@stirling-pdf/shared-operations/src/workflow/operatorAccessor";
+
+import styles from './OperatorCard.module.css';
+import { MaterialSymbol, MaterialSymbolProps } from 'react-material-symbols';
+
+interface OperatorCardProps {
+    /** The text to display inside the button */
+    operatorInternalName: string;
+}
+
+export function OperatorCard({ operatorInternalName }: OperatorCardProps) {
+    const [schema, setSchema] = useState<any>(undefined); // TODO: Type as joi type
+    const [materialSymbolName, setMaterialSymbolName] = useState<MaterialSymbolProps["icon"]>("error");
+
+    useEffect(() => {
+        getSchemaByName(operatorInternalName).then(schema => {
+            if(schema) {
+                setSchema(schema.schema);
+                setMaterialSymbolName(schema.materialSymbolName || "error");
+            }
+        });
+    }, [operatorInternalName]);
+
+    return (
+        <a key={operatorInternalName} href={"/operators/" + operatorInternalName}>
+            <div className={styles.operator_card}>
+                <h3><MaterialSymbol icon={materialSymbolName} size={30} fill grade={-25} color='black'></MaterialSymbol> { schema?.describe().flags.label }</h3>
+                { schema?.describe().flags.description }
+            </div>
+        </a>
+    );
+}