Update build.gradle

📝 Sync README
> Made via sync_files.yml

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

.github/FUNDING.yml

@@ -1,13 +0,0 @@
-# These are supported funding model platforms
-
-github: Frooodle # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
-patreon: # Replace with a single Patreon username
-open_collective: # Replace with a single Open Collective username
-ko_fi: # Replace with a single Ko-fi username
-tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
-community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
-liberapay: # Replace with a single Liberapay username
-issuehunt: # Replace with a single IssueHunt username
-otechie: # Replace with a single Otechie username
-lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
-custom: ['https://www.paypal.com/donate/?hosted_button_id=MN7JPG5G6G3JL'] # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

.github/ISSUE_TEMPLATE/1-bug.yml

@@ -22,8 +22,6 @@ body:
         - Docker ultra lite
         - Docker fat
         - Local Installation
-      validations:
-        required: true
 
   - type: textarea
     id: problem

.github/labeler-config.yml

@@ -16,21 +16,27 @@ 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/java/stirling/software/SPDF/config/**/*'
+    - any-glob-to-any-file: 'src/main/java/stirling/software/SPDF/controller/**/*'
     - any-glob-to-any-file: 'src/main/resources/settings.yml.template'
+    - any-glob-to-any-file: 'src/main/resources/application.properties'
     - any-glob-to-any-file: 'src/main/resources/banner.txt'
+    - any-glob-to-any-file: 'scripts/png_to_webp.py'
+    - any-glob-to-any-file: 'split_photos.py'
 
 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'
+    - any-glob-to-any-file: 'src/main/java/stirling/software/SPDF/model/provider/**/*'
+    - any-glob-to-any-file: 'src/main/java/stirling/software/SPDF/model/AuthenticationType.java'
+    - any-glob-to-any-file: 'scripts/download-security-jar.sh'
 
 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/**/*'
+    - any-glob-to-any-file: 'scripts/png_to_webp.py'
+    - any-glob-to-any-file: 'split_photos.py'
 
 Documentation:
   - changed-files:
@@ -43,6 +49,9 @@ Docker:
     - any-glob-to-any-file: 'Dockerfile'
     - any-glob-to-any-file: 'Dockerfile-*'
     - any-glob-to-any-file: 'exampleYmlFiles/*.yml'
+    - any-glob-to-any-file: 'scripts/init.sh'
+    - any-glob-to-any-file: 'scripts/init-without-ocr.sh'
+    - any-glob-to-any-file: 'scripts/installFonts.sh'
 
 Test:
   - changed-files:

.github/labels.yml

@@ -3,9 +3,12 @@
 #
 # The repository labels will be automatically configured using this file and
 # the GitHub Action https://github.com/marketplace/actions/github-labeler.
+- name: "Licenses"
+  color: "EDEDED"
+  from_name: "licenses"
 - name: "Back End"
   color: "20CE6C"
-  description: "Issues related to back-end development"
+  description: "Issues or pull requests related to back-end development"
   from_name: "Back end"
 - name: "Bug"
   description: "Something isn't working"
@@ -24,6 +27,7 @@
   from_name: "documentation"
 - name: "Done for next release"
   color: "0CDBD1"
+  description: "Items that are completed and will be included in the next release"
 - name: "Done"
   color: "60F13B"
 - name: "duplicate"
@@ -37,7 +41,7 @@
   description: "Fix needs to be confirmed"
 - name: "Front End"
   color: "BBD2F1"
-  description: "Issues related to front-end development"
+  description: "Issues or pull requests related to front-end development"
 - name: "github-actions"
   description: "Pull requests that update GitHub Actions code"
   color: "999999"
@@ -91,3 +95,16 @@
   description: "Testing-related issues or pull requests"
 - name: "Stale"
   color: "000000"
+  description: "Issues or pull requests that have become inactive"
+- name: "Priority: Critical"
+  color: "000000"
+  description: "Issues or pull requests with the highest priority"
+- name: "Priority: High"
+  color: "FF0000"
+  description: "Issues or pull requests with high priority"
+- name: "Priority: Medium"
+  color: "FFFF00"
+  description: "Issues or pull requests with medium priority"
+- name: "Priority: Low"
+  color: "00FF00"
+  description: "Issues or pull requests with low priority"

.github/pull_request_template.md

@@ -4,9 +4,12 @@ Please provide a summary of the changes, including relevant motivation and conte
 
 Closes #(issue_number)
 
-## Checklist:
+## 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 attached images of the change if it is UI based
 - [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] If my code has heavily changed functionality I have updated relevant docs on [Stirling-PDFs doc repo](https://github.com/Stirling-Tools/Stirling-Tools.github.io/blob/main/docs/)
 - [ ] 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/scripts/check_language_properties.py

@@ -0,0 +1,303 @@
+"""
+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 check_language_properties.py --reference-file <path_to_reference_file> --branch <branch_name> [--actor <actor_name>] [--files <list_of_changed_files>]
+"""
+
+import copy
+import glob
+import os
+import argparse
+import re
+
+
+# Maximum size for properties files (e.g., 200 KB)
+MAX_FILE_SIZE = 200 * 1024
+
+
+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(os.path.join(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(os.path.join(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(os.path.join(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):
+    if os.path.isfile(file_path) and os.path.exists(file_path):
+        with open(file_path, "r", encoding="utf-8") as file:
+            return file.read().splitlines()
+    return [""]
+
+
+def check_for_differences(reference_file, file_list, branch, actor):
+    reference_branch = reference_file.split("/")[0]
+    basename_reference_file = os.path.basename(reference_file)
+
+    report = []
+    report.append(f"#### 🔄 Reference Branch: `{reference_branch}`")
+    reference_lines = read_properties(reference_file)
+    has_differences = False
+
+    only_reference_file = True
+
+    file_arr = file_list
+
+    if len(file_list) == 1:
+        file_arr = file_list[0].split()
+    base_dir = os.path.abspath(os.path.join(os.getcwd(), "src", "main", "resources"))
+
+    for file_path in file_arr:
+        absolute_path = os.path.abspath(file_path)
+        # Verify that file is within the expected directory
+        if not absolute_path.startswith(base_dir):
+            raise ValueError(f"Unsafe file found: {file_path}")
+        # Verify file size before processing
+        if os.path.getsize(os.path.join(branch, file_path)) > MAX_FILE_SIZE:
+            raise ValueError(
+                f"The file {file_path} is too large and could pose a security risk."
+            )
+
+        basename_current_file = os.path.basename(os.path.join(branch, file_path))
+        if (
+            basename_current_file == basename_reference_file
+            or not file_path.startswith(
+                os.path.join("src", "main", "resources", "messages_")
+            )
+            or not file_path.endswith(".properties")
+            or not basename_current_file.startswith("messages_")
+        ):
+            continue
+        only_reference_file = False
+        report.append(f"#### 📃 **File Check:** `{basename_current_file}`")
+        current_lines = read_properties(os.path.join(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("1. **Test Status:** ❌ **_Failed_**")
+            report.append("  - **Issue:**")
+            has_differences = True
+            if reference_line_count > current_line_count:
+                report.append(
+                    f"    - **_Mismatched line count_**: {reference_line_count} (reference) vs {current_line_count} (current). Comments, empty lines, or translation strings are missing."
+                )
+            elif reference_line_count < current_line_count:
+                report.append(
+                    f"    - **_Too many lines_**: {reference_line_count} (reference) vs {current_line_count} (current). Please verify if there is an additional line that needs to be removed."
+                )
+        else:
+            report.append("1. **Test 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("2. **Test Status:** ❌ **_Failed_**")
+            report.append("  - **Issue:**")
+            if missing_keys_list:
+                spaces_keys_list = []
+                for key in missing_keys_list:
+                    if " " in key:
+                        spaces_keys_list.append(key)
+                if spaces_keys_list:
+                    spaces_keys_str = "`, `".join(spaces_keys_list)
+                    report.append(
+                        f"    - **_Keys containing unnecessary spaces_**: `{spaces_keys_str}`!"
+                    )
+                report.append(
+                    f"    - **_Extra keys in `{basename_current_file}`_**: `{missing_keys_str}` that are not present in **_`{basename_reference_file}`_**."
+                )
+            if extra_keys_list:
+                report.append(
+                    f"    - **_Missing keys in `{basename_reference_file}`_**: `{extra_keys_str}` that are not present in **_`{basename_current_file}`_**."
+                )
+        else:
+            report.append("2. **Test Status:** ✅ **_Passed_**")
+        report.append("")
+        report.append("---")
+        report.append("")
+    if has_differences:
+        report.append("## ❌ Overall Check Status: **_Failed_**")
+        report.append("")
+        report.append(
+            f"@{actor} please check your translation if it conforms to the standard. Follow the format of [messages_en_GB.properties](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/src/main/resources/messages_en_GB.properties)"
+        )
+    else:
+        report.append("## ✅ Overall Check Status: **_Success_**")
+        report.append("")
+        report.append(
+            f"Thanks @{actor} for your help in keeping the translations up to date."
+        )
+
+    if not only_reference_file:
+        print("\n".join(report))
+
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser(description="Find missing keys")
+    parser.add_argument(
+        "--actor",
+        required=False,
+        help="Actor from PR.",
+    )
+    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()
+
+    # Sanitize --actor input to avoid injection attacks
+    if args.actor:
+        args.actor = re.sub(r"[^a-zA-Z0-9_\\-]", "", args.actor)
+
+    # Sanitize --branch input to avoid injection attacks
+    if args.branch:
+        args.branch = re.sub(r"[^a-zA-Z0-9\\-]", "", args.branch)
+
+    file_list = args.files
+    if file_list is None:
+        file_list = glob.glob(
+            os.path.join(
+                os.getcwd(), "src", "main", "resources", "messages_*.properties"
+            )
+        )
+        update_missing_keys(args.reference_file, file_list)
+    else:
+        check_for_differences(args.reference_file, file_list, args.branch, args.actor)

.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/PR-Demo-Comment.yml

@@ -0,0 +1,179 @@
+name: PR Deployment via Comment
+
+on:
+  issue_comment:
+    types: [created]
+
+jobs:
+  check-comment:
+    runs-on: ubuntu-latest
+    if: |
+      github.event.issue.pull_request && 
+      (
+      contains(github.event.comment.body, 'prdeploy') ||
+      contains(github.event.comment.body, 'deploypr')
+      )
+      && 
+      (
+        github.event.comment.user.login == 'frooodle' || 
+        github.event.comment.user.login == 'sf298' ||
+        github.event.comment.user.login == 'Ludy87' ||
+        github.event.comment.user.login == 'LaserKaspar' ||
+        github.event.comment.user.login == 'sbplat' ||
+        github.event.comment.user.login == 'reecebrowne'
+      )
+    outputs:
+      pr_number: ${{ steps.get-pr.outputs.pr_number }}
+      pr_repository: ${{ steps.get-pr-info.outputs.repository }}
+      pr_ref: ${{ steps.get-pr-info.outputs.ref }}
+
+    steps:
+      - name: Get PR data
+        id: get-pr
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const prNumber = context.payload.issue.number;
+            console.log(`PR Number: ${prNumber}`);
+            core.setOutput('pr_number', prNumber);
+
+      - name: Get PR repository and ref
+        id: get-pr-info
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const { owner, repo } = context.repo;
+            const prNumber = context.payload.issue.number;
+            
+            const { data: pr } = await github.rest.pulls.get({
+              owner,
+              repo,
+              pull_number: prNumber,
+            });
+            
+            // For forks, use the full repository name, for internal PRs use the current repo
+            const repository = pr.head.repo.fork ? pr.head.repo.full_name : `${owner}/${repo}`;
+            
+            console.log(`PR Repository: ${repository}`);
+            console.log(`PR Branch: ${pr.head.ref}`);
+            
+            core.setOutput('repository', repository);
+            core.setOutput('ref', pr.head.ref);
+
+  deploy-pr:
+    needs: check-comment
+    runs-on: ubuntu-latest
+    
+    steps:
+      - name: Checkout PR
+        uses: actions/checkout@v4
+        with:
+          repository: ${{ needs.check-comment.outputs.pr_repository }}
+          ref: ${{ needs.check-comment.outputs.pr_ref }}
+          token: ${{ secrets.GITHUB_TOKEN }}
+      
+      - name: Set up JDK
+        uses: actions/setup-java@v4
+        with:
+          java-version: '17'
+          distribution: 'temurin'
+
+      - name: Run Gradle Command
+        run: ./gradlew clean build
+        env:
+          DOCKER_ENABLE_SECURITY: false
+
+      - name: Set up Docker 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: Build and push PR-specific image
+        uses: docker/build-push-action@v6
+        with:
+          context: .
+          file: ./Dockerfile
+          push: true
+          tags: ${{ secrets.DOCKER_HUB_USERNAME }}/test:pr-${{ needs.check-comment.outputs.pr_number }}
+          build-args: VERSION_TAG=${{ steps.versionNumber.outputs.versionNumber }}
+          platforms: linux/amd64
+
+      - name: Set up SSH
+        run: |
+          mkdir -p ~/.ssh/
+          echo "${{ secrets.VPS_SSH_KEY }}" > ../private.key
+          sudo chmod 600 ../private.key
+
+      - name: Deploy to VPS
+        run: |
+          # First create the docker-compose content locally
+          cat > docker-compose.yml << 'EOF'
+          version: '3.3'
+          services:
+            stirling-pdf:
+              container_name: stirling-pdf-pr-${{ needs.check-comment.outputs.pr_number }}
+              image: ${{ secrets.DOCKER_HUB_USERNAME }}/test:pr-${{ needs.check-comment.outputs.pr_number }}
+              ports:
+                - "${{ needs.check-comment.outputs.pr_number }}:8080"
+              volumes:
+                - /stirling/PR-${{ needs.check-comment.outputs.pr_number }}/data:/usr/share/tessdata:rw
+                - /stirling/PR-${{ needs.check-comment.outputs.pr_number }}/config:/configs:rw
+                - /stirling/PR-${{ needs.check-comment.outputs.pr_number }}/logs:/logs:rw
+              environment:
+                DOCKER_ENABLE_SECURITY: "false"
+                SECURITY_ENABLELOGIN: "false"
+                SYSTEM_DEFAULTLOCALE: en-GB
+                UI_APPNAME: "Stirling-PDF PR#${{ needs.check-comment.outputs.pr_number }}"
+                UI_HOMEDESCRIPTION: "PR#${{ needs.check-comment.outputs.pr_number }} for Stirling-PDF Latest"
+                UI_APPNAMENAVBAR: "PR#${{ needs.check-comment.outputs.pr_number }}"
+                SYSTEM_MAXFILESIZE: "100"
+                METRICS_ENABLED: "true"
+                SYSTEM_GOOGLEVISIBILITY: "false"
+              restart: on-failure:5
+          EOF
+
+          # Then copy the file and execute commands
+          scp -i ../private.key -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null docker-compose.yml ${{ secrets.VPS_USERNAME }}@${{ secrets.VPS_HOST }}:/tmp/docker-compose.yml
+
+          ssh -i ../private.key -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null -T ${{ secrets.VPS_USERNAME }}@${{ secrets.VPS_HOST }} << 'ENDSSH'
+            # Create PR-specific directories
+            mkdir -p /stirling/PR-${{ needs.check-comment.outputs.pr_number }}/{data,config,logs}
+            
+            # Move docker-compose file to correct location
+            mv /tmp/docker-compose.yml /stirling/PR-${{ needs.check-comment.outputs.pr_number }}/docker-compose.yml
+            
+            # Start or restart the container
+            cd /stirling/PR-${{ needs.check-comment.outputs.pr_number }}
+            docker-compose pull
+            docker-compose up -d
+          ENDSSH
+
+      - name: Post deployment URL to PR
+        if: success()
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const { GITHUB_REPOSITORY } = process.env;
+            const [repoOwner, repoName] = GITHUB_REPOSITORY.split('/');
+            const prNumber = ${{ needs.check-comment.outputs.pr_number }};
+
+            const deploymentUrl = `http://${{ secrets.VPS_HOST }}:${prNumber}`;
+            const commentBody = `## 🚀 PR Test Deployment\n\n` +
+                              `Your PR has been deployed for testing!\n\n` +
+                              `🔗 **Test URL:** [${deploymentUrl}](${deploymentUrl})\n\n` +
+                              `This deployment will be automatically cleaned up when the PR is closed.\n\n`;
+
+            await github.rest.issues.createComment({
+              owner: repoOwner,
+              repo: repoName,
+              issue_number: prNumber,
+              body: commentBody
+            });

.github/workflows/PR-Demo-cleanup.yml

@@ -0,0 +1,78 @@
+name: PR Deployment cleanup
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened, closed]
+
+permissions:
+  contents: write
+  pull-requests: write
+
+env:
+  SERVER_IP: ${{ secrets.VPS_IP }}  # Add this to your GitHub secrets
+  CLEANUP_PERFORMED: 'false'  # Add flag to track if cleanup occurred
+
+jobs:
+  cleanup:
+    runs-on: ubuntu-latest
+    if: github.event.action == 'closed'
+    
+    steps:
+      - name: Set up SSH
+        run: |
+          mkdir -p ~/.ssh/
+          echo "${{ secrets.VPS_SSH_KEY }}" > ../private.key
+          sudo chmod 600 ../private.key
+
+      - name: Cleanup PR deployment
+        id: cleanup
+        run: |
+          CLEANUP_STATUS=$(ssh -i ../private.key -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null -T ${{ secrets.VPS_USERNAME }}@${{ secrets.VPS_HOST }} << 'ENDSSH'
+            if [ -d "/stirling/PR-${{ github.event.pull_request.number }}" ]; then
+              echo "Found PR directory, proceeding with cleanup..."
+              
+              # Stop and remove containers
+              cd /stirling/PR-${{ github.event.pull_request.number }}
+              docker-compose down || true
+              
+              # Go back to root before removal
+              cd /
+              
+              # Remove PR-specific directories
+              rm -rf /stirling/PR-${{ github.event.pull_request.number }}
+              
+              # Remove the Docker image
+              docker rmi --no-prune ${{ secrets.DOCKER_HUB_USERNAME }}/test:pr-${{ github.event.pull_request.number }} || true
+              
+              echo "PERFORMED_CLEANUP"
+            else
+              echo "PR directory not found, nothing to clean up"
+              echo "NO_CLEANUP_NEEDED"
+            fi
+          ENDSSH
+          )
+          
+          if [[ $CLEANUP_STATUS == *"PERFORMED_CLEANUP"* ]]; then
+            echo "cleanup_performed=true" >> $GITHUB_OUTPUT
+          else
+            echo "cleanup_performed=false" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Post cleanup notice to PR
+        if: steps.cleanup.outputs.cleanup_performed == 'true'
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const { GITHUB_REPOSITORY } = process.env;
+            const [repoOwner, repoName] = GITHUB_REPOSITORY.split('/');
+            const prNumber = context.issue.number;
+
+            const commentBody = `## 🧹 Deployment Cleanup\n\n` +
+                              `The test deployment for this PR has been cleaned up.`;
+
+            await github.rest.issues.createComment({
+              owner: repoOwner,
+              repo: repoName,
+              issue_number: prNumber,
+              body: commentBody
+            });

.github/workflows/check_properties.yml

@@ -0,0 +1,213 @@
+name: Check Properties Files
+
+on:
+  pull_request_target:
+    types: [opened, synchronize, reopened]
+    paths:
+      - "src/main/resources/messages_*.properties"
+  push:
+    branches: ["main"]
+    paths:
+      - "src/main/resources/messages_en_GB.properties"
+
+jobs:
+  check-files:
+    if: github.event_name == 'pull_request_target'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout main branch first
+        uses: actions/checkout@v4
+        with:
+          ref: main
+          path: main-branch
+          fetch-depth: 0
+
+      - 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: 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 }}
+          # Store files in a safe way, only allowing valid properties files
+          echo "Getting list of changed files from PR..."
+          gh pr view ${{ github.event.pull_request.number }} --json files -q ".files[].path" | grep -E '^src/main/resources/messages_[a-zA-Z_]+\.properties$' > ../changed_files.txt
+          cd ..
+
+          echo "Processing changed files..."
+          mapfile -t CHANGED_FILES < changed_files.txt
+
+          CHANGED_FILES_STR="${CHANGED_FILES[*]}"
+          echo "CHANGED_FILES=${CHANGED_FILES_STR}" >> $GITHUB_ENV
+
+          echo "Changed files: ${CHANGED_FILES_STR}"
+
+      - name: Determine reference file
+        id: determine-file
+        run: |
+          echo "Determining reference file..."
+          if grep -Fxq "src/main/resources/messages_en_GB.properties" changed_files.txt; then
+              echo "Using PR branch reference file"
+              echo "REFERENCE_FILE=pr-branch/src/main/resources/messages_en_GB.properties" >> $GITHUB_ENV
+          else
+              echo "Using main branch reference file"
+              echo "REFERENCE_FILE=main-branch/src/main/resources/messages_en_GB.properties" >> $GITHUB_ENV
+          fi
+
+      - name: Show REFERENCE_FILE
+        run: echo "Reference file is set to ${REFERENCE_FILE}"
+
+      - name: Run Python script to check files
+        id: run-check
+        run: |
+          echo "Running Python script to check files..."
+          python main-branch/.github/scripts/check_language_properties.py \
+            --actor ${{ github.event.pull_request.user.login }} \
+            --reference-file "${REFERENCE_FILE}" \
+            --branch pr-branch \
+            --files "${CHANGED_FILES[@]}" > result.txt || true
+
+      - name: Capture output
+        id: capture-output
+        run: |
+          if [ -f result.txt ] && [ -s result.txt ]; then
+            echo "Test, capturing output..."
+            SCRIPT_OUTPUT=$(cat result.txt)
+            echo "SCRIPT_OUTPUT<<EOF" >> $GITHUB_ENV
+            echo "$SCRIPT_OUTPUT" >> $GITHUB_ENV
+            echo "EOF" >> $GITHUB_ENV
+            echo "${SCRIPT_OUTPUT}"
+
+            # Set FAIL_JOB to true if SCRIPT_OUTPUT contains ❌
+            if [[ "$SCRIPT_OUTPUT" == *"❌"* ]]; then
+              echo "FAIL_JOB=true" >> $GITHUB_ENV
+            else
+              echo "FAIL_JOB=false" >> $GITHUB_ENV
+            fi
+          else
+            echo "No update found."
+            echo "SCRIPT_OUTPUT=" >> $GITHUB_ENV
+            echo "FAIL_JOB=false" >> $GITHUB_ENV
+          fi
+
+      - name: Post comment on PR
+        if: env.SCRIPT_OUTPUT != ''
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const { GITHUB_REPOSITORY, SCRIPT_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${SCRIPT_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${SCRIPT_OUTPUT}\n`
+              });
+              console.log("Created new comment.");
+            } else {
+              console.log("Comment update attempt denied. Actor does not match.");
+            }
+
+      - name: Fail job if errors found
+        if: env.FAIL_JOB == 'true'
+        run: |
+          echo "Failing the job because errors were detected."
+          exit 1
+
+  update-translations-main:
+    if: github.event_name == 'push'
+    permissions:
+      contents: write
+      pull-requests: write
+    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: |
+          echo "Running Python script to check files..."
+          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@v7
+        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"
+          add-paths: |
+            src/main/resources/messages_*.properties
+          body: |
+            Auto-generated by [create-pull-request][1]
+
+            [1]: https://github.com/peter-evans/create-pull-request
+          labels: Translation
+          draft: false
+          delete-branch: true
+          sign-commits: true

.github/workflows/licenses-update.yml

@@ -36,8 +36,8 @@ jobs:
 
       - name: Set up git config
         run: |
-          git config --global user.email "GitHub Action <action@github.com>"
-          git config --global user.name "GitHub Action <action@github.com>"
+          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: |
@@ -76,4 +76,4 @@ jobs:
         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
+          merge-method: squash # Choose the merge method: merge, squash, or rebase

.github/workflows/push-docker.yml

@@ -10,6 +10,7 @@ on:
 permissions:
   contents: read
   packages: write
+
 jobs:
   push:
     runs-on: ubuntu-latest
@@ -66,6 +67,8 @@ jobs:
           images: |
             ${{ secrets.DOCKER_HUB_USERNAME }}/s-pdf
             ghcr.io/${{ steps.repoowner.outputs.lowercase }}/s-pdf
+            ghcr.io/${{ steps.repoowner.outputs.lowercase }}/stirling-pdf
+            ${{ secrets.DOCKER_HUB_ORG_USERNAME }}/stirling-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' }}
@@ -93,6 +96,8 @@ jobs:
           images: |
             ${{ secrets.DOCKER_HUB_USERNAME }}/s-pdf
             ghcr.io/${{ steps.repoowner.outputs.lowercase }}/s-pdf
+            ghcr.io/${{ steps.repoowner.outputs.lowercase }}/stirling-pdf
+            ${{ secrets.DOCKER_HUB_ORG_USERNAME }}/stirling-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' }}
@@ -119,6 +124,8 @@ jobs:
           images: |
             ${{ secrets.DOCKER_HUB_USERNAME }}/s-pdf
             ghcr.io/${{ steps.repoowner.outputs.lowercase }}/s-pdf
+            ghcr.io/${{ steps.repoowner.outputs.lowercase }}/stirling-pdf
+            ${{ secrets.DOCKER_HUB_ORG_USERNAME }}/stirling-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' }}

.github/workflows/sync_files.yml

@@ -14,44 +14,6 @@ permissions:
   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.email "GitHub Action <action@github.com>"
-          git config --global user.name "GitHub Action <action@github.com>"
-      - name: Run git add
-        run: |
-          git add .
-          git diff --staged --quiet || git commit -m ":floppy_disk: Sync Versions
-          > Made via sync_files.yml" || echo "no changes"
-      - name: Create Pull Request
-        uses: peter-evans/create-pull-request@v6
-        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:
@@ -66,8 +28,8 @@ jobs:
         run: python scripts/counter_translation.py
       - name: Set up git config
         run: |
-          git config --global user.email "GitHub Action <action@github.com>"
-          git config --global user.name "GitHub Action <action@github.com>"
+          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 .

.gitignore

@@ -4,6 +4,7 @@ bin/
 tmp/
 *.tmp
 *.bak
+*.exe
 *.swp
 *~.nib
 local.properties
@@ -110,7 +111,6 @@ watchedFolders/
 *.war
 *.nar
 *.ear
-*.zip
 *.tar.gz
 *.rar
 *.db

CONTRIBUTING.md

@@ -29,7 +29,7 @@ If you would like to add or modify a translation, please see [How to add new lan
 
 ## 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://stirlingtools.com/docs/](https://stirlingtools.com/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
 
@@ -41,4 +41,4 @@ If, at any point of time, you have a question, please feel free to ask in the sa
 
 ## License
 
-By contributing to this project, you agree that your contributions will be licensed under the [GPL 3 License](LICENSE). You also acknowledge and agree that your contributions will be included in Stirling-PDF and that they can be relicensed in the future under the MPL 2.0 (Mozilla Public License Version 2.0) license.
+By contributing to this project, you agree that your contributions will be licensed under the [MIT License](LICENSE).

DATABASE.md

@@ -1,6 +1,7 @@
 # New Database Backup and Import Functionality
 
-**Full activation will take place on approximately January 5th, 2025!**
+> [!IMPORTANT]
+> **Full activation will take place on approximately January 5th, 2025!**
 
 Why is the waiting time six months?
 

DeveloperGuide.md

@@ -0,0 +1,575 @@
+# 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
+- qpdf
+- 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:
+
+   ```bash
+   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
+
+```bash
+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: stirlingtools/stirling-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 stirlingtools/stirling-pdf:latest -f ./Dockerfile .
+   ```
+
+   For the ultra-lite version:
+
+   ```bash
+   docker build --no-cache --pull --build-arg VERSION_TAG=alpha -t stirlingtools/stirling-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 stirlingtools/stirling-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:
+
+   ```bash
+   ./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 qpdf, 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:
+
+```bash
+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_FR.properties`
+- `messages_de_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,5 +1,5 @@
 # Main stage
-FROM alpine:3.20.2
+FROM alpine:3.20.3
 
 # Copy necessary files
 COPY scripts /scripts
@@ -30,6 +30,7 @@ RUN echo "@testing https://dl-cdn.alpinelinux.org/alpine/edge/main" | tee -a /et
         tini \
         bash \
         curl \
+        qpdf \
         shadow \
         su-exec \
         openssl \
@@ -40,7 +41,6 @@ RUN echo "@testing https://dl-cdn.alpinelinux.org/alpine/edge/main" | tee -a /et
 # pdftohtml
         poppler-utils \
 # OCR MY PDF (unpaper for descew and other advanced features)
-        ocrmypdf \
         tesseract-ocr-data-eng \
 # CV
         py3-opencv \

Dockerfile-fat

@@ -1,5 +1,5 @@
 # Build the application
-FROM gradle:8.7-jdk17 AS build
+FROM gradle:8.11-jdk17 AS build
 
 # Set the working directory
 WORKDIR /app
@@ -12,7 +12,7 @@ RUN DOCKER_ENABLE_SECURITY=true \
 ./gradlew clean build
 
 # Main stage
-FROM alpine:3.20.2
+FROM alpine:3.20.3
 
 # Copy necessary files
 COPY scripts /scripts
@@ -55,7 +55,7 @@ RUN echo "@testing https://dl-cdn.alpinelinux.org/alpine/edge/main" | tee -a /et
 # pdftohtml
         poppler-utils \
 # OCR MY PDF (unpaper for descew and other advanced featues)
-        ocrmypdf \
+        qpdf \
         tesseract-ocr-data-eng \
         font-terminus font-dejavu font-noto font-noto-cjk font-awesome font-noto-extra \
 # CV

Dockerfile-ultra-lite

@@ -1,5 +1,5 @@
 # use alpine
-FROM alpine:3.20.2
+FROM alpine:3.20.3
 
 ARG VERSION_TAG
 
@@ -15,6 +15,7 @@ ENV DOCKER_ENABLE_SECURITY=false \
 # 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
 
@@ -33,11 +34,11 @@ RUN echo "@testing https://dl-cdn.alpinelinux.org/alpine/edge/main" | tee -a /et
         su-exec \
         openjdk21-jre && \
     # User permissions
-    mkdir /configs /logs /customFiles && \
+    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    
+    chown stirlingpdfuser:stirlingpdfgroup /app.jar
 
 # Set environment variables
 ENV ENDPOINTS_GROUPS_TO_REMOVE=CLI

Endpoint-groups.md

@@ -1,47 +1,46 @@
-| Operation           | PageOps | Convert | Security | Other | CLI | Python | OpenCV | LibreOffice | OCRmyPDF | Java | Javascript |
-| ------------------- | ------- | ------- | -------- | ----- | --- | ------ | ------ | ----------- | -------- | ---- | ---------- |
-| adjust-contrast     | ✔️       |         |          |       |     |        |        |             |          |      | ✔️          |
-| auto-split-pdf      | ✔️       |         |          |       |     |        |        |             |          | ✔️    |            |
-| crop                | ✔️       |         |          |       |     |        |        |             |          | ✔️    |            |
-| extract-page        | ✔️       |         |          |       |     |        |        |             |          | ✔️    |            |
-| merge-pdfs          | ✔️       |         |          |       |     |        |        |             |          | ✔️    |            |
-| multi-page-layout   | ✔️       |         |          |       |     |        |        |             |          | ✔️    |            |
-| pdf-organizer       | ✔️       |         |          |       |     |        |        |             |          | ✔️    | ✔️          |
-| pdf-to-single-page  | ✔️       |         |          |       |     |        |        |             |          | ✔️    |            |
-| remove-pages        | ✔️       |         |          |       |     |        |        |             |          | ✔️    |            |
-| rotate-pdf          | ✔️       |         |          |       |     |        |        |             |          | ✔️    |            |
-| scale-pages         | ✔️       |         |          |       |     |        |        |             |          | ✔️    |            |
-| split-pdfs          | ✔️       |         |          |       |     |        |        |             |          | ✔️    |            |
-| file-to-pdf         |         | ✔️       |          |       | ✔️   |        |        | ✔️           |          |      |            |
-| img-to-pdf          |         | ✔️       |          |       |     |        |        |             |          | ✔️    |            |
-| pdf-to-html         |         | ✔️       |          |       | ✔️   |        |        | ✔️           |          |      |            |
-| pdf-to-img          |         | ✔️       |          |       |     | ✔️      |        |             |          | ✔️    |            |
-| pdf-to-pdfa         |         | ✔️       |          |       | ✔️   |        |        |             | ✔️        |      |            |
-| pdf-to-markdown     |         | ✔️       |          |       |     |        |        |             |          | ✔️    |            |
-| pdf-to-presentation |         | ✔️       |          |       | ✔️   |        |        | ✔️           |          |      |            |
-| pdf-to-text         |         | ✔️       |          |       | ✔️   |        |        | ✔️           |          |      |            |
-| pdf-to-word         |         | ✔️       |          |       | ✔️   |        |        | ✔️           |          |      |            |
-| pdf-to-xml          |         | ✔️       |          |       | ✔️   |        |        | ✔️           |          |      |            |
-| xlsx-to-pdf         |         | ✔️       |          |       | ✔️   |        |        | ✔️           |          |      |            |
-| add-password        |         |         | ✔️        |       |     |        |        |             |          | ✔️    |            |
-| add-watermark       |         |         | ✔️        |       |     |        |        |             |          | ✔️    |            |
-| cert-sign           |         |         | ✔️        |       |     |        |        |             |          | ✔️    |            |
-| 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                |         |         |          | ✔️     |     |        |        |             |          |      | ✔️          |
+| Operation           | PageOps | Convert | Security | Other | CLI | Python | OpenCV | LibreOffice | qpdf | Java | Javascript | Unoconv | tesseract |
+| ------------------- | ------- | ------- | -------- | ----- | --- | ------ | ------ | ----------- | -------- | ---- | ---------- | ------- | ----------- |
+| 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          |         | ✔️       |          |       | ✔️   |        |        | ✔️           |          |      |            |         |             |
+| 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 +1,41 @@
 ## User Guide for Local Directory Scanning and File Processing
 
-### Setting Up Watched Folders:
+### 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.
+- 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
+### 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). This can be made, configured, and downloaded from the Stirling-PDF Pipeline interface.
+
+### Automatic Scanning and Processing
 
-### 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.
+- When a directory with a valid JSON configuration file is found, it begins processing the files inside according to the configuration.
+
+### Processing Steps
 
-### 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.
+- 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 the next process.
+
+### Results and Output
 
-### 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:
+### 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:
+### 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:
+### 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,44 +1,47 @@
-<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 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
+Fork Stirling-PDF and create a new branch out of `main`.
 
-Then add reference to the language in the navbar by adding a new language entry to the dropdown
+Then add a 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
+- Edit the file: [languages.html](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/src/main/resources/templates/fragments/languages.html)
+- Add a flag SVG file to: [flags directory](https://github.com/Stirling-Tools/Stirling-PDF/tree/main/src/main/resources/static/images/flags)
 
+Any SVG flags are fine; most of the current ones were sourced from [here](https://flagicons.lipis.dev/). If your language isn't represented by a flag, choose a similar one, such as Saudi Arabia's flag for Arabic.
+
+For example, to add Polish, you would add:
 
-For example to add Polish you would add
 ```html
-<a class="dropdown-item lang_dropdown-item" href="" data-language-code="pl_PL">
+<a class="dropdown-item lang_dropdown-item" href="" data-bs-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
+The `data-bs-language-code` is the code used to reference the file in the next step.
 
-[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)
+### Add Language Property File
 
-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
+Start by copying the existing English property file:
 
+- [messages_en_GB.properties](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/src/main/resources/messages_en_GB.properties)
 
-Then simply translate all property entries within that file and make a PR into main for others to use!
+Copy and rename it to `messages_{your data-bs-language-code here}.properties`. In the Polish example, you would set the name to `messages_pl_PL.properties`.
 
-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)
+Then simply translate all property entries within that file and make a Pull Request (PR) into `main` for others to use!
+
+If you do not have a Java IDE, I am happy to verify that the changes work once you raise the PR (but I 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:
+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]
@@ -48,4 +51,12 @@ ignore = [
 ]
 ```
 
+## 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

@@ -3,34 +3,36 @@
 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)
+
+The paths have changed for the tessdata locations on new Docker images. Please use `/usr/share/tessdata` (Others should still work for backward 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!
+
+Stirling-PDF 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_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.
+Depending on your requirements, you can choose the appropriate language pack for your use case. By default, Stirling-PDF uses `tessdata_fast` for English, 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.
+**DO NOT REMOVE EXISTING `eng.traineddata`, IT'S REQUIRED.**
 
-#### Docker
+### Docker Setup
 
 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:
 
+#### Docker Compose
+
+Modify your `docker-compose.yml` file to include the following volume configuration:
 
 ```yaml
 services:
@@ -40,18 +42,17 @@ services:
       - /location/of/trainingData:/usr/share/tessdata
 ```
 
+#### Docker Run
+
+Add the following to your existing Docker run command:
 
-#### 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)
+### Non-Docker Setup
 
-Debian based systems, install languages with this command:
+For Debian-based systems, install languages with this command:
 
 ```bash
 sudo apt update &&\
@@ -65,7 +66,7 @@ apt search tesseract-ocr-
 dpkg-query -W tesseract-ocr- | sed 's/tesseract-ocr-//g'
 ```
 
-Fedora:
+For Fedora:
 
 ```bash
 # All languages
@@ -77,3 +78,22 @@ dnf search -C tesseract-langpack-
 # View installed languages:
 rpm -qa | grep tesseract-langpack | sed 's/tesseract-langpack-//g'
 ```
+
+For Windows:
+
+You must ensure tesseract is installed
+
+Additional languages must be downloaded manually:
+Download desired .traineddata files from tessdata or tessdata_fast
+Place them in the tessdata folder within your Tesseract installation directory
+(e.g., C:\Program Files\Tesseract-OCR\tessdata)
+
+Verify installation:
+``tesseract --list-langs``
+
+You must then edit your ``/configs/settings.yml`` and change the system.tessdataDir to match the directory containing lang files
+```
+system:
+ tessdataDir: C:/Program Files/Tesseract-OCR/tessdata # path to the directory containing the Tessdata files. This setting is relevant for Windows systems. For Windows users, this path should be adjusted to point to the appropriate directory where the Tessdata files are stored.
+```
+  

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,674 +1,21 @@
-                    GNU GENERAL PUBLIC LICENSE
-                       Version 3, 29 June 2007
-
- Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
- Everyone is permitted to copy and distribute verbatim copies
- of this license document, but changing it is not allowed.
-
-                            Preamble
-
-  The GNU General Public License is a free, copyleft license for
-software and other kinds of works.
-
-  The licenses for most software and other practical works are designed
-to take away your freedom to share and change the works.  By contrast,
-the GNU General Public License is intended to guarantee your freedom to
-share and change all versions of a program--to make sure it remains free
-software for all its users.  We, the Free Software Foundation, use the
-GNU General Public License for most of our software; it applies also to
-any other work released this way by its authors.  You can apply it to
-your programs, too.
-
-  When we speak of free software, we are referring to freedom, not
-price.  Our General Public Licenses are designed to make sure that you
-have the freedom to distribute copies of free software (and charge for
-them if you wish), that you receive source code or can get it if you
-want it, that you can change the software or use pieces of it in new
-free programs, and that you know you can do these things.
-
-  To protect your rights, we need to prevent others from denying you
-these rights or asking you to surrender the rights.  Therefore, you have
-certain responsibilities if you distribute copies of the software, or if
-you modify it: responsibilities to respect the freedom of others.
-
-  For example, if you distribute copies of such a program, whether
-gratis or for a fee, you must pass on to the recipients the same
-freedoms that you received.  You must make sure that they, too, receive
-or can get the source code.  And you must show them these terms so they
-know their rights.
-
-  Developers that use the GNU GPL protect your rights with two steps:
-(1) assert copyright on the software, and (2) offer you this License
-giving you legal permission to copy, distribute and/or modify it.
-
-  For the developers' and authors' protection, the GPL clearly explains
-that there is no warranty for this free software.  For both users' and
-authors' sake, the GPL requires that modified versions be marked as
-changed, so that their problems will not be attributed erroneously to
-authors of previous versions.
-
-  Some devices are designed to deny users access to install or run
-modified versions of the software inside them, although the manufacturer
-can do so.  This is fundamentally incompatible with the aim of
-protecting users' freedom to change the software.  The systematic
-pattern of such abuse occurs in the area of products for individuals to
-use, which is precisely where it is most unacceptable.  Therefore, we
-have designed this version of the GPL to prohibit the practice for those
-products.  If such problems arise substantially in other domains, we
-stand ready to extend this provision to those domains in future versions
-of the GPL, as needed to protect the freedom of users.
-
-  Finally, every program is threatened constantly by software patents.
-States should not allow patents to restrict development and use of
-software on general-purpose computers, but in those that do, we wish to
-avoid the special danger that patents applied to a free program could
-make it effectively proprietary.  To prevent this, the GPL assures that
-patents cannot be used to render the program non-free.
-
-  The precise terms and conditions for copying, distribution and
-modification follow.
-
-                       TERMS AND CONDITIONS
-
-  0. Definitions.
-
-  "This License" refers to version 3 of the GNU General Public License.
-
-  "Copyright" also means copyright-like laws that apply to other kinds of
-works, such as semiconductor masks.
-
-  "The Program" refers to any copyrightable work licensed under this
-License.  Each licensee is addressed as "you".  "Licensees" and
-"recipients" may be individuals or organizations.
-
-  To "modify" a work means to copy from or adapt all or part of the work
-in a fashion requiring copyright permission, other than the making of an
-exact copy.  The resulting work is called a "modified version" of the
-earlier work or a work "based on" the earlier work.
-
-  A "covered work" means either the unmodified Program or a work based
-on the Program.
-
-  To "propagate" a work means to do anything with it that, without
-permission, would make you directly or secondarily liable for
-infringement under applicable copyright law, except executing it on a
-computer or modifying a private copy.  Propagation includes copying,
-distribution (with or without modification), making available to the
-public, and in some countries other activities as well.
-
-  To "convey" a work means any kind of propagation that enables other
-parties to make or receive copies.  Mere interaction with a user through
-a computer network, with no transfer of a copy, is not conveying.
-
-  An interactive user interface displays "Appropriate Legal Notices"
-to the extent that it includes a convenient and prominently visible
-feature that (1) displays an appropriate copyright notice, and (2)
-tells the user that there is no warranty for the work (except to the
-extent that warranties are provided), that licensees may convey the
-work under this License, and how to view a copy of this License.  If
-the interface presents a list of user commands or options, such as a
-menu, a prominent item in the list meets this criterion.
-
-  1. Source Code.
-
-  The "source code" for a work means the preferred form of the work
-for making modifications to it.  "Object code" means any non-source
-form of a work.
-
-  A "Standard Interface" means an interface that either is an official
-standard defined by a recognized standards body, or, in the case of
-interfaces specified for a particular programming language, one that
-is widely used among developers working in that language.
-
-  The "System Libraries" of an executable work include anything, other
-than the work as a whole, that (a) is included in the normal form of
-packaging a Major Component, but which is not part of that Major
-Component, and (b) serves only to enable use of the work with that
-Major Component, or to implement a Standard Interface for which an
-implementation is available to the public in source code form.  A
-"Major Component", in this context, means a major essential component
-(kernel, window system, and so on) of the specific operating system
-(if any) on which the executable work runs, or a compiler used to
-produce the work, or an object code interpreter used to run it.
-
-  The "Corresponding Source" for a work in object code form means all
-the source code needed to generate, install, and (for an executable
-work) run the object code and to modify the work, including scripts to
-control those activities.  However, it does not include the work's
-System Libraries, or general-purpose tools or generally available free
-programs which are used unmodified in performing those activities but
-which are not part of the work.  For example, Corresponding Source
-includes interface definition files associated with source files for
-the work, and the source code for shared libraries and dynamically
-linked subprograms that the work is specifically designed to require,
-such as by intimate data communication or control flow between those
-subprograms and other parts of the work.
-
-  The Corresponding Source need not include anything that users
-can regenerate automatically from other parts of the Corresponding
-Source.
-
-  The Corresponding Source for a work in source code form is that
-same work.
-
-  2. Basic Permissions.
-
-  All rights granted under this License are granted for the term of
-copyright on the Program, and are irrevocable provided the stated
-conditions are met.  This License explicitly affirms your unlimited
-permission to run the unmodified Program.  The output from running a
-covered work is covered by this License only if the output, given its
-content, constitutes a covered work.  This License acknowledges your
-rights of fair use or other equivalent, as provided by copyright law.
-
-  You may make, run and propagate covered works that you do not
-convey, without conditions so long as your license otherwise remains
-in force.  You may convey covered works to others for the sole purpose
-of having them make modifications exclusively for you, or provide you
-with facilities for running those works, provided that you comply with
-the terms of this License in conveying all material for which you do
-not control copyright.  Those thus making or running the covered works
-for you must do so exclusively on your behalf, under your direction
-and control, on terms that prohibit them from making any copies of
-your copyrighted material outside their relationship with you.
-
-  Conveying under any other circumstances is permitted solely under
-the conditions stated below.  Sublicensing is not allowed; section 10
-makes it unnecessary.
-
-  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
-
-  No covered work shall be deemed part of an effective technological
-measure under any applicable law fulfilling obligations under article
-11 of the WIPO copyright treaty adopted on 20 December 1996, or
-similar laws prohibiting or restricting circumvention of such
-measures.
-
-  When you convey a covered work, you waive any legal power to forbid
-circumvention of technological measures to the extent such circumvention
-is effected by exercising rights under this License with respect to
-the covered work, and you disclaim any intention to limit operation or
-modification of the work as a means of enforcing, against the work's
-users, your or third parties' legal rights to forbid circumvention of
-technological measures.
-
-  4. Conveying Verbatim Copies.
-
-  You may convey verbatim copies of the Program's source code as you
-receive it, in any medium, provided that you conspicuously and
-appropriately publish on each copy an appropriate copyright notice;
-keep intact all notices stating that this License and any
-non-permissive terms added in accord with section 7 apply to the code;
-keep intact all notices of the absence of any warranty; and give all
-recipients a copy of this License along with the Program.
-
-  You may charge any price or no price for each copy that you convey,
-and you may offer support or warranty protection for a fee.
-
-  5. Conveying Modified Source Versions.
-
-  You may convey a work based on the Program, or the modifications to
-produce it from the Program, in the form of source code under the
-terms of section 4, provided that you also meet all of these conditions:
-
-    a) The work must carry prominent notices stating that you modified
-    it, and giving a relevant date.
-
-    b) The work must carry prominent notices stating that it is
-    released under this License and any conditions added under section
-    7.  This requirement modifies the requirement in section 4 to
-    "keep intact all notices".
-
-    c) You must license the entire work, as a whole, under this
-    License to anyone who comes into possession of a copy.  This
-    License will therefore apply, along with any applicable section 7
-    additional terms, to the whole of the work, and all its parts,
-    regardless of how they are packaged.  This License gives no
-    permission to license the work in any other way, but it does not
-    invalidate such permission if you have separately received it.
-
-    d) If the work has interactive user interfaces, each must display
-    Appropriate Legal Notices; however, if the Program has interactive
-    interfaces that do not display Appropriate Legal Notices, your
-    work need not make them do so.
-
-  A compilation of a covered work with other separate and independent
-works, which are not by their nature extensions of the covered work,
-and which are not combined with it such as to form a larger program,
-in or on a volume of a storage or distribution medium, is called an
-"aggregate" if the compilation and its resulting copyright are not
-used to limit the access or legal rights of the compilation's users
-beyond what the individual works permit.  Inclusion of a covered work
-in an aggregate does not cause this License to apply to the other
-parts of the aggregate.
-
-  6. Conveying Non-Source Forms.
-
-  You may convey a covered work in object code form under the terms
-of sections 4 and 5, provided that you also convey the
-machine-readable Corresponding Source under the terms of this License,
-in one of these ways:
-
-    a) Convey the object code in, or embodied in, a physical product
-    (including a physical distribution medium), accompanied by the
-    Corresponding Source fixed on a durable physical medium
-    customarily used for software interchange.
-
-    b) Convey the object code in, or embodied in, a physical product
-    (including a physical distribution medium), accompanied by a
-    written offer, valid for at least three years and valid for as
-    long as you offer spare parts or customer support for that product
-    model, to give anyone who possesses the object code either (1) a
-    copy of the Corresponding Source for all the software in the
-    product that is covered by this License, on a durable physical
-    medium customarily used for software interchange, for a price no
-    more than your reasonable cost of physically performing this
-    conveying of source, or (2) access to copy the
-    Corresponding Source from a network server at no charge.
-
-    c) Convey individual copies of the object code with a copy of the
-    written offer to provide the Corresponding Source.  This
-    alternative is allowed only occasionally and noncommercially, and
-    only if you received the object code with such an offer, in accord
-    with subsection 6b.
-
-    d) Convey the object code by offering access from a designated
-    place (gratis or for a charge), and offer equivalent access to the
-    Corresponding Source in the same way through the same place at no
-    further charge.  You need not require recipients to copy the
-    Corresponding Source along with the object code.  If the place to
-    copy the object code is a network server, the Corresponding Source
-    may be on a different server (operated by you or a third party)
-    that supports equivalent copying facilities, provided you maintain
-    clear directions next to the object code saying where to find the
-    Corresponding Source.  Regardless of what server hosts the
-    Corresponding Source, you remain obligated to ensure that it is
-    available for as long as needed to satisfy these requirements.
-
-    e) Convey the object code using peer-to-peer transmission, provided
-    you inform other peers where the object code and Corresponding
-    Source of the work are being offered to the general public at no
-    charge under subsection 6d.
-
-  A separable portion of the object code, whose source code is excluded
-from the Corresponding Source as a System Library, need not be
-included in conveying the object code work.
-
-  A "User Product" is either (1) a "consumer product", which means any
-tangible personal property which is normally used for personal, family,
-or household purposes, or (2) anything designed or sold for incorporation
-into a dwelling.  In determining whether a product is a consumer product,
-doubtful cases shall be resolved in favor of coverage.  For a particular
-product received by a particular user, "normally used" refers to a
-typical or common use of that class of product, regardless of the status
-of the particular user or of the way in which the particular user
-actually uses, or expects or is expected to use, the product.  A product
-is a consumer product regardless of whether the product has substantial
-commercial, industrial or non-consumer uses, unless such uses represent
-the only significant mode of use of the product.
-
-  "Installation Information" for a User Product means any methods,
-procedures, authorization keys, or other information required to install
-and execute modified versions of a covered work in that User Product from
-a modified version of its Corresponding Source.  The information must
-suffice to ensure that the continued functioning of the modified object
-code is in no case prevented or interfered with solely because
-modification has been made.
-
-  If you convey an object code work under this section in, or with, or
-specifically for use in, a User Product, and the conveying occurs as
-part of a transaction in which the right of possession and use of the
-User Product is transferred to the recipient in perpetuity or for a
-fixed term (regardless of how the transaction is characterized), the
-Corresponding Source conveyed under this section must be accompanied
-by the Installation Information.  But this requirement does not apply
-if neither you nor any third party retains the ability to install
-modified object code on the User Product (for example, the work has
-been installed in ROM).
-
-  The requirement to provide Installation Information does not include a
-requirement to continue to provide support service, warranty, or updates
-for a work that has been modified or installed by the recipient, or for
-the User Product in which it has been modified or installed.  Access to a
-network may be denied when the modification itself materially and
-adversely affects the operation of the network or violates the rules and
-protocols for communication across the network.
-
-  Corresponding Source conveyed, and Installation Information provided,
-in accord with this section must be in a format that is publicly
-documented (and with an implementation available to the public in
-source code form), and must require no special password or key for
-unpacking, reading or copying.
-
-  7. Additional Terms.
-
-  "Additional permissions" are terms that supplement the terms of this
-License by making exceptions from one or more of its conditions.
-Additional permissions that are applicable to the entire Program shall
-be treated as though they were included in this License, to the extent
-that they are valid under applicable law.  If additional permissions
-apply only to part of the Program, that part may be used separately
-under those permissions, but the entire Program remains governed by
-this License without regard to the additional permissions.
-
-  When you convey a copy of a covered work, you may at your option
-remove any additional permissions from that copy, or from any part of
-it.  (Additional permissions may be written to require their own
-removal in certain cases when you modify the work.)  You may place
-additional permissions on material, added by you to a covered work,
-for which you have or can give appropriate copyright permission.
-
-  Notwithstanding any other provision of this License, for material you
-add to a covered work, you may (if authorized by the copyright holders of
-that material) supplement the terms of this License with terms:
-
-    a) Disclaiming warranty or limiting liability differently from the
-    terms of sections 15 and 16 of this License; or
-
-    b) Requiring preservation of specified reasonable legal notices or
-    author attributions in that material or in the Appropriate Legal
-    Notices displayed by works containing it; or
-
-    c) Prohibiting misrepresentation of the origin of that material, or
-    requiring that modified versions of such material be marked in
-    reasonable ways as different from the original version; or
-
-    d) Limiting the use for publicity purposes of names of licensors or
-    authors of the material; or
-
-    e) Declining to grant rights under trademark law for use of some
-    trade names, trademarks, or service marks; or
-
-    f) Requiring indemnification of licensors and authors of that
-    material by anyone who conveys the material (or modified versions of
-    it) with contractual assumptions of liability to the recipient, for
-    any liability that these contractual assumptions directly impose on
-    those licensors and authors.
-
-  All other non-permissive additional terms are considered "further
-restrictions" within the meaning of section 10.  If the Program as you
-received it, or any part of it, contains a notice stating that it is
-governed by this License along with a term that is a further
-restriction, you may remove that term.  If a license document contains
-a further restriction but permits relicensing or conveying under this
-License, you may add to a covered work material governed by the terms
-of that license document, provided that the further restriction does
-not survive such relicensing or conveying.
-
-  If you add terms to a covered work in accord with this section, you
-must place, in the relevant source files, a statement of the
-additional terms that apply to those files, or a notice indicating
-where to find the applicable terms.
-
-  Additional terms, permissive or non-permissive, may be stated in the
-form of a separately written license, or stated as exceptions;
-the above requirements apply either way.
-
-  8. Termination.
-
-  You may not propagate or modify a covered work except as expressly
-provided under this License.  Any attempt otherwise to propagate or
-modify it is void, and will automatically terminate your rights under
-this License (including any patent licenses granted under the third
-paragraph of section 11).
-
-  However, if you cease all violation of this License, then your
-license from a particular copyright holder is reinstated (a)
-provisionally, unless and until the copyright holder explicitly and
-finally terminates your license, and (b) permanently, if the copyright
-holder fails to notify you of the violation by some reasonable means
-prior to 60 days after the cessation.
-
-  Moreover, your license from a particular copyright holder is
-reinstated permanently if the copyright holder notifies you of the
-violation by some reasonable means, this is the first time you have
-received notice of violation of this License (for any work) from that
-copyright holder, and you cure the violation prior to 30 days after
-your receipt of the notice.
-
-  Termination of your rights under this section does not terminate the
-licenses of parties who have received copies or rights from you under
-this License.  If your rights have been terminated and not permanently
-reinstated, you do not qualify to receive new licenses for the same
-material under section 10.
-
-  9. Acceptance Not Required for Having Copies.
-
-  You are not required to accept this License in order to receive or
-run a copy of the Program.  Ancillary propagation of a covered work
-occurring solely as a consequence of using peer-to-peer transmission
-to receive a copy likewise does not require acceptance.  However,
-nothing other than this License grants you permission to propagate or
-modify any covered work.  These actions infringe copyright if you do
-not accept this License.  Therefore, by modifying or propagating a
-covered work, you indicate your acceptance of this License to do so.
-
-  10. Automatic Licensing of Downstream Recipients.
-
-  Each time you convey a covered work, the recipient automatically
-receives a license from the original licensors, to run, modify and
-propagate that work, subject to this License.  You are not responsible
-for enforcing compliance by third parties with this License.
-
-  An "entity transaction" is a transaction transferring control of an
-organization, or substantially all assets of one, or subdividing an
-organization, or merging organizations.  If propagation of a covered
-work results from an entity transaction, each party to that
-transaction who receives a copy of the work also receives whatever
-licenses to the work the party's predecessor in interest had or could
-give under the previous paragraph, plus a right to possession of the
-Corresponding Source of the work from the predecessor in interest, if
-the predecessor has it or can get it with reasonable efforts.
-
-  You may not impose any further restrictions on the exercise of the
-rights granted or affirmed under this License.  For example, you may
-not impose a license fee, royalty, or other charge for exercise of
-rights granted under this License, and you may not initiate litigation
-(including a cross-claim or counterclaim in a lawsuit) alleging that
-any patent claim is infringed by making, using, selling, offering for
-sale, or importing the Program or any portion of it.
-
-  11. Patents.
-
-  A "contributor" is a copyright holder who authorizes use under this
-License of the Program or a work on which the Program is based.  The
-work thus licensed is called the contributor's "contributor version".
-
-  A contributor's "essential patent claims" are all patent claims
-owned or controlled by the contributor, whether already acquired or
-hereafter acquired, that would be infringed by some manner, permitted
-by this License, of making, using, or selling its contributor version,
-but do not include claims that would be infringed only as a
-consequence of further modification of the contributor version.  For
-purposes of this definition, "control" includes the right to grant
-patent sublicenses in a manner consistent with the requirements of
-this License.
-
-  Each contributor grants you a non-exclusive, worldwide, royalty-free
-patent license under the contributor's essential patent claims, to
-make, use, sell, offer for sale, import and otherwise run, modify and
-propagate the contents of its contributor version.
-
-  In the following three paragraphs, a "patent license" is any express
-agreement or commitment, however denominated, not to enforce a patent
-(such as an express permission to practice a patent or covenant not to
-sue for patent infringement).  To "grant" such a patent license to a
-party means to make such an agreement or commitment not to enforce a
-patent against the party.
-
-  If you convey a covered work, knowingly relying on a patent license,
-and the Corresponding Source of the work is not available for anyone
-to copy, free of charge and under the terms of this License, through a
-publicly available network server or other readily accessible means,
-then you must either (1) cause the Corresponding Source to be so
-available, or (2) arrange to deprive yourself of the benefit of the
-patent license for this particular work, or (3) arrange, in a manner
-consistent with the requirements of this License, to extend the patent
-license to downstream recipients.  "Knowingly relying" means you have
-actual knowledge that, but for the patent license, your conveying the
-covered work in a country, or your recipient's use of the covered work
-in a country, would infringe one or more identifiable patents in that
-country that you have reason to believe are valid.
-
-  If, pursuant to or in connection with a single transaction or
-arrangement, you convey, or propagate by procuring conveyance of, a
-covered work, and grant a patent license to some of the parties
-receiving the covered work authorizing them to use, propagate, modify
-or convey a specific copy of the covered work, then the patent license
-you grant is automatically extended to all recipients of the covered
-work and works based on it.
-
-  A patent license is "discriminatory" if it does not include within
-the scope of its coverage, prohibits the exercise of, or is
-conditioned on the non-exercise of one or more of the rights that are
-specifically granted under this License.  You may not convey a covered
-work if you are a party to an arrangement with a third party that is
-in the business of distributing software, under which you make payment
-to the third party based on the extent of your activity of conveying
-the work, and under which the third party grants, to any of the
-parties who would receive the covered work from you, a discriminatory
-patent license (a) in connection with copies of the covered work
-conveyed by you (or copies made from those copies), or (b) primarily
-for and in connection with specific products or compilations that
-contain the covered work, unless you entered into that arrangement,
-or that patent license was granted, prior to 28 March 2007.
-
-  Nothing in this License shall be construed as excluding or limiting
-any implied license or other defenses to infringement that may
-otherwise be available to you under applicable patent law.
-
-  12. No Surrender of Others' Freedom.
-
-  If conditions are imposed on you (whether by court order, agreement or
-otherwise) that contradict the conditions of this License, they do not
-excuse you from the conditions of this License.  If you cannot convey a
-covered work so as to satisfy simultaneously your obligations under this
-License and any other pertinent obligations, then as a consequence you may
-not convey it at all.  For example, if you agree to terms that obligate you
-to collect a royalty for further conveying from those to whom you convey
-the Program, the only way you could satisfy both those terms and this
-License would be to refrain entirely from conveying the Program.
-
-  13. Use with the GNU Affero General Public License.
-
-  Notwithstanding any other provision of this License, you have
-permission to link or combine any covered work with a work licensed
-under version 3 of the GNU Affero General Public License into a single
-combined work, and to convey the resulting work.  The terms of this
-License will continue to apply to the part which is the covered work,
-but the special requirements of the GNU Affero General Public License,
-section 13, concerning interaction through a network will apply to the
-combination as such.
-
-  14. Revised Versions of this License.
-
-  The Free Software Foundation may publish revised and/or new versions of
-the GNU General Public License from time to time.  Such new versions will
-be similar in spirit to the present version, but may differ in detail to
-address new problems or concerns.
-
-  Each version is given a distinguishing version number.  If the
-Program specifies that a certain numbered version of the GNU General
-Public License "or any later version" applies to it, you have the
-option of following the terms and conditions either of that numbered
-version or of any later version published by the Free Software
-Foundation.  If the Program does not specify a version number of the
-GNU General Public License, you may choose any version ever published
-by the Free Software Foundation.
-
-  If the Program specifies that a proxy can decide which future
-versions of the GNU General Public License can be used, that proxy's
-public statement of acceptance of a version permanently authorizes you
-to choose that version for the Program.
-
-  Later license versions may give you additional or different
-permissions.  However, no additional obligations are imposed on any
-author or copyright holder as a result of your choosing to follow a
-later version.
-
-  15. Disclaimer of Warranty.
-
-  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
-APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
-HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
-OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
-THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
-PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
-IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
-ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
-
-  16. Limitation of Liability.
-
-  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
-WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
-THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
-GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
-USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
-DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
-PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
-EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
-SUCH DAMAGES.
-
-  17. Interpretation of Sections 15 and 16.
-
-  If the disclaimer of warranty and limitation of liability provided
-above cannot be given local legal effect according to their terms,
-reviewing courts shall apply local law that most closely approximates
-an absolute waiver of all civil liability in connection with the
-Program, unless a warranty or assumption of liability accompanies a
-copy of the Program in return for a fee.
-
-                     END OF TERMS AND CONDITIONS
-
-            How to Apply These Terms to Your New Programs
-
-  If you develop a new program, and you want it to be of the greatest
-possible use to the public, the best way to achieve this is to make it
-free software which everyone can redistribute and change under these terms.
-
-  To do so, attach the following notices to the program.  It is safest
-to attach them to the start of each source file to most effectively
-state the exclusion of warranty; and each file should have at least
-the "copyright" line and a pointer to where the full notice is found.
-
-    <one line to give the program's name and a brief idea of what it does.>
-    Copyright (C) <year>  <name of author>
-
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see <https://www.gnu.org/licenses/>.
-
-Also add information on how to contact you by electronic and paper mail.
-
-  If the program does terminal interaction, make it output a short
-notice like this when it starts in an interactive mode:
-
-    <program>  Copyright (C) <year>  <name of author>
-    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
-    This is free software, and you are welcome to redistribute it
-    under certain conditions; type `show c' for details.
-
-The hypothetical commands `show w' and `show c' should show the appropriate
-parts of the General Public License.  Of course, your program's commands
-might be different; for a GUI interface, you would use an "about box".
-
-  You should also get your employer (if you work as a programmer) or school,
-if any, to sign a "copyright disclaimer" for the program, if necessary.
-For more information on this, and how to apply and follow the GNU GPL, see
-<https://www.gnu.org/licenses/>.
-
-  The GNU General Public License does not permit incorporating your program
-into proprietary programs.  If your program is a subroutine library, you
-may consider it more useful to permit linking proprietary applications with
-the library.  If this is what you want to do, use the GNU Lesser General
-Public License instead of this License.  But first, please read
-<https://www.gnu.org/licenses/why-not-lgpl.html>.
+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,48 +1,35 @@
-
 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.
+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, i.e., installing LibreOffice subcomponents rather than the 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.
+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
+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:
@@ -52,6 +39,7 @@ sudo dnf install -y git automake autoconf libtool leptonica-devel pkg-config zli
 ```
 
 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
@@ -63,116 +51,108 @@ 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 &&\
+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.
+
+Next we need to install LibreOffice for conversions, qpdf 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
-
+- qpdf
 - 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
+sudo apt-get install -y libreoffice-writer libreoffice-calc libreoffice-impress unpaper qpdf
 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
+sudo dnf install -y libreoffice-writer libreoffice-calc libreoffice-impress unpaper qpdf
 pip3 install uno opencv-python-headless unoconv pngquant WeasyPrint
 ```
 
 For Nix:
 
 ```bash
-nix-env -iA nixpkgs.unpaper nixpkgs.libreoffice nixpkgs.ocrmypdf nixpkgs.poppler_utils
+nix-env -iA nixpkgs.unpaper nixpkgs.libreoffice nixpkgs.qpdf 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 &&\
+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
+### 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.
+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/ &&\
+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
+### 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.
+
+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:
+The easiest method is to use the language packs provided by your repositories. Skip the other steps if they are available.
+
+**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:
+**Debian-based systems**, install languages with this command:
 
 ```bash
-sudo apt update &&\
+sudo apt update && \
 # All languages
 # sudo apt install -y 'tesseract-ocr-*'
 
@@ -183,7 +163,7 @@ apt search tesseract-ocr-
 dpkg-query -W tesseract-ocr- | sed 's/tesseract-ocr-//g'
 ```
 
-Fedora:
+**Fedora:**
 
 ```bash
 # All languages
@@ -196,13 +176,13 @@ dnf search -C tesseract-langpack-
 rpm -qa | grep tesseract-langpack | sed 's/tesseract-langpack-//g'
 ```
 
-Nix:
+**Nix:**
 
 ```bash
 nix-env -iA nixpkgs.tesseract
 ```
 
-**Note:** Nix Package Manager pre-installs almost all the language packs when tesseract is installed.
+**Note:** Nix Package Manager pre-installs almost all the language packs when Tesseract is installed.
 
 ### Step 7: Run Stirling-PDF
 
@@ -214,11 +194,13 @@ 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:
+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:
+
+To resolve this, before starting 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
@@ -228,9 +210,10 @@ or
 java -jar ./Stirling-PDF-*.jar
 ```
 
-### Step 8: Adding a Desktop icon
+### Step 8: Adding a Desktop Icon
+
+This will add a modified app starter to your app menu.
 
-This will add a modified Appstarter to your Appmenu.
 ```bash
 location=$(pwd)/gradlew
 image=$(pwd)/docs/stirling-transparent.svg
@@ -251,33 +234,40 @@ EOF
 
 Note: Currently the app will run in the background until manually closed.
 
-### Optional: Changing the host and port of the application:
+### 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
+```yaml
 server:
-  host: 0.0.0.0
+  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).
+### Optional: Run Stirling-PDF as a Service (requires root)
 
-First create a .env file, where you can store environment variables:
-```
+First create a `.env` file, where you can store environment variables:
+
+```bash
 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:
-```
+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 the nano editor:
+
+```bash
 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:
-```
+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:
+
+```ini
 [Unit]
 Description=Stirling-PDF service
 After=syslog.target network.target
@@ -301,22 +291,25 @@ 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):
 
-```
+```bash
 sudo systemctl daemon-reload
 ```
 
-Enable the service to tell the service to start it automatically:
-```
+Enable the service to tell it to start automatically:
+
+```bash
 sudo systemctl enable stirlingpdf.service
 ```
 
 See the status of the service:
-```
+
+```bash
 sudo systemctl status stirlingpdf.service
 ```
 
 Manually start/stop/restart the service:
-```
+
+```bash
 sudo systemctl start stirlingpdf.service
 sudo systemctl stop stirlingpdf.service
 sudo systemctl restart stirlingpdf.service
@@ -324,12 +317,11 @@ 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.
+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:
+You can do this in the terminal by using the `export` command or `-D` argument to the Java `-jar` command:
 
 ```bash
 export APP_HOME_NAME="Stirling PDF"
 or
 -DAPP_HOME_NAME="Stirling PDF"
-```

PipelineFeature.md

@@ -1,6 +1,7 @@
 # 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
+
+- 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
 
@@ -26,19 +27,16 @@
    - 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.
+   - To use the configuration for folder scanning (or save it for future use and re-upload it), download a JSON file in this menu. You can also pre-load it 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**.
+   - 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
 
-
-    
+- 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,19 +1,17 @@
-<p align="center"><img src="https://raw.githubusercontent.com/Stirling-Tools/Stirling-PDF/main/docs/stirling.png" width="80" ></p>
+<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>
 
 [![Docker Pulls](https://img.shields.io/docker/pulls/frooodle/s-pdf)](https://hub.docker.com/r/frooodle/s-pdf)
 [![Discord](https://img.shields.io/discord/1068636748814483718?label=Discord)](https://discord.gg/Cn8pWhQRxZ)
 [![Docker Image Version (tag latest semver)](https://img.shields.io/docker/v/frooodle/s-pdf/latest)](https://github.com/Stirling-Tools/Stirling-PDF/)
 [![GitHub Repo stars](https://img.shields.io/github/stars/stirling-tools/stirling-pdf?style=social)](https://github.com/Stirling-Tools/stirling-pdf)
-[![Paypal Donate](https://img.shields.io/badge/Paypal%20Donate-yellow?style=flat&logo=paypal)](https://www.paypal.com/donate/?hosted_button_id=MN7JPG5G6G3JL)
-[![Github Sponsor](https://img.shields.io/badge/Github%20Sponsor-yellow?style=flat&logo=github)](https://github.com/sponsors/Frooodle)
 
+<a href="https://www.producthunt.com/posts/stirling-pdf?embed=true&utm_source=badge-featured&utm_medium=badge&utm_souce=badge-stirling&#0045;pdf" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=641239&theme=light" alt="Stirling&#0032;PDF - Open&#0032;source&#0032;locally&#0032;hosted&#0032;web&#0032;PDF&#0032;editor | Product Hunt" style="width: 250px; height: 54px;" width="250" height="54" /></a>
 [![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)
 
-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.
+[Stirling-PDF](https://www.stirlingpdf.com) 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.
 
-Stirling PDF does not initiate any outbound calls for record-keeping or tracking purposes.
+Stirling-PDF does not initiate any outbound calls for record-keeping or tracking purposes.
 
 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.
 
@@ -21,102 +19,117 @@ All files and PDFs exist either exclusively on the client side, reside in server
 
 ## Features
 
-- Dark mode support.
+- Enterprise features like SSO Check [here](https://docs.stirlingpdf.com/Enterprise%20Edition) 
+- 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**
+## PDF Features
 
-- View and modify PDFs - View multi page PDFs with custom viewing sorting and searching. Plus on page edit features like annotate, draw and adding text and images. (Using PDF.js with Joxit and Liberation.Liberation fonts)
-- Full interactive GUI for merging/splitting/rotating/moving PDFs and their pages.
-- Merge multiple PDFs together into a single resultant file.
-- Split PDFs into multiple files at specified page numbers or extract all pages as individual files.
-- Reorganize PDF pages into different orders.
-- Rotate PDFs in 90-degree increments.
-- Remove pages.
-- Multi-page layout (Format PDFs into a multi-paged page).
-- Scale page contents size by set %.
-- Adjust Contrast.
-- Crop PDF.
-- Auto Split PDF (With physically scanned page dividers).
-- Extract page(s).
-- Convert PDF to a single page.
+### Page Operations
 
-### **Conversion 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 fonts)
+- Full interactive GUI for merging/splitting/rotating/moving PDFs and their pages
+- Merge multiple PDFs 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 percentage
+- Adjust contrast
+- Crop PDF
+- Auto split PDF (with physically scanned page dividers)
+- Extract page(s)
+- Convert PDF to a single page
+- Overlay PDFs on top of each other
+- PDF to single page
+- Split PDF by sections
 
-- 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.
+### Conversion Operations
 
-### **Security & Permissions**
+- 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
+- Convert PDF to xml
+- Convert PDF to CSV
+- URL to PDF
+- Markdown to PDF
 
-- Add and remove passwords.
-- Change/set PDF Permissions.
-- Add watermark(s).
-- Certify/sign PDFs.
-- Sanitize PDFs.
-- Auto-redact text.
+### Security & Permissions
 
-### **Other Operations**
+- Add and remove passwords
+- Change/set PDF permissions
+- Add watermark(s)
+- Certify/sign PDFs
+- Sanitize PDFs
+- Auto-redact text
 
-- 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.
+### Other Operations
 
-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)
+- Add/generate/write signatures
+- Split by Size or PDF
+- Repair PDFs
+- Detect and remove blank pages
+- Compare two PDFs and show differences in text
+- Add images to PDFs
+- Compress PDFs to decrease their filesize (using qpdf)
+- Extract images from PDF
+- Remove images from PDF
+- Extract images from scans
+- Remove annotations
+- Add page numbers
+- Auto rename file by detecting PDF header text
+- OCR on PDF (using tesseract)
+- PDF/A conversion (using libreoffice)
+- Edit metadata
+- Flatten PDFs
+- Get all information on a PDF to view or export as JSON
+- Show/detect embedded JavaScript
 
-Demo of the app is available [here](https://stirlingpdf.io).
+For an 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).
 
-## Technologies used
+A 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)
+- [qpdf](https://github.com/qpdf/qpdf)
 - HTML, CSS, JavaScript
 - Docker
 - [PDF.js](https://github.com/mozilla/pdf.js)
 - [PDF-LIB.js](https://github.com/Hopding/pdf-lib)
 
-## How to use
+## 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
+Please view the [LocalRunGuide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/LocalRunGuide.md).
 
 ### Docker / Podman
 
-https://hub.docker.com/r/frooodle/s-pdf
+> [!NOTE]
+> <https://hub.docker.com/r/stirlingtools/stirling-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)
+Stirling-PDF has three different versions: a full version, an ultra-lite version, and 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 space optimization, just use the latest tag.
 
-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 Image Size (tag)](https://img.shields.io/docker/image-size/stirlingtools/stirling-pdf/latest?label=Stirling-PDF%20Full)
+![Docker Image Size (tag)](https://img.shields.io/docker/image-size/stirlingtools/stirling-pdf/latest-ultra-lite?label=Stirling-PDF%20Ultra-Lite)
+![Docker Image Size (tag)](https://img.shields.io/docker/image-size/stirlingtools/stirling-pdf/latest-fat?label=Stirling-PDF%20Fat)
+
+Please note in the examples below, you may need to change the volume paths as needed, e.g., `./extraConfigs:/configs` to `/opt/stirlingpdf/extraConfigs:/configs`.
 
 ### Docker Run
 
@@ -126,15 +139,13 @@ docker run -d \
   -v ./trainingData:/usr/share/tessdata \
   -v ./extraConfigs:/configs \
   -v ./logs:/logs \
+# Optional customization (not required)
+# -v /location/of/customFiles:/customFiles \
   -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 \
+  stirlingtools/stirling-pdf:latest
 ```
 
 ### Docker Compose
@@ -143,11 +154,11 @@ docker run -d \
 version: '3.3'
 services:
   stirling-pdf:
-    image: frooodle/s-pdf:latest
+    image: stirlingtools/stirling-pdf:latest
     ports:
       - '8080:8080'
     volumes:
-      - ./trainingData:/usr/share/tessdata #Required for extra OCR languages
+      - ./trainingData:/usr/share/tessdata # Required for extra OCR languages
       - ./extraConfigs:/configs
 #      - ./customFiles:/customFiles/
 #      - ./logs:/logs/
@@ -159,196 +170,258 @@ services:
 
 Note: Podman is CLI-compatible with Docker, so simply replace "docker" with "podman".
 
-## Enable OCR/Compression feature
+### Kubernetes
 
-Please view https://github.com/Stirling-Tools/Stirling-PDF/blob/main/HowToUseOCR.md
+See the kubernetes helm chart [here](https://github.com/Stirling-Tools/Stirling-PDF-chart)
+
+## Enable OCR/Compression Feature
+
+Please view the [HowToUseOCR.md](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/HowToUseOCR.md).
+
+## Reuse Stored Files
+
+Certain functionality like `Sign` supports pre-saved files stored at `/customFiles/signatures/`. Image files placed within here will be accessible to be used via the web UI. Currently, this supports two folder types:
+
+- `/customFiles/signatures/ALL_USERS`: Accessible to all users, useful for organizations where many users use the same files or for users not using authentication
+- `/customFiles/signatures/{username}`: Such as `/customFiles/signatures/froodle`, accessible only to the `froodle` username, private for all others
 
 ## Supported Languages
 
-Stirling PDF currently supports 38!
+Stirling-PDF currently supports 37 languages!
 
-| Language                                    | Progress                               |
-| ------------------------------------------- | -------------------------------------- |
-| Arabic (العربية) (ar_AR)                    | ![44%](https://geps.dev/progress/44)   |
-| Basque (Euskara) (eu_ES)                    | ![60%](https://geps.dev/progress/60)   |
-| Bulgarian (Български) (bg_BG)               | ![92%](https://geps.dev/progress/92)   |
-| Catalan (Català) (ca_CA)                    | ![47%](https://geps.dev/progress/47)   |
-| Croatian (Hrvatski) (hr_HR)                 | ![92%](https://geps.dev/progress/92)   |
-| Czech (Česky) (cs_CZ)                       | ![88%](https://geps.dev/progress/88)   |
-| Danish (Dansk) (da_DK)                      | ![9%](https://geps.dev/progress/9)   |
-| Dutch (Nederlands) (nl_NL)                  | ![94%](https://geps.dev/progress/94)   |
-| 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)                   | ![91%](https://geps.dev/progress/91)   |
-| German (Deutsch) (de_DE)                    | ![98%](https://geps.dev/progress/98) |
-| Greek (Ελληνικά) (el_GR)                    | ![80%](https://geps.dev/progress/80)   |
-| Hindi (हिंदी) (hi_IN)                          | ![75%](https://geps.dev/progress/75)   |
-| Hungarian (Magyar) (hu_HU)                  | ![74%](https://geps.dev/progress/74)   |
-| Indonesia (Bahasa Indonesia) (id_ID)        | ![74%](https://geps.dev/progress/74)   |
-| Irish (Gaeilge) (ga_IE)                     | ![96%](https://geps.dev/progress/96)   |
-| Italian (Italiano) (it_IT)                  | ![99%](https://geps.dev/progress/99)   |
-| Japanese (日本語) (ja_JP)                   | ![90%](https://geps.dev/progress/90)   |
-| Korean (한국어) (ko_KR)                     | ![82%](https://geps.dev/progress/82)   |
-| Norwegian (Norsk) (no_NB)                   | ![96%](https://geps.dev/progress/96)   |
-| Polish (Polski) (pl_PL)                     | ![90%](https://geps.dev/progress/90)   |
-| Portuguese (Português) (pt_PT)              | ![76%](https://geps.dev/progress/76)   |
-| Portuguese Brazilian (Português) (pt_BR)    | ![99%](https://geps.dev/progress/99)   |
-| Romanian (Română) (ro_RO)                   | ![38%](https://geps.dev/progress/38)   |
-| Russian (Русский) (ru_RU)                   | ![82%](https://geps.dev/progress/82)   |
-| Serbian Latin alphabet (Srpski) (sr_LATN_RS) | ![76%](https://geps.dev/progress/76)   |
-| Simplified Chinese (简体中文) (zh_CN)       | ![97%](https://geps.dev/progress/97)   |
-| Slovakian (Slovensky) (sk_SK)               | ![90%](https://geps.dev/progress/90)   |
-| Spanish (Español) (es_ES)                   | ![96%](https://geps.dev/progress/96)   |
-| Swedish (Svenska) (sv_SE)                   | ![38%](https://geps.dev/progress/38)   |
-| Thai (ไทย) (th_TH)                          | ![97%](https://geps.dev/progress/97) |
-| Traditional Chinese (繁體中文) (zh_TW)      | ![96%](https://geps.dev/progress/96)   |
-| Turkish (Türkçe) (tr_TR)                    | ![97%](https://geps.dev/progress/97)   |
-| Ukrainian (Українська) (uk_UA)              | ![88%](https://geps.dev/progress/88)   |
-| Vietnamese (Tiếng Việt) (vi_VN)             | ![97%](https://geps.dev/progress/97)   |
+| Language                                     | Progress                               |
+| -------------------------------------------- | -------------------------------------- |
+| Arabic (العربية) (ar_AR)                        | ![95%](https://geps.dev/progress/95)   |
+| Azerbaijani (Azərbaycan Dili) (az_AZ)        | ![93%](https://geps.dev/progress/93)   |
+| Basque (Euskara) (eu_ES)                     | ![52%](https://geps.dev/progress/52)   |
+| Bulgarian (Български) (bg_BG)                | ![90%](https://geps.dev/progress/90)   |
+| Catalan (Català) (ca_CA)                     | ![84%](https://geps.dev/progress/84)   |
+| Croatian (Hrvatski) (hr_HR)                  | ![92%](https://geps.dev/progress/92)   |
+| Czech (Česky) (cs_CZ)                        | ![91%](https://geps.dev/progress/91)   |
+| Danish (Dansk) (da_DK)                       | ![90%](https://geps.dev/progress/90)   |
+| Dutch (Nederlands) (nl_NL)                   | ![90%](https://geps.dev/progress/90)   |
+| 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)                    | ![93%](https://geps.dev/progress/93)   |
+| German (Deutsch) (de_DE)                     | ![93%](https://geps.dev/progress/93)   |
+| Greek (Ελληνικά) (el_GR)                     | ![91%](https://geps.dev/progress/91)   |
+| Hindi (हिंदी) (hi_IN)                          | ![89%](https://geps.dev/progress/89)   |
+| Hungarian (Magyar) (hu_HU)                   | ![92%](https://geps.dev/progress/92)   |
+| Indonesian (Bahasa Indonesia) (id_ID)        | ![91%](https://geps.dev/progress/91)   |
+| Irish (Gaeilge) (ga_IE)                      | ![82%](https://geps.dev/progress/82)   |
+| Italian (Italiano) (it_IT)                   | ![95%](https://geps.dev/progress/95)   |
+| Japanese (日本語) (ja_JP)                    | ![80%](https://geps.dev/progress/80)   |
+| Korean (한국어) (ko_KR)                      | ![89%](https://geps.dev/progress/89)   |
+| Norwegian (Norsk) (no_NB)                    | ![82%](https://geps.dev/progress/82)   |
+| Polish (Polski) (pl_PL)                      | ![91%](https://geps.dev/progress/91)   |
+| Portuguese (Português) (pt_PT)               | ![91%](https://geps.dev/progress/91)   |
+| Portuguese Brazilian (Português) (pt_BR)     | ![92%](https://geps.dev/progress/92)   |
+| Romanian (Română) (ro_RO)                    | ![84%](https://geps.dev/progress/84)   |
+| Russian (Русский) (ru_RU)                    | ![91%](https://geps.dev/progress/91)   |
+| Serbian Latin alphabet (Srpski) (sr_LATN_RS) | ![66%](https://geps.dev/progress/66)   |
+| Simplified Chinese (简体中文) (zh_CN)         | ![85%](https://geps.dev/progress/85)   |
+| Slovakian (Slovensky) (sk_SK)                | ![77%](https://geps.dev/progress/77)   |
+| Spanish (Español) (es_ES)                    | ![92%](https://geps.dev/progress/92)   |
+| Swedish (Svenska) (sv_SE)                    | ![91%](https://geps.dev/progress/91)   |
+| Thai (ไทย) (th_TH)                           | ![90%](https://geps.dev/progress/90)   |
+| Traditional Chinese (繁體中文) (zh_TW)        | ![92%](https://geps.dev/progress/92)   |
+| Turkish (Türkçe) (tr_TR)                     | ![86%](https://geps.dev/progress/86)   |
+| Ukrainian (Українська) (uk_UA)               | ![75%](https://geps.dev/progress/75)   |
+| Vietnamese (Tiếng Việt) (vi_VN)              | ![83%](https://geps.dev/progress/83)   |
 
-## Contributing (creating issues, translations, fixing bugs, etc.)
+## Contributing (Creating Issues, Translations, Fixing Bugs, etc.)
 
-Please see our [Contributing Guide](CONTRIBUTING.md)!
+Please see our [Contributing Guide](CONTRIBUTING.md).
 
-## Customisation
+## Stirling PDF Enterprise
 
-Stirling PDF allows easy customization of the app.
-Includes things like
+Stirling PDF offers a Enterprise edition of its software, This is the same great software but with added features and comforts
+
+### Whats included
+
+- Prioritised Support tickets via support@stirlingpdf.com to reach directly to Stirling-PDF team for support and 1:1 meetings where applicable (Provided they come from same email domain registered with us)
+- Prioritised Enhancements to Stirling-PDF where applicable 
+- Base SSO support
+- Advanced SSO such as automated login handling (Coming very soon)
+- SAML SSO (Coming very soon)
+- Custom automated metadata handling
+- Advanced user configurations (Coming soon)
+- Plus other exciting features to come
+
+Check out of [docs](https://docs.stirlingpdf.com/Enterprise%20Edition) on it or our official [website](https://www.stirlingpdf.com)
+
+## Customization
+
+Stirling-PDF allows easy customization of the app, including things like:
 
 - Custom application name
-- Custom slogans, icons, HTML, images CSS etc (via file overrides)
+- 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
+There are two options for this, either using the generated settings file `settings.yml`, which is located in the `/configs` directory and follows standard YAML formatting, or using environment variables, which would override the settings file.
 
-Environment variables are also supported and would override the settings file
-For example in the settings.yml you have
+For example, in `settings.yml`, you might have:
 
 ```yaml
 security:
   enableLogin: 'true'
 ```
 
-To have this via an environment variable you would have ``SECURITY_ENABLELOGIN``
+To have this via an environment variable, you would use `SECURITY_ENABLELOGIN`.
 
-The Current list of settings is
+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
+  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
+    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
+        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
+        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
+        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) endpoint
+    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'
+    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'
+  saml2:
+    enabled: false # currently in alpha, not recommended for use yet, enableAlphaFunctionality must be set to true
+    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
+    registrationId: stirling
+    idpMetadataUri: https://dev-XXXXXXXX.okta.com/app/externalKey/sso/saml/metadata
+    idpSingleLogoutUrl: https://dev-XXXXXXXX.okta.com/app/dev-XXXXXXXX_stirlingpdf_1/externalKey/slo/saml
+    idpSingleLoginUrl: https://dev-XXXXXXXX.okta.com/app/dev-XXXXXXXX_stirlingpdf_1/externalKey/sso/saml
+    idpIssuer: http://www.okta.com/externalKey
+    idpCert: classpath:okta.crt
+    privateKey: classpath:saml-private-key.key
+    spCert: classpath:saml-public-cert.crt
+
+enterpriseEdition:
+  enabled: false # set to 'true' to enable enterprise edition
+  key: 00000000-0000-0000-0000-000000000000
+  CustomMetadata:
+    autoUpdateMetadata: false # set to 'true' to automatically update metadata with below values
+    author: username # supports text such as 'John Doe' or types such as username to autopopulate with user's username
+    creator: Stirling-PDF # supports text such as 'Company-PDF'
+    producer: Stirling-PDF # supports text such as 'Company-PDF'
+
+legal:
+  termsAndConditions: https://www.stirlingpdf.com/terms-and-conditions # URL to the terms and conditions of your application (e.g. https://example.com/terms). Empty string to disable or filename to load from local file in static folder
+  privacyPolicy: https://www.stirlingpdf.com/privacy-policy # URL to the privacy policy of your application (e.g. https://example.com/privacy). Empty string to disable or filename to load from local file in static folder
+  accessibilityStatement: '' # URL to the accessibility statement of your application (e.g. https://example.com/accessibility). Empty string to disable or filename to load from local file in static folder
+  cookiePolicy: '' # URL to the cookie policy of your application (e.g. https://example.com/cookie). Empty string to disable or filename to load from local file in static folder
+  impressum: '' # URL to the impressum of your application (e.g. https://example.com/impressum). Empty string to disable or filename to load from local file in static folder
 
 system:
-  defaultLocale: 'en-US' # Set the default language (e.g. 'de-DE', 'fr-FR', etc)
+  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
+  enableAlphaFunctionality: false # set to enable functionality which might need more testing before it fully goes live (this feature might make no changes)
+  showUpdate: false # 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
+  tessdataDir: /usr/share/tessdata # path to the directory containing the Tessdata files. This setting is relevant for Windows systems. For Windows users, this path should be adjusted to point to the appropriate directory where the Tessdata files are stored.
+  enableAnalytics: undefined # set to 'true' to enable analytics, set to 'false' to disable analytics; for enterprise users, this is set to true
 
 ui:
-  appName: '' # Application's visible name
-  homeDescription: '' # Short description or tagline shown on homepage.
-  appNameNavbar: '' # Name displayed on the navigation bar
+  appName: '' # application's visible name
+  homeDescription: '' # short description or tagline shown on the 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'])
+  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
+
+# Automatically Generated Settings (Do Not Edit Directly)
+AutomaticallyGenerated:
+  key: example
+  UUID: example
 ```
 
-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
+There is an additional config file `/configs/custom_settings.yml` where users familiar with Java and Spring `application.properties` can input their own settings on top of Stirling-PDF's 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
+### Extra Notes
 
-- ``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
+- **Endpoints**: Currently, the `ENDPOINTS_TO_REMOVE` and `GROUPS_TO_REMOVE` endpoints can include comma-separated lists of endpoints and groups to disable. For example, `ENDPOINTS_TO_REMOVE=img-to-pdf,remove-pages` would disable both image-to-pdf and remove pages, while `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**: Customize static files such as the app logo by placing files in the `/customFiles/static/` directory. An example of customizing the app logo is placing `/customFiles/static/favicon.svg` to override the current SVG. This can be used to change any `images/icons/css/fonts/js`, etc. in Stirling-PDF.
+
+### Environment-Only Parameters
+
+- `SYSTEM_ROOTURIPATH` - Set the application's root URI (e.g. `/pdf-app` to set the root URI to `localhost:8080/pdf-app`)
+- `SYSTEM_CONNECTIONTIMEOUTMINUTES` - Set custom connection timeout values
+- `DOCKER_ENABLE_SECURITY` - Set to `true` to download security jar (required for authentication login)
+- `INSTALL_BOOK_AND_ADVANCED_HTML_OPS` - Download Calibre onto Stirling-PDF to enable PDF to/from book and advanced HTML conversion
+- `LANGS` - Define custom font libraries to install 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)
+For those wanting to use Stirling-PDF's 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 version's documentation (or by following the API button in the settings of Stirling-PDF).
 
-## Login authentication
+## 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).
+- 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 set `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 credentials 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.
+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
+When you log in to Stirling-PDF, you will be redirected to the `/login` page to log in 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 access your account settings, go to Account Settings in the settings cog menu (top right in the 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
+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 and will be expanded on more in the future.
 
-For API usage you must provide a header with 'X-API-Key' and the associated API key for that user.
+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
+- 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)
+- Add forms
+- Multi-page layout (stitch 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?
+### Q2: Why is my application downloading .htm files? Why am i getting HTTP error 413?
 
-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.
+This is an issue commonly caused 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
+### 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;``
+NGINX has timeout values by default, so if you are running Stirling-PDF behind NGINX, you may need to set a timeout value, such as adding the config `proxy_read_timeout 3600;`.

Version-groups.md

@@ -1,14 +1,14 @@
 |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. 
+The 'Fat' container contains all those found in 'Full' with security jar along with this Calibre install.
 
-Technology | Ultra-Lite | Full  |
+| Technology | Ultra-Lite | Full  |
 | ---------- | :--------: | :---: |
 | Java       |     ✔️      |   ✔️   |
 | JavaScript |     ✔️      |   ✔️   |
 | Libre      |            |   ✔️   |
 | Python     |            |   ✔️   |
 | OpenCV     |            |   ✔️   |
-| OCRmyPDF   |            |   ✔️   |
+| qpdf   |            |   ✔️   |
 
 | Operation              | Ultra-Lite | Full |
 | ---------------------- | ---------- | ---- |
@@ -54,3 +54,15 @@ Technology | Ultra-Lite | Full  |
 | ocr-pdf                |            | ✔️    |
 | pdf-to-pdfa            |            | ✔️    |
 | remove-blanks          |            | ✔️    |
+pdf-to-text             |     ✔️      |  ✔️
+pdf-to-html             |            |  ✔️
+pdf-to-word             |            |  ✔️
+pdf-to-presentation     |            |  ✔️
+pdf-to-xml              |            |  ✔️
+remove-annotations      |     ✔️      |  ✔️
+remove-cert-sign        |     ✔️      |  ✔️
+remove-image-pdf        |     ✔️      |  ✔️
+file-to-pdf             |            |  ✔️
+html-to-pdf             |            |  ✔️
+url-to-pdf              |            |  ✔️
+repair                  |            |  ✔️

build.gradle

@@ -1,27 +1,33 @@
 plugins {
     id "java"
-    id "org.springframework.boot" version "3.3.2"
+    id "org.springframework.boot" version "3.4.0"
     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.2"
+    springBootVersion = "3.4.0"
     pdfboxVersion = "3.0.3"
     logbackVersion = "1.5.7"
-    imageioVersion = "3.11.0"
-    lombokVersion = "1.18.34"
-    bouncycastleVersion = "1.78.1"	
+    imageioVersion = "3.12.0"
+    lombokVersion = "1.18.36"
+    bouncycastleVersion = "1.79"
+    springSecuritySamlVersion = "6.4.1"
+    openSamlVersion = "4.3.2"  
 }
 
 group = "stirling.software"
-version = "0.28.2"
+version = "0.36.0"
+
 
 java {
     // 17 is lowest but we support and recommend 21
@@ -31,6 +37,10 @@ java {
 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 {
@@ -73,7 +83,7 @@ launch4j {
 
     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"]
+    variables=["BROWSER_OPEN=true"]
     jreMinVersion="17"
 
     mutexName="Stirling-PDF"
@@ -100,15 +110,21 @@ spotless {
     }
 }
 
+//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 "ch.qos.logback:logback-classic:$logbackVersion"
-    implementation "ch.qos.logback:logback-core:$logbackVersion"
-    implementation "org.springframework:spring-webmvc:6.1.9"
+    implementation "org.springframework:spring-webmvc:6.2.0"
 
     implementation("io.github.pixee:java-security-toolkit:1.2.0")
 
@@ -116,12 +132,13 @@ dependencies {
     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") {
-        exclude group: "org.springframework.boot", module: "spring-boot-starter-tomcat"
-    }
+    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"
@@ -129,37 +146,51 @@ dependencies {
         implementation "org.springframework.boot:spring-boot-starter-data-jpa:$springBootVersion"
         implementation "org.springframework.boot:spring-boot-starter-oauth2-client:$springBootVersion"
 
-        //2.2.x requires rebuild of DB file.. need migration path
-        implementation "com.h2database:h2:2.1.214"
-        // implementation "com.h2database:h2:2.2.224"
+		implementation "org.springframework.session:spring-session-core:$springBootVersion"
+				
+	    implementation 'com.unboundid.product.scim2:scim2-sdk-client:2.3.5'
+        // Don't upgrade h2database
+        runtimeOnly "com.h2database:h2:2.3.232"
+        constraints {
+            implementation "org.opensaml:opensaml-core:$openSamlVersion"
+            implementation "org.opensaml:opensaml-saml-api:$openSamlVersion"
+            implementation "org.opensaml:opensaml-saml-impl:$openSamlVersion"
+        }
+        implementation "org.springframework.security:spring-security-saml2-service-provider:$springSecuritySamlVersion"
+//		implementation 'org.springframework.security:spring-security-core:$springSecuritySamlVersion'
+        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.17"
+    implementation "org.apache.xmlgraphics:batik-all:1.18"
 
     // TwelveMonkeys
-    implementation "com.twelvemonkeys.imageio:imageio-batik:$imageioVersion"
-    implementation "com.twelvemonkeys.imageio:imageio-bmp:$imageioVersion"
-    // implementation "com.twelvemonkeys.imageio:imageio-hdr:$imageioVersion"
-    // implementation "com.twelvemonkeys.imageio:imageio-icns:$imageioVersion"
-    // implementation "com.twelvemonkeys.imageio:imageio-iff:$imageioVersion"
-    implementation "com.twelvemonkeys.imageio:imageio-jpeg:$imageioVersion"
-    // implementation "com.twelvemonkeys.imageio:imageio-pcx:$imageioVersion@
-    // implementation "com.twelvemonkeys.imageio:imageio-pict:$imageioVersion"
-    // implementation "com.twelvemonkeys.imageio:imageio-pnm:$imageioVersion"
-    // implementation "com.twelvemonkeys.imageio:imageio-psd:$imageioVersion"
-    // implementation "com.twelvemonkeys.imageio:imageio-sgi:$imageioVersion"
-    // implementation "com.twelvemonkeys.imageio:imageio-tga:$imageioVersion"
-    // implementation "com.twelvemonkeys.imageio:imageio-thumbsdb:$imageioVersion"
-    implementation "com.twelvemonkeys.imageio:imageio-tiff:$imageioVersion"
-    implementation "com.twelvemonkeys.imageio:imageio-webp:$imageioVersion"
-    // implementation "com.twelvemonkeys.imageio:imageio-xwd:$imageioVersion"
+    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.16.1"
+    // Image metadata extractor
+    implementation "com.drewnoakes:metadata-extractor:2.19.0"
+
+    implementation "commons-io:commons-io:2.18.0"
     implementation "org.springdoc:springdoc-openapi-starter-webmvc-ui:2.2.0"
-
     //general PDF
 
     // https://mvnrepository.com/artifact/com.opencsv/opencsv
@@ -175,28 +206,32 @@ dependencies {
         exclude group: "commons-logging", module: "commons-logging"
     }
 
-    implementation 'org.apache.pdfbox:jbig2-imageio:3.0.4'
+    // https://mvnrepository.com/artifact/technology.tabula/tabula
+    implementation ('technology.tabula:tabula:1.0.5')  {
+        exclude group: "org.slf4j", module: "slf4j-simple"
+        exclude group: "org.bouncycastle", module: "bcprov-jdk15on"
+        exclude group: "com.google.code.gson", module: "gson"
+    }
 
-	
-    implementation "com.github.Carleslc.Simple-YAML:Simple-Yaml:1.8.4"
+    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.3"
+    implementation "io.micrometer:micrometer-core:1.14.1"
     implementation group: "com.google.zxing", name: "core", version: "3.5.3"
     // https://mvnrepository.com/artifact/org.commonmark/commonmark
-    implementation "org.commonmark:commonmark:0.22.0"
-    implementation "org.commonmark:commonmark-ext-gfm-tables:0.22.0"
+    implementation "org.commonmark:commonmark:0.24.0"
+    implementation "org.commonmark:commonmark-ext-gfm-tables:0.24.0"
     // https://mvnrepository.com/artifact/com.bucket4j/bucket4j_jdk17
     implementation "com.bucket4j:bucket4j_jdk17-core:8.14.0"
-    implementation "com.fathzer:javaluator:3.0.4"
+    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"
 
-    testImplementation 'org.mockito:mockito-inline:5.2.0'
+    testRuntimeOnly 'org.mockito:mockito-inline:5.2.0'
 }
 
 tasks.withType(JavaCompile).configureEach {

chart/stirling-pdf/Chart.yaml

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

chart/stirling-pdf/templates/NOTES.txt

@@ -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:
-

cucumber/exampleFiles/example.html

@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html>
+<body>
+
+<h1>My First Heading</h1>
+
+<p>My first paragraph.</p>
+
+</body>
+</html>
+

cucumber/exampleFiles/example.md

@@ -0,0 +1,16 @@
+header
+============
+
+Header2
+------------
+text
+
+text2
+
+## **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.

cucumber/features/external.feature

@@ -48,24 +48,6 @@ Feature: API Validation
 	And the response status code should be 200
 	
 	
-	
-  @ocr @negative
-  Scenario: Process PDF with text and OCR with type normal 
-    Given I generate a PDF file as "fileInput"
-    And the pdf contains 3 pages with random text
-    And the request data includes
-      | parameter        | value       |
-      | languages        | eng         |
-      | sidecar          | false        |
-      | deskew           | true        |
-      | clean            | true        |
-      | cleanFinal       | true        |
-      | ocrType          | Normal      |
-      | ocrRenderType    | hocr        |
-      | removeImagesAfter| false       |
-    When I send the API request to the endpoint "/api/v1/misc/ocr-pdf"
-	Then the response status code should be 500
-	
   @ocr @positive
   Scenario: Process PDF with OCR
     Given I generate a PDF file as "fileInput"
@@ -83,26 +65,6 @@ Feature: API Validation
     Then the response content type should be "application/pdf"
     And the response file should have size greater than 0
 	And the response status code should be 200
-	
-  @ocr @positive
-  Scenario: Process PDF with OCR with sidecar
-    Given I generate a PDF file as "fileInput"
-    And the request data includes
-      | parameter        | value       |
-      | languages        | eng         |
-      | sidecar          | true        |
-      | deskew           | true        |
-      | clean            | true        |
-      | cleanFinal       | true        |
-      | ocrType          | Force      |
-      | ocrRenderType    | hocr        |
-      | removeImagesAfter| false       |
-    When I send the API request to the endpoint "/api/v1/misc/ocr-pdf"
-    Then the response content type should be "application/octet-stream"
-	And the response file should have extension ".zip"
-	And the response ZIP should contain 2 files
-    And the response file should have size greater than 0
-	And the response status code should be 200
 
 
   @libre @positive
@@ -123,7 +85,7 @@ Feature: API Validation
     | odt    | .odt      |
     | doc    | .doc      |
 
-  @ocr
+  @ocr @pdfa1
   Scenario: PDFA
     Given I use an example file at "exampleFiles/pdfa2.pdf" as parameter "fileInput"
 	And the request data includes
@@ -134,7 +96,7 @@ Feature: API Validation
     And the response file should have extension ".pdf"
     And the response file should have size greater than 100
 	
-  @ocr
+  @ocr @pdfa2
   Scenario: PDFA1
     Given I use an example file at "exampleFiles/pdfa1.pdf" as parameter "fileInput"
 	And the request data includes
@@ -145,7 +107,7 @@ Feature: API Validation
     And the response file should have extension ".pdf"
     And the response file should have size greater than 100
 	
-  @compress @ghostscript @positive
+  @compress @qpdf @positive
   Scenario: Compress
     Given I use an example file at "exampleFiles/ghost3.pdf" as parameter "fileInput"
 	And the request data includes
@@ -156,7 +118,7 @@ Feature: API Validation
     And the response file should have extension ".pdf"
     And the response file should have size greater than 100
 	
-  @compress @ghostscript @positive
+  @compress @qpdf @positive
   Scenario: Compress
     Given I use an example file at "exampleFiles/ghost2.pdf" as parameter "fileInput"
 	And the request data includes
@@ -169,7 +131,7 @@ Feature: API Validation
     And the response file should have size greater than 100
 	
 	
-  @compress @ghostscript @positive
+  @compress @qpdf @positive
   Scenario: Compress
     Given I use an example file at "exampleFiles/ghost1.pdf" as parameter "fileInput"
 	And the request data includes
@@ -218,6 +180,28 @@ Feature: API Validation
    |  .odt   | 
    |  .pptx   | 
    |  .rtf   | 
-
-
 		
+  @calibre @positive @htmltopdf
+  Scenario: Convert HTML to PDF
+  Given I use an example file at "exampleFiles/example.html" as parameter "fileInput"
+  When I send the API request to the endpoint "/api/v1/convert/html/pdf"
+  Then the response status code should be 200
+  And the response file should have size greater than 100
+  And the response file should have extension ".pdf"
+  
+  @calibre @positive @zippedhtmltopdf
+  Scenario: Convert zipped HTML to PDF
+  Given I use an example file at "exampleFiles/example_html.zip" as parameter "fileInput"
+  When I send the API request to the endpoint "/api/v1/convert/html/pdf"
+  Then the response status code should be 200
+  And the response file should have size greater than 100
+  And the response file should have extension ".pdf"
+  
+  @calibre @positive @markdowntopdf
+  Scenario: Convert Markdown to PDF
+  Given I use an example file at "exampleFiles/example.md" as parameter "fileInput"
+  When I send the API request to the endpoint "/api/v1/convert/markdown/pdf"
+  Then the response status code should be 200
+  And the response file should have size greater than 100
+  And the response file should have extension ".pdf"
+  

cucumber/features/general.feature

@@ -95,7 +95,7 @@ Feature: API Validation
 
 
   @extract-images
-  Scenario Outline: Extract Image Scans
+  Scenario Outline: Extract Image Scans duplicates
     Given I use an example file at "exampleFiles/images.pdf" as parameter "fileInput"
     And the request data includes
       | parameter        | value       |
@@ -103,7 +103,7 @@ Feature: API Validation
     When I send the API request to the endpoint "/api/v1/misc/extract-images"
     Then the response content type should be "application/octet-stream"
 	And the response file should have extension ".zip"
-	And the response ZIP should contain 20 files
+	And the response ZIP should contain 2 files
     And the response file should have size greater than 0
 	And the response status code should be 200
 	
@@ -112,5 +112,3 @@ Feature: API Validation
     | png        | 
     | gif         |
     | jpeg        | 
-
-	

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

@@ -1,14 +1,13 @@
-version: '3.3'
 services:
   stirling-pdf:
     container_name: Stirling-PDF-Security-Fat
-    image: frooodle/s-pdf:latest-fat
+    image: stirlingtools/stirling-pdf:latest-fat
     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'"]
+      test: ["CMD-SHELL", "curl -f http://localhost:8080/api/v1/info/status | grep -q 'UP'"]
       interval: 5s
       timeout: 10s
       retries: 16
@@ -20,7 +19,7 @@ services:
       - /stirling/latest/logs:/logs:rw
     environment:
       DOCKER_ENABLE_SECURITY: "true"
-      SECURITY_ENABLELOGIN: "true"
+      SECURITY_ENABLELOGIN: "false"
       PUID: 1002
       PGID: 1002
       UMASK: "022"

exampleYmlFiles/docker-compose-latest-security-with-sso.yml

@@ -1,8 +1,7 @@
-version: '3.3'
 services:
   stirling-pdf:
     container_name: Stirling-PDF-Security
-    image: frooodle/s-pdf:latest
+    image: stirlingtools/stirling-pdf:latest
     deploy:
       resources:
         limits:

exampleYmlFiles/docker-compose-latest-security.yml

@@ -1,8 +1,7 @@
-version: '3.3'
 services:
   stirling-pdf:
     container_name: Stirling-PDF-Security
-    image: frooodle/s-pdf:latest
+    image: stirlingtools/stirling-pdf:latest
     deploy:
       resources:
         limits:

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

@@ -1,8 +1,7 @@
-version: '3.3'
 services:
   stirling-pdf:
     container_name: Stirling-PDF-Ultra-Lite-Security
-    image: frooodle/s-pdf:latest-ultra-lite
+    image: stirlingtools/stirling-pdf:latest-ultra-lite
     deploy:
       resources:
         limits:

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

@@ -1,8 +1,7 @@
-version: '3.3'
 services:
   stirling-pdf:
     container_name: Stirling-PDF-Ultra-Lite
-    image: frooodle/s-pdf:latest-ultra-lite
+    image: stirlingtools/stirling-pdf:latest-ultra-lite
     deploy:
       resources:
         limits:

exampleYmlFiles/docker-compose-latest.yml

@@ -1,8 +1,7 @@
-version: '3.3'
 services:
   stirling-pdf:
     container_name: Stirling-PDF
-    image: frooodle/s-pdf:latest
+    image: stirlingtools/stirling-pdf:latest
     deploy:
       resources:
         limits:

gradle/wrapper/gradle-wrapper.properties

@@ -1,5 +1,5 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.7-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.11-bin.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

scripts/ignore_translation.toml

@@ -3,6 +3,11 @@ ignore = [
     'language.direction',
 ]
 
+[az_AZ]
+ignore = [
+    'language.direction',
+]
+
 [bg_BG]
 ignore = [
     'language.direction',
@@ -13,13 +18,11 @@ ignore = [
     'PDFToText.tags',
     'adminUserSettings.admin',
     'language.direction',
-    'survey.button',
     'watermark.type.1',
 ]
 
 [cs_CZ]
 ignore = [
-    'info',
     'language.direction',
     'pipeline.header',
     'text',
@@ -39,10 +42,12 @@ ignore = [
     'addPageNumbers.selectText.3',
     'alphabet',
     'certSign.name',
+    'home.pipeline.title',
     'language.direction',
     'licenses.version',
     'pipeline.title',
     'pipelineOptions.pipelineHeader',
+    'pro',
     'sponsor',
     'text',
     'watermark.type.1',
@@ -79,7 +84,6 @@ ignore = [
     'alphabet',
     'compare.document.1',
     'compare.document.2',
-    'info',
     'language.direction',
     'licenses.license',
     'licenses.module',
@@ -87,8 +91,6 @@ ignore = [
     'licenses.version',
     'pdfOrganiser.mode',
     'pipeline.title',
-    'pipelineOptions.pipelineHeader',
-    'sponsor',
     'watermark.type.2',
 ]
 
@@ -105,11 +107,8 @@ ignore = [
 [hr_HR]
 ignore = [
     'PDFToBook.selectText.1',
-    'font',
     'home.pipeline.title',
-    'info',
     'language.direction',
-    'pdfOrganiser.tags',
     'showJS.tags',
 ]
 
@@ -125,7 +124,6 @@ ignore = [
 
 [it_IT]
 ignore = [
-    'font',
     'language.direction',
     'no',
     'password',
@@ -148,18 +146,10 @@ ignore = [
 
 [nl_NL]
 ignore = [
-    'HTMLToPDF.print',
-    'adjustContrast.contrast',
     'compare.document.1',
     'compare.document.2',
-    'error',
-    'getPdfInfo.downloadJson',
-    'help',
-    'info',
     'language.direction',
     'navbar.allTools',
-    'printFile.submit',
-    'showJS.downloadJS',
     'sponsor',
 ]
 
@@ -181,7 +171,6 @@ ignore = [
 
 [pt_BR]
 ignore = [
-    'changeMetadata.trapped',
     'language.direction',
     'pipelineOptions.pipelineHeader',
 ]
@@ -227,7 +216,6 @@ ignore = [
 [th_TH]
 ignore = [
     'language.direction',
-    'pipeline.title',
     'pipelineOptions.pipelineHeader',
     'showJS.tags',
 ]

scripts/remove_translation_keys.sh

@@ -0,0 +1,20 @@
+#!/bin/bash
+
+# Check if a key was provided
+if [ $# -eq 0 ]; then
+    echo "Please provide a key to remove."
+    exit 1
+fi
+
+key_to_remove="$1"
+
+for file in ../src/main/resources/messages_*.properties; do
+    # If the key ends with a dot, remove all keys starting with it
+    if [[ "$key_to_remove" == *. ]]; then
+        sed -i "/^${key_to_remove//./\\.}/d" "$file"
+    else
+        # Otherwise, remove only the exact key match
+        sed -i "/^${key_to_remove//./\\.}=/d" "$file"
+    fi
+    echo "Updated $file"
+done

scripts/replace_translation_line.sh

@@ -0,0 +1,10 @@
+#!/bin/bash
+
+translation_key="pdfToPDFA.credit"
+old_value="qpdf"
+new_value="liibreoffice"
+
+for file in ../src/main/resources/messages_*.properties; do
+  sed -i "/^$translation_key=/s/$old_value/$new_value/" "$file"
+  echo "Updated $file"
+done

src/main/java/stirling/software/SPDF/EE/EEAppConfig.java

@@ -0,0 +1,24 @@
+package stirling.software.SPDF.EE;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.core.Ordered;
+import org.springframework.core.annotation.Order;
+
+import lombok.extern.slf4j.Slf4j;
+import stirling.software.SPDF.model.ApplicationProperties;
+
+@Configuration
+@Order(Ordered.HIGHEST_PRECEDENCE)
+@Slf4j
+public class EEAppConfig {
+
+    @Autowired ApplicationProperties applicationProperties;
+    @Autowired private LicenseKeyChecker licenseKeyChecker;
+
+    @Bean(name = "runningEE")
+    public boolean runningEnterpriseEdition() {
+        return licenseKeyChecker.getEnterpriseEnabledResult();
+    }
+}

src/main/java/stirling/software/SPDF/EE/KeygenLicenseVerifier.java

@@ -0,0 +1,204 @@
+package stirling.software.SPDF.EE;
+
+import java.net.URI;
+import java.net.http.HttpClient;
+import java.net.http.HttpRequest;
+import java.net.http.HttpResponse;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.stereotype.Service;
+
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.posthog.java.shaded.org.json.JSONObject;
+
+import lombok.extern.slf4j.Slf4j;
+import stirling.software.SPDF.model.ApplicationProperties;
+import stirling.software.SPDF.utils.GeneralUtils;
+
+@Service
+@Slf4j
+public class KeygenLicenseVerifier {
+    private static final String ACCOUNT_ID = "e5430f69-e834-4ae4-befd-b602aae5f372";
+    private static final String BASE_URL = "https://api.keygen.sh/v1/accounts";
+    private static final ObjectMapper objectMapper = new ObjectMapper();
+
+    private final ApplicationProperties applicationProperties;
+
+    @Autowired
+    public KeygenLicenseVerifier(ApplicationProperties applicationProperties) {
+        this.applicationProperties = applicationProperties;
+    }
+
+    public boolean verifyLicense(String licenseKey) {
+        try {
+            log.info("Checking license key");
+            String machineFingerprint = generateMachineFingerprint();
+
+            // First, try to validate the license
+            JsonNode validationResponse = validateLicense(licenseKey, machineFingerprint);
+            if (validationResponse != null) {
+                boolean isValid = validationResponse.path("meta").path("valid").asBoolean();
+                String licenseId = validationResponse.path("data").path("id").asText();
+                if (!isValid) {
+                    String code = validationResponse.path("meta").path("code").asText();
+                    log.debug(code);
+                    if ("NO_MACHINE".equals(code)
+                            || "NO_MACHINES".equals(code)
+                            || "FINGERPRINT_SCOPE_MISMATCH".equals(code)) {
+                        log.info(
+                                "License not activated for this machine. Attempting to activate...");
+                        boolean activated =
+                                activateMachine(licenseKey, licenseId, machineFingerprint);
+                        if (activated) {
+                            // Revalidate after activation
+                            validationResponse = validateLicense(licenseKey, machineFingerprint);
+                            isValid =
+                                    validationResponse != null
+                                            && validationResponse
+                                                    .path("meta")
+                                                    .path("valid")
+                                                    .asBoolean();
+                        }
+                    }
+                }
+                return isValid;
+            }
+
+            return false;
+        } catch (Exception e) {
+            log.error("Error verifying license: " + e.getMessage());
+            return false;
+        }
+    }
+
+    private JsonNode validateLicense(String licenseKey, String machineFingerprint)
+            throws Exception {
+        HttpClient client = HttpClient.newHttpClient();
+        String requestBody =
+                String.format(
+                        "{\"meta\":{\"key\":\"%s\",\"scope\":{\"fingerprint\":\"%s\"}}}",
+                        licenseKey, machineFingerprint);
+        HttpRequest request =
+                HttpRequest.newBuilder()
+                        .uri(
+                                URI.create(
+                                        BASE_URL
+                                                + "/"
+                                                + ACCOUNT_ID
+                                                + "/licenses/actions/validate-key"))
+                        .header("Content-Type", "application/vnd.api+json")
+                        .header("Accept", "application/vnd.api+json")
+                        // .header("Authorization", "License " + licenseKey)
+                        .POST(HttpRequest.BodyPublishers.ofString(requestBody))
+                        .build();
+
+        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
+        log.info(" validateLicenseResponse body: " + response.body());
+        JsonNode jsonResponse = objectMapper.readTree(response.body());
+        if (response.statusCode() == 200) {
+
+            JsonNode metaNode = jsonResponse.path("meta");
+            boolean isValid = metaNode.path("valid").asBoolean();
+
+            String detail = metaNode.path("detail").asText();
+            String code = metaNode.path("code").asText();
+
+            log.debug("License validity: " + isValid);
+            log.debug("Validation detail: " + detail);
+            log.debug("Validation code: " + code);
+
+            int users =
+                    jsonResponse
+                            .path("data")
+                            .path("attributes")
+                            .path("metadata")
+                            .path("users")
+                            .asInt(0);
+            applicationProperties.getEnterpriseEdition().setMaxUsers(users);
+            log.info(applicationProperties.toString());
+
+        } else {
+            log.error("Error validating license. Status code: " + response.statusCode());
+        }
+        return jsonResponse;
+    }
+
+    private boolean activateMachine(String licenseKey, String licenseId, String machineFingerprint)
+            throws Exception {
+        HttpClient client = HttpClient.newHttpClient();
+
+        String hostname;
+        try {
+            hostname = java.net.InetAddress.getLocalHost().getHostName();
+        } catch (Exception e) {
+            hostname = "Unknown";
+        }
+
+        JSONObject body =
+                new JSONObject()
+                        .put(
+                                "data",
+                                new JSONObject()
+                                        .put("type", "machines")
+                                        .put(
+                                                "attributes",
+                                                new JSONObject()
+                                                        .put("fingerprint", machineFingerprint)
+                                                        .put(
+                                                                "platform",
+                                                                System.getProperty(
+                                                                        "os.name")) // Added
+                                                        // platform
+                                                        // parameter
+                                                        .put(
+                                                                "name",
+                                                                hostname)) // Added name parameter
+                                        .put(
+                                                "relationships",
+                                                new JSONObject()
+                                                        .put(
+                                                                "license",
+                                                                new JSONObject()
+                                                                        .put(
+                                                                                "data",
+                                                                                new JSONObject()
+                                                                                        .put(
+                                                                                                "type",
+                                                                                                "licenses")
+                                                                                        .put(
+                                                                                                "id",
+                                                                                                licenseId)))));
+
+        HttpRequest request =
+                HttpRequest.newBuilder()
+                        .uri(URI.create(BASE_URL + "/" + ACCOUNT_ID + "/machines"))
+                        .header("Content-Type", "application/vnd.api+json")
+                        .header("Accept", "application/vnd.api+json")
+                        .header(
+                                "Authorization",
+                                "License " + licenseKey) // Keep the license key authentication
+                        .POST(
+                                HttpRequest.BodyPublishers.ofString(
+                                        body.toString())) // Send the JSON body
+                        .build();
+
+        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
+        log.debug("activateMachine Response body: " + response.body());
+        if (response.statusCode() == 201) {
+            log.info("Machine activated successfully");
+            return true;
+        } else {
+            log.error(
+                    "Error activating machine. Status code: {}, error: {}",
+                    response.statusCode(),
+                    response.body());
+
+            return false;
+        }
+    }
+
+    private String generateMachineFingerprint() {
+        return GeneralUtils.generateMachineFingerprint();
+    }
+}

src/main/java/stirling/software/SPDF/EE/LicenseKeyChecker.java

@@ -0,0 +1,60 @@
+package stirling.software.SPDF.EE;
+
+import java.io.IOException;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.scheduling.annotation.Scheduled;
+import org.springframework.stereotype.Component;
+
+import lombok.extern.slf4j.Slf4j;
+import stirling.software.SPDF.model.ApplicationProperties;
+import stirling.software.SPDF.utils.GeneralUtils;
+
+@Component
+@Slf4j
+public class LicenseKeyChecker {
+
+    private final KeygenLicenseVerifier licenseService;
+
+    private final ApplicationProperties applicationProperties;
+
+    private boolean enterpriseEnbaledResult = false;
+
+    @Autowired
+    public LicenseKeyChecker(
+            KeygenLicenseVerifier licenseService, ApplicationProperties applicationProperties) {
+        this.licenseService = licenseService;
+        this.applicationProperties = applicationProperties;
+        this.checkLicense();
+    }
+
+    @Scheduled(fixedRate = 604800000) // 7 days in milliseconds
+    public void checkLicensePeriodically() {
+        checkLicense();
+    }
+
+    private void checkLicense() {
+        if (!applicationProperties.getEnterpriseEdition().isEnabled()) {
+            enterpriseEnbaledResult = false;
+        } else {
+            enterpriseEnbaledResult =
+                    licenseService.verifyLicense(
+                            applicationProperties.getEnterpriseEdition().getKey());
+            if (enterpriseEnbaledResult) {
+                log.info("License key is valid.");
+            } else {
+                log.info("License key is invalid.");
+            }
+        }
+    }
+
+    public void updateLicenseKey(String newKey) throws IOException {
+        applicationProperties.getEnterpriseEdition().setKey(newKey);
+        GeneralUtils.saveKeyToConfig("EnterpriseEdition.key", newKey, false);
+        checkLicense();
+    }
+
+    public boolean getEnterpriseEnabledResult() {
+        return enterpriseEnbaledResult;
+    }
+}

src/main/java/stirling/software/SPDF/Factories/ReplaceAndInvertColorFactory.java

@@ -0,0 +1,39 @@
+package stirling.software.SPDF.Factories;
+
+import org.springframework.stereotype.Component;
+import org.springframework.web.multipart.MultipartFile;
+
+import stirling.software.SPDF.model.api.misc.HighContrastColorCombination;
+import stirling.software.SPDF.model.api.misc.ReplaceAndInvert;
+import stirling.software.SPDF.utils.misc.CustomColorReplaceStrategy;
+import stirling.software.SPDF.utils.misc.InvertFullColorStrategy;
+import stirling.software.SPDF.utils.misc.ReplaceAndInvertColorStrategy;
+
+@Component
+public class ReplaceAndInvertColorFactory {
+
+    public ReplaceAndInvertColorStrategy replaceAndInvert(
+            MultipartFile file,
+            ReplaceAndInvert replaceAndInvertOption,
+            HighContrastColorCombination highContrastColorCombination,
+            String backGroundColor,
+            String textColor) {
+
+        if (replaceAndInvertOption == ReplaceAndInvert.CUSTOM_COLOR
+                || replaceAndInvertOption == ReplaceAndInvert.HIGH_CONTRAST_COLOR) {
+
+            return new CustomColorReplaceStrategy(
+                    file,
+                    replaceAndInvertOption,
+                    textColor,
+                    backGroundColor,
+                    highContrastColorCombination);
+
+        } else if (replaceAndInvertOption == ReplaceAndInvert.FULL_INVERSION) {
+
+            return new InvertFullColorStrategy(file, replaceAndInvertOption);
+        }
+
+        return null;
+    }
+}

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

@@ -11,6 +11,9 @@ import org.slf4j.LoggerFactory;
 
 import io.github.pixee.security.SystemCommand;
 
+import lombok.extern.slf4j.Slf4j;
+
+@Slf4j
 public class LibreOfficeListener {
 
     private static final Logger logger = LoggerFactory.getLogger(LibreOfficeListener.class);
@@ -31,7 +34,7 @@ public class LibreOfficeListener {
     private LibreOfficeListener() {}
 
     private boolean isListenerRunning() {
-        System.out.println("waiting for listener to start");
+        log.info("waiting for listener to start");
         try (Socket socket = new Socket()) {
             socket.connect(
                     new InetSocketAddress("localhost", 2002), 1000); // Timeout after 1 second

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

@@ -1,6 +1,7 @@
 package stirling.software.SPDF;
 
 import java.io.IOException;
+import java.net.ServerSocket;
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.Paths;
@@ -30,30 +31,61 @@ public class SPdfApplication {
     private static final Logger logger = LoggerFactory.getLogger(SPdfApplication.class);
 
     @Autowired private Environment env;
-
     @Autowired ApplicationProperties applicationProperties;
 
+    private static String baseUrlStatic;
     private static String serverPortStatic;
 
+    @Value("${baseUrl:http://localhost}")
+    private String baseUrl;
+
     @Value("${server.port:8080}")
     public void setServerPortStatic(String port) {
-        SPdfApplication.serverPortStatic = port;
+        if ("auto".equalsIgnoreCase(port)) {
+            // Use Spring Boot's automatic port assignment (server.port=0)
+            SPdfApplication.serverPortStatic =
+                    "0"; // This will let Spring Boot assign an available port
+        } else {
+            SPdfApplication.serverPortStatic = port;
+        }
+    }
+
+    // Optionally keep this method if you want to provide a manual port-incrementation fallback.
+    private static String findAvailablePort(int startPort) {
+        int port = startPort;
+        while (!isPortAvailable(port)) {
+            port++;
+        }
+        return String.valueOf(port);
+    }
+
+    private static boolean isPortAvailable(int port) {
+        try (ServerSocket socket = new ServerSocket(port)) {
+            return true;
+        } catch (IOException e) {
+            return false;
+        }
     }
 
     @PostConstruct
     public void init() {
+        baseUrlStatic = this.baseUrl;
         // Check if the BROWSER_OPEN environment variable is set to true
         String browserOpenEnv = env.getProperty("BROWSER_OPEN");
         boolean browserOpen = browserOpenEnv != null && "true".equalsIgnoreCase(browserOpenEnv);
         if (browserOpen) {
             try {
-                String url = "http://localhost:" + getNonStaticPort();
+                String url = baseUrl + ":" + getStaticPort();
 
                 String os = System.getProperty("os.name").toLowerCase();
                 Runtime rt = Runtime.getRuntime();
                 if (os.contains("win")) {
                     // For Windows
                     SystemCommand.runCommand(rt, "rundll32 url.dll,FileProtocolHandler " + url);
+                } else if (os.contains("mac")) {
+                    SystemCommand.runCommand(rt, "open " + url);
+                } else if (os.contains("nix") || os.contains("nux")) {
+                    SystemCommand.runCommand(rt, "xdg-open " + url);
                 }
             } catch (Exception e) {
                 logger.error("Error opening browser: {}", e.getMessage());
@@ -65,18 +97,17 @@ public class SPdfApplication {
     public static void main(String[] args) throws IOException, InterruptedException {
 
         SpringApplication app = new SpringApplication(SPdfApplication.class);
+        app.setAdditionalProfiles("default");
         app.addInitializers(new ConfigInitializer());
         Map<String, String> propertyFiles = new HashMap<>();
 
-        // stirling pdf settings file
+        // External config files
         if (Files.exists(Paths.get("configs/settings.yml"))) {
             propertyFiles.put("spring.config.additional-location", "file:configs/settings.yml");
         } else {
-            logger.warn(
-                    "External configuration file 'configs/settings.yml' does not exist. Using default configuration and environment configuration instead.");
+            logger.warn("External configuration file 'configs/settings.yml' does not exist.");
         }
 
-        // custom javs settings file
         if (Files.exists(Paths.get("configs/custom_settings.yml"))) {
             String existingLocation =
                     propertyFiles.getOrDefault("spring.config.additional-location", "");
@@ -99,28 +130,31 @@ public class SPdfApplication {
 
         app.run(args);
 
-        try {
-            Thread.sleep(1000);
-        } catch (InterruptedException e) {
-            Thread.currentThread().interrupt();
-            throw new RuntimeException("Thread interrupted while sleeping", e);
-        }
-
+        // Ensure directories are created
         try {
             Files.createDirectories(Path.of("customFiles/static/"));
             Files.createDirectories(Path.of("customFiles/templates/"));
         } catch (Exception e) {
             logger.error("Error creating directories: {}", e.getMessage());
         }
+
         printStartupLogs();
     }
 
     private static void printStartupLogs() {
         logger.info("Stirling-PDF Started.");
-        String url = "http://localhost:" + getStaticPort();
+        String url = baseUrlStatic + ":" + getStaticPort();
         logger.info("Navigate to {}", url);
     }
 
+    public static String getStaticBaseUrl() {
+        return baseUrlStatic;
+    }
+
+    public String getNonStaticBaseUrl() {
+        return baseUrlStatic;
+    }
+
     public static String getStaticPort() {
         return serverPortStatic;
     }

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

@@ -15,6 +15,7 @@ import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.Lazy;
+import org.springframework.context.annotation.Scope;
 import org.springframework.core.io.ClassPathResource;
 import org.springframework.core.io.Resource;
 import org.springframework.core.io.ResourceLoader;
@@ -126,14 +127,63 @@ public class AppConfig {
     }
 
     @Bean(name = "directoryFilter")
-    public Predicate<Path> processPDFOnlyFilter() {
+    public Predicate<Path> processOnlyFiles() {
         return path -> {
             if (Files.isDirectory(path)) {
                 return !path.toString().contains("processing");
             } else {
-                String fileName = path.getFileName().toString();
-                return fileName.endsWith(".pdf");
+                return true;
             }
         };
     }
+
+    @Bean(name = "termsAndConditions")
+    public String termsAndConditions() {
+        return applicationProperties.getLegal().getTermsAndConditions();
+    }
+
+    @Bean(name = "privacyPolicy")
+    public String privacyPolicy() {
+        return applicationProperties.getLegal().getPrivacyPolicy();
+    }
+
+    @Bean(name = "cookiePolicy")
+    public String cookiePolicy() {
+        return applicationProperties.getLegal().getCookiePolicy();
+    }
+
+    @Bean(name = "impressum")
+    public String impressum() {
+        return applicationProperties.getLegal().getImpressum();
+    }
+
+    @Bean(name = "accessibilityStatement")
+    public String accessibilityStatement() {
+        return applicationProperties.getLegal().getAccessibilityStatement();
+    }
+
+    @Bean(name = "analyticsPrompt")
+    @Scope("request")
+    public boolean analyticsPrompt() {
+        return applicationProperties.getSystem().getEnableAnalytics() == null
+                || "undefined".equals(applicationProperties.getSystem().getEnableAnalytics());
+    }
+
+    @Bean(name = "analyticsEnabled")
+    @Scope("request")
+    public boolean analyticsEnabled() {
+        if (applicationProperties.getEnterpriseEdition().isEnabled()) return true;
+        return applicationProperties.getSystem().getEnableAnalytics() != null
+                && Boolean.parseBoolean(applicationProperties.getSystem().getEnableAnalytics());
+    }
+
+    @Bean(name = "StirlingPDFLabel")
+    public String stirlingPDFLabel() {
+        return "Stirling-PDF" + " v" + appVersion();
+    }
+
+    @Bean(name = "UUID")
+    public String uuid() {
+        return applicationProperties.getAutomaticallyGenerated().getUUID();
+    }
 }

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

@@ -5,6 +5,7 @@ import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Scope;
 import org.springframework.stereotype.Service;
 
+import stirling.software.SPDF.config.interfaces.ShowAdminInterface;
 import stirling.software.SPDF.model.ApplicationProperties;
 
 @Service
@@ -18,7 +19,7 @@ class AppUpdateService {
     @Bean(name = "shouldShow")
     @Scope("request")
     public boolean shouldShow() {
-        boolean showUpdate = applicationProperties.getSystem().getShowUpdate();
+        boolean showUpdate = applicationProperties.getSystem().isShowUpdate();
         boolean showAdminResult = (showAdmin != null) ? showAdmin.getShowUpdateOnlyAdmins() : true;
         return showUpdate && showAdminResult;
     }

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

@@ -5,6 +5,7 @@ import java.util.List;
 import java.util.Map;
 import java.util.Set;
 import java.util.concurrent.ConcurrentHashMap;
+import java.util.stream.Collectors;
 
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -42,7 +43,7 @@ public class EndpointConfiguration {
 
     public void disableEndpoint(String endpoint) {
         if (!endpointStatuses.containsKey(endpoint) || endpointStatuses.get(endpoint) != false) {
-            logger.info("Disabling {}", endpoint);
+            logger.debug("Disabling {}", endpoint);
             endpointStatuses.put(endpoint, false);
         }
     }
@@ -76,6 +77,23 @@ public class EndpointConfiguration {
         }
     }
 
+    public void logDisabledEndpointsSummary() {
+        List<String> disabledList =
+                endpointStatuses.entrySet().stream()
+                        .filter(entry -> !entry.getValue()) // only get disabled endpoints (value
+                        // is false)
+                        .map(Map.Entry::getKey)
+                        .sorted()
+                        .collect(Collectors.toList());
+
+        if (!disabledList.isEmpty()) {
+            logger.info(
+                    "Total disabled endpoints: {}. Disabled endpoints: {}",
+                    disabledList.size(),
+                    String.join(", ", disabledList));
+        }
+    }
+
     public void init() {
         // Adding endpoints to "PageOps" group
         addEndpointToGroup("PageOps", "remove-pages");
@@ -99,7 +117,6 @@ public class EndpointConfiguration {
         addEndpointToGroup("Convert", "img-to-pdf");
         addEndpointToGroup("Convert", "pdf-to-pdfa");
         addEndpointToGroup("Convert", "file-to-pdf");
-        addEndpointToGroup("Convert", "xlsx-to-pdf");
         addEndpointToGroup("Convert", "pdf-to-word");
         addEndpointToGroup("Convert", "pdf-to-presentation");
         addEndpointToGroup("Convert", "pdf-to-text");
@@ -145,7 +162,6 @@ public class EndpointConfiguration {
         addEndpointToGroup("CLI", "repair");
         addEndpointToGroup("CLI", "pdf-to-pdfa");
         addEndpointToGroup("CLI", "file-to-pdf");
-        addEndpointToGroup("CLI", "xlsx-to-pdf");
         addEndpointToGroup("CLI", "pdf-to-word");
         addEndpointToGroup("CLI", "pdf-to-presentation");
         addEndpointToGroup("CLI", "pdf-to-html");
@@ -163,29 +179,31 @@ public class EndpointConfiguration {
 
         // python
         addEndpointToGroup("Python", "extract-image-scans");
-        addEndpointToGroup("Python", REMOVE_BLANKS);
         addEndpointToGroup("Python", "html-to-pdf");
         addEndpointToGroup("Python", "url-to-pdf");
         addEndpointToGroup("Python", "pdf-to-img");
+        addEndpointToGroup("Python", "file-to-pdf");
 
         // openCV
         addEndpointToGroup("OpenCV", "extract-image-scans");
-        addEndpointToGroup("OpenCV", REMOVE_BLANKS);
 
         // LibreOffice
-        addEndpointToGroup("LibreOffice", "repair");
+        addEndpointToGroup("qpdf", "repair");
         addEndpointToGroup("LibreOffice", "file-to-pdf");
-        addEndpointToGroup("LibreOffice", "xlsx-to-pdf");
         addEndpointToGroup("LibreOffice", "pdf-to-word");
         addEndpointToGroup("LibreOffice", "pdf-to-presentation");
         addEndpointToGroup("LibreOffice", "pdf-to-rtf");
         addEndpointToGroup("LibreOffice", "pdf-to-html");
         addEndpointToGroup("LibreOffice", "pdf-to-xml");
 
-        // OCRmyPDF
-        addEndpointToGroup("OCRmyPDF", "compress-pdf");
-        addEndpointToGroup("OCRmyPDF", "pdf-to-pdfa");
-        addEndpointToGroup("OCRmyPDF", "ocr-pdf");
+        // Unoconv
+        addEndpointToGroup("Unoconv", "file-to-pdf");
+
+        // qpdf
+        addEndpointToGroup("qpdf", "compress-pdf");
+        addEndpointToGroup("qpdf", "pdf-to-pdfa");
+
+        addEndpointToGroup("tesseract", "ocr-pdf");
 
         // Java
         addEndpointToGroup("Java", "merge-pdfs");
@@ -230,6 +248,18 @@ public class EndpointConfiguration {
         addEndpointToGroup("Javascript", "sign");
         addEndpointToGroup("Javascript", "compare");
         addEndpointToGroup("Javascript", "adjust-contrast");
+
+        // qpdf dependent endpoints
+        addEndpointToGroup("qpdf", "compress-pdf");
+        addEndpointToGroup("qpdf", "pdf-to-pdfa");
+        addEndpointToGroup("qpdf", "repair");
+
+        // Weasyprint dependent endpoints
+        addEndpointToGroup("Weasyprint", "html-to-pdf");
+        addEndpointToGroup("Weasyprint", "url-to-pdf");
+
+        // Pdftohtml dependent endpoints
+        addEndpointToGroup("Pdftohtml", "pdf-to-html");
     }
 
     private void processEnvironmentConfigs() {
@@ -251,5 +281,9 @@ public class EndpointConfiguration {
         }
     }
 
+    public Set<String> getEndpointsForGroup(String group) {
+        return endpointGroups.getOrDefault(group, new HashSet<>());
+    }
+
     private static final String REMOVE_BLANKS = "remove-blanks";
 }

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

@@ -0,0 +1,148 @@
+package stirling.software.SPDF.config;
+
+import java.util.Arrays;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.stream.Collectors;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.context.annotation.Configuration;
+
+import jakarta.annotation.PostConstruct;
+import lombok.extern.slf4j.Slf4j;
+
+@Configuration
+@Slf4j
+public class ExternalAppDepConfig {
+    @Autowired private EndpointConfiguration endpointConfiguration;
+
+    private boolean isCommandAvailable(String command) {
+        try {
+            ProcessBuilder processBuilder = new ProcessBuilder();
+            if (System.getProperty("os.name").toLowerCase().contains("windows")) {
+                processBuilder.command("where", command);
+            } else {
+                processBuilder.command("which", command);
+            }
+            Process process = processBuilder.start();
+            int exitCode = process.waitFor();
+            return exitCode == 0;
+        } catch (Exception e) {
+            log.debug("Error checking for command {}: {}", command, e.getMessage());
+            return false;
+        }
+    }
+
+    private final Map<String, List<String>> commandToGroupMapping =
+            new HashMap<>() {
+                {
+                    put("soffice", List.of("LibreOffice"));
+                    put("weasyprint", List.of("Weasyprint"));
+                    put("pdftohtml", List.of("Pdftohtml"));
+                    put("unoconv", List.of("Unoconv"));
+                    put("qpdf", List.of("qpdf"));
+                    put("tesseract", List.of("tesseract"));
+                }
+            };
+
+    private List<String> getAffectedFeatures(String group) {
+        return endpointConfiguration.getEndpointsForGroup(group).stream()
+                .map(endpoint -> formatEndpointAsFeature(endpoint))
+                .collect(Collectors.toList());
+    }
+
+    private String formatEndpointAsFeature(String endpoint) {
+        // First replace common terms
+        String feature = endpoint.replace("-", " ").replace("pdf", "PDF").replace("img", "image");
+
+        // Split into words and capitalize each word
+        return Arrays.stream(feature.split("\\s+"))
+                .map(word -> capitalizeWord(word))
+                .collect(Collectors.joining(" "));
+    }
+
+    private String capitalizeWord(String word) {
+        if (word.isEmpty()) {
+            return word;
+        }
+        if ("pdf".equalsIgnoreCase(word)) {
+            return "PDF";
+        }
+        return word.substring(0, 1).toUpperCase() + word.substring(1).toLowerCase();
+    }
+
+    private void checkDependencyAndDisableGroup(String command) {
+        boolean isAvailable = isCommandAvailable(command);
+        if (!isAvailable) {
+            List<String> affectedGroups = commandToGroupMapping.get(command);
+
+            if (affectedGroups != null) {
+                for (String group : affectedGroups) {
+                    List<String> affectedFeatures = getAffectedFeatures(group);
+                    endpointConfiguration.disableGroup(group);
+                    log.warn(
+                            "Missing dependency: {} - Disabling group: {} (Affected features: {})",
+                            command,
+                            group,
+                            affectedFeatures != null && !affectedFeatures.isEmpty()
+                                    ? String.join(", ", affectedFeatures)
+                                    : "unknown");
+                }
+            }
+        }
+    }
+
+    @PostConstruct
+    public void checkDependencies() {
+
+        // Check core dependencies
+        checkDependencyAndDisableGroup("tesseract");
+        checkDependencyAndDisableGroup("soffice");
+        checkDependencyAndDisableGroup("qpdf");
+        checkDependencyAndDisableGroup("weasyprint");
+        checkDependencyAndDisableGroup("pdftohtml");
+        checkDependencyAndDisableGroup("unoconv");
+
+        // Special handling for Python/OpenCV dependencies
+        boolean pythonAvailable = isCommandAvailable("python3") || isCommandAvailable("python");
+        if (!pythonAvailable) {
+            List<String> pythonFeatures = getAffectedFeatures("Python");
+            List<String> openCVFeatures = getAffectedFeatures("OpenCV");
+
+            endpointConfiguration.disableGroup("Python");
+            endpointConfiguration.disableGroup("OpenCV");
+            log.warn(
+                    "Missing dependency: Python - Disabling Python features: {} and OpenCV features: {}",
+                    String.join(", ", pythonFeatures),
+                    String.join(", ", openCVFeatures));
+        } else {
+            // If Python is available, check for OpenCV
+            try {
+                ProcessBuilder processBuilder = new ProcessBuilder();
+                if (System.getProperty("os.name").toLowerCase().contains("windows")) {
+                    processBuilder.command("python", "-c", "import cv2");
+                } else {
+                    processBuilder.command("python3", "-c", "import cv2");
+                }
+                Process process = processBuilder.start();
+                int exitCode = process.waitFor();
+                if (exitCode != 0) {
+                    List<String> openCVFeatures = getAffectedFeatures("OpenCV");
+                    endpointConfiguration.disableGroup("OpenCV");
+                    log.warn(
+                            "OpenCV not available in Python - Disabling OpenCV features: {}",
+                            String.join(", ", openCVFeatures));
+                }
+            } catch (Exception e) {
+                List<String> openCVFeatures = getAffectedFeatures("OpenCV");
+                endpointConfiguration.disableGroup("OpenCV");
+                log.warn(
+                        "Error checking OpenCV: {} - Disabling OpenCV features: {}",
+                        e.getMessage(),
+                        String.join(", ", openCVFeatures));
+            }
+        }
+        endpointConfiguration.logDisabledEndpointsSummary();
+    }
+}

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

@@ -0,0 +1,63 @@
+package stirling.software.SPDF.config;
+
+import java.io.IOException;
+import java.util.UUID;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.core.Ordered;
+import org.springframework.core.annotation.Order;
+import org.springframework.stereotype.Component;
+
+import io.micrometer.common.util.StringUtils;
+
+import jakarta.annotation.PostConstruct;
+import lombok.extern.slf4j.Slf4j;
+import stirling.software.SPDF.model.ApplicationProperties;
+import stirling.software.SPDF.utils.GeneralUtils;
+
+@Component
+@Slf4j
+@Order(Ordered.HIGHEST_PRECEDENCE + 1)
+public class InitialSetup {
+
+    @Autowired private ApplicationProperties applicationProperties;
+
+    @PostConstruct
+    public void initUUIDKey() throws IOException {
+        String uuid = applicationProperties.getAutomaticallyGenerated().getUUID();
+        if (!GeneralUtils.isValidUUID(uuid)) {
+            uuid = UUID.randomUUID().toString(); // Generating a random UUID as the secret key
+            GeneralUtils.saveKeyToConfig("AutomaticallyGenerated.UUID", uuid);
+            applicationProperties.getAutomaticallyGenerated().setUUID(uuid);
+        }
+    }
+
+    @PostConstruct
+    public void initSecretKey() throws IOException {
+        String secretKey = applicationProperties.getAutomaticallyGenerated().getKey();
+        if (!GeneralUtils.isValidUUID(secretKey)) {
+            secretKey = UUID.randomUUID().toString(); // Generating a random UUID as the secret key
+            GeneralUtils.saveKeyToConfig("AutomaticallyGenerated.key", secretKey);
+            applicationProperties.getAutomaticallyGenerated().setKey(secretKey);
+        }
+    }
+
+    @PostConstruct
+    public void initLegalUrls() throws IOException {
+        // Initialize Terms and Conditions
+        String termsUrl = applicationProperties.getLegal().getTermsAndConditions();
+        if (StringUtils.isEmpty(termsUrl)) {
+            String defaultTermsUrl = "https://www.stirlingpdf.com/terms-and-conditions";
+            GeneralUtils.saveKeyToConfig("legal.termsAndConditions", defaultTermsUrl);
+            applicationProperties.getLegal().setTermsAndConditions(defaultTermsUrl);
+        }
+
+        // Initialize Privacy Policy
+        String privacyUrl = applicationProperties.getLegal().getPrivacyPolicy();
+        if (StringUtils.isEmpty(privacyUrl)) {
+            String defaultPrivacyUrl = "https://www.stirlingpdf.com/privacy-policy";
+            GeneralUtils.saveKeyToConfig("legal.privacyPolicy", defaultPrivacyUrl);
+            applicationProperties.getLegal().setPrivacyPolicy(defaultPrivacyUrl);
+        }
+    }
+}

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

@@ -14,7 +14,7 @@ import org.springframework.web.servlet.i18n.SessionLocaleResolver;
 import stirling.software.SPDF.model.ApplicationProperties;
 
 @Configuration
-public class Beans implements WebMvcConfigurer {
+public class LocaleConfiguration implements WebMvcConfigurer {
 
     @Autowired ApplicationProperties applicationProperties;
 

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

@@ -13,6 +13,8 @@ import jakarta.servlet.FilterChain;
 import jakarta.servlet.ServletException;
 import jakarta.servlet.http.HttpServletRequest;
 import jakarta.servlet.http.HttpServletResponse;
+import jakarta.servlet.http.HttpSession;
+import stirling.software.SPDF.utils.RequestUriUtils;
 
 @Component
 public class MetricsFilter extends OncePerRequestFilter {
@@ -30,32 +32,17 @@ public class MetricsFilter extends OncePerRequestFilter {
             throws ServletException, IOException {
         String uri = request.getRequestURI();
 
-        // System.out.println("uri="+uri + ", method=" + request.getMethod() );
-        // Ignore static resources
-        if (!(uri.startsWith("/js")
-                || uri.startsWith("/v1/api-docs")
-                || uri.endsWith("robots.txt")
-                || uri.startsWith("/images")
-                || uri.endsWith(".png")
-                || uri.endsWith(".ico")
-                || uri.endsWith(".css")
-                || uri.endsWith(".map")
-                || uri.endsWith(".svg")
-                || uri.endsWith(".js")
-                || uri.contains("swagger")
-                || uri.startsWith("/api/v1/info")
-                || uri.startsWith("/site.webmanifest")
-                || uri.startsWith("/fonts")
-                || uri.startsWith("/pdfjs"))) {
-
+        if (RequestUriUtils.isTrackableResource(request.getContextPath(), uri)) {
+            HttpSession session = request.getSession(false);
+            String sessionId = (session != null) ? session.getId() : "no-session";
             Counter counter =
                     Counter.builder("http.requests")
-                            .tag("uri", uri)
+                            .tag("session", sessionId)
                             .tag("method", request.getMethod())
+                            .tag("uri", uri)
                             .register(meterRegistry);
 
             counter.increment();
-            // System.out.println("Counted");
         }
 
         filterChain.doFilter(request, response);

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

@@ -0,0 +1,34 @@
+package stirling.software.SPDF.config;
+
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+import com.posthog.java.PostHog;
+
+import jakarta.annotation.PreDestroy;
+
+@Configuration
+public class PostHogConfig {
+
+    @Value("${posthog.api.key}")
+    private String posthogApiKey;
+
+    @Value("${posthog.host}")
+    private String posthogHost;
+
+    private PostHog postHogClient;
+
+    @Bean
+    public PostHog postHogClient() {
+        postHogClient = new PostHog.Builder(posthogApiKey).host(posthogHost).build();
+        return postHogClient;
+    }
+
+    @PreDestroy
+    public void shutdownPostHog() {
+        if (postHogClient != null) {
+            postHogClient.shutdown();
+        }
+    }
+}

src/main/java/stirling/software/SPDF/config/fingerprint/FingerprintBasedSessionFilter.java

@@ -0,0 +1,68 @@
+// package stirling.software.SPDF.config.fingerprint;
+//
+// import java.io.IOException;
+//
+// import org.springframework.beans.factory.annotation.Autowired;
+// import org.springframework.stereotype.Component;
+// import org.springframework.web.filter.OncePerRequestFilter;
+//
+// import jakarta.servlet.FilterChain;
+// import jakarta.servlet.ServletException;
+// import jakarta.servlet.http.HttpServletRequest;
+// import jakarta.servlet.http.HttpServletResponse;
+// import jakarta.servlet.http.HttpSession;
+// import lombok.extern.slf4j.Slf4j;
+// import stirling.software.SPDF.utils.RequestUriUtils;
+//
+//// @Component
+// @Slf4j
+// public class FingerprintBasedSessionFilter extends OncePerRequestFilter {
+//    private final FingerprintGenerator fingerprintGenerator;
+//    private final FingerprintBasedSessionManager sessionManager;
+//
+//    @Autowired
+//    public FingerprintBasedSessionFilter(
+//            FingerprintGenerator fingerprintGenerator,
+//            FingerprintBasedSessionManager sessionManager) {
+//        this.fingerprintGenerator = fingerprintGenerator;
+//        this.sessionManager = sessionManager;
+//    }
+//
+//    @Override
+//    protected void doFilterInternal(
+//            HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)
+//            throws ServletException, IOException {
+//
+//        if (RequestUriUtils.isStaticResource(request.getContextPath(), request.getRequestURI())) {
+//            filterChain.doFilter(request, response);
+//            return;
+//        }
+//
+//        String fingerprint = fingerprintGenerator.generateFingerprint(request);
+//        log.debug("Generated fingerprint for request: {}", fingerprint);
+//
+//        HttpSession session = request.getSession();
+//        boolean isNewSession = session.isNew();
+//        String sessionId = session.getId();
+//
+//        if (isNewSession) {
+//            log.info("New session created: {}", sessionId);
+//        }
+//
+//        if (!sessionManager.isFingerPrintAllowed(fingerprint)) {
+//            log.info("Blocked fingerprint detected, redirecting: {}", fingerprint);
+//            response.sendRedirect(request.getContextPath() + "/too-many-requests");
+//            return;
+//        }
+//
+//        session.setAttribute("userFingerprint", fingerprint);
+//        session.setAttribute(
+//                FingerprintBasedSessionManager.STARTUP_TIMESTAMP,
+//                FingerprintBasedSessionManager.APP_STARTUP_TIME);
+//
+//        sessionManager.registerFingerprint(fingerprint, sessionId);
+//
+//        log.debug("Proceeding with request: {}", request.getRequestURI());
+//        filterChain.doFilter(request, response);
+//    }
+// }

src/main/java/stirling/software/SPDF/config/fingerprint/FingerprintBasedSessionManager.java

@@ -0,0 +1,134 @@
+// package stirling.software.SPDF.config.fingerprint;
+//
+// import java.util.Iterator;
+// import java.util.Map;
+// import java.util.concurrent.ConcurrentHashMap;
+// import java.util.concurrent.TimeUnit;
+//
+// import org.springframework.scheduling.annotation.Scheduled;
+// import org.springframework.stereotype.Component;
+//
+// import jakarta.servlet.http.HttpSession;
+// import jakarta.servlet.http.HttpSessionAttributeListener;
+// import jakarta.servlet.http.HttpSessionEvent;
+// import jakarta.servlet.http.HttpSessionListener;
+// import lombok.AllArgsConstructor;
+// import lombok.Data;
+// import lombok.extern.slf4j.Slf4j;
+//
+// @Slf4j
+// @Component
+// public class FingerprintBasedSessionManager
+//        implements HttpSessionListener, HttpSessionAttributeListener {
+//    private static final ConcurrentHashMap<String, FingerprintInfo> activeFingerprints =
+//            new ConcurrentHashMap<>();
+//
+//    // To be reduced in later version to 8~
+//    private static final int MAX_ACTIVE_FINGERPRINTS = 30;
+//
+//    static final String STARTUP_TIMESTAMP = "appStartupTimestamp";
+//    static final long APP_STARTUP_TIME = System.currentTimeMillis();
+//    private static final long FINGERPRINT_EXPIRATION = TimeUnit.MINUTES.toMillis(30);
+//
+//    @Override
+//    public void sessionCreated(HttpSessionEvent se) {
+//        HttpSession session = se.getSession();
+//        String sessionId = session.getId();
+//        String fingerprint = (String) session.getAttribute("userFingerprint");
+//
+//        if (fingerprint == null) {
+//            log.warn("Session created without fingerprint: {}", sessionId);
+//            return;
+//        }
+//
+//        synchronized (activeFingerprints) {
+//            if (activeFingerprints.size() >= MAX_ACTIVE_FINGERPRINTS
+//                    && !activeFingerprints.containsKey(fingerprint)) {
+//                log.info("Max fingerprints reached. Marking session as blocked: {}", sessionId);
+//                session.setAttribute("blocked", true);
+//            } else {
+//                activeFingerprints.put(
+//                        fingerprint, new FingerprintInfo(sessionId, System.currentTimeMillis()));
+//                log.info(
+//                        "New fingerprint registered: {}. Total active fingerprints: {}",
+//                        fingerprint,
+//                        activeFingerprints.size());
+//            }
+//            session.setAttribute(STARTUP_TIMESTAMP, APP_STARTUP_TIME);
+//        }
+//    }
+//
+//    @Override
+//    public void sessionDestroyed(HttpSessionEvent se) {
+//        HttpSession session = se.getSession();
+//        String fingerprint = (String) session.getAttribute("userFingerprint");
+//
+//        if (fingerprint != null) {
+//            synchronized (activeFingerprints) {
+//                activeFingerprints.remove(fingerprint);
+//                log.info(
+//                        "Fingerprint removed: {}. Total active fingerprints: {}",
+//                        fingerprint,
+//                        activeFingerprints.size());
+//            }
+//        }
+//    }
+//
+//    public boolean isFingerPrintAllowed(String fingerprint) {
+//        synchronized (activeFingerprints) {
+//            return activeFingerprints.size() < MAX_ACTIVE_FINGERPRINTS
+//                    || activeFingerprints.containsKey(fingerprint);
+//        }
+//    }
+//
+//    public void registerFingerprint(String fingerprint, String sessionId) {
+//        synchronized (activeFingerprints) {
+//            activeFingerprints.put(
+//                    fingerprint, new FingerprintInfo(sessionId, System.currentTimeMillis()));
+//        }
+//    }
+//
+//    public void unregisterFingerprint(String fingerprint) {
+//        synchronized (activeFingerprints) {
+//            activeFingerprints.remove(fingerprint);
+//        }
+//    }
+//
+//    @Scheduled(fixedRate = 1800000) // Run every 30 mins
+//    public void cleanupStaleFingerprints() {
+//        log.info("Starting cleanup of stale fingerprints");
+//        long now = System.currentTimeMillis();
+//        int removedCount = 0;
+//
+//        synchronized (activeFingerprints) {
+//            Iterator<Map.Entry<String, FingerprintInfo>> iterator =
+//                    activeFingerprints.entrySet().iterator();
+//            while (iterator.hasNext()) {
+//                Map.Entry<String, FingerprintInfo> entry = iterator.next();
+//                FingerprintInfo info = entry.getValue();
+//
+//                if (now - info.getLastAccessTime() > FINGERPRINT_EXPIRATION) {
+//                    iterator.remove();
+//                    removedCount++;
+//                    log.info("Removed stale fingerprint: {}", entry.getKey());
+//                }
+//            }
+//        }
+//
+//        log.info("Cleanup complete. Removed {} stale fingerprints", removedCount);
+//    }
+//
+//    public void updateLastAccessTime(String fingerprint) {
+//        FingerprintInfo info = activeFingerprints.get(fingerprint);
+//        if (info != null) {
+//            info.setLastAccessTime(System.currentTimeMillis());
+//        }
+//    }
+//
+//    @Data
+//    @AllArgsConstructor
+//    private static class FingerprintInfo {
+//        private String sessionId;
+//        private long lastAccessTime;
+//    }
+// }

src/main/java/stirling/software/SPDF/config/fingerprint/FingerprintGenerator.java

@@ -0,0 +1,77 @@
+// package stirling.software.SPDF.config.fingerprint;
+//
+// import java.security.MessageDigest;
+// import java.security.NoSuchAlgorithmException;
+//
+// import org.springframework.stereotype.Component;
+//
+// import jakarta.servlet.http.HttpServletRequest;
+//
+// @Component
+// public class FingerprintGenerator {
+//
+//    public String generateFingerprint(HttpServletRequest request) {
+//        if (request == null) {
+//            return "";
+//        }
+//        StringBuilder fingerprintBuilder = new StringBuilder();
+//
+//        // Add IP address
+//        fingerprintBuilder.append(request.getRemoteAddr());
+//
+//        // Add X-Forwarded-For header if present (for clients behind proxies)
+//        String forwardedFor = request.getHeader("X-Forwarded-For");
+//        if (forwardedFor != null) {
+//            fingerprintBuilder.append(forwardedFor);
+//        }
+//
+//        // Add User-Agent
+//        String userAgent = request.getHeader("User-Agent");
+//        if (userAgent != null) {
+//            fingerprintBuilder.append(userAgent);
+//        }
+//
+//        // Add Accept-Language header
+//        String acceptLanguage = request.getHeader("Accept-Language");
+//        if (acceptLanguage != null) {
+//            fingerprintBuilder.append(acceptLanguage);
+//        }
+//
+//        // Add Accept header
+//        String accept = request.getHeader("Accept");
+//        if (accept != null) {
+//            fingerprintBuilder.append(accept);
+//        }
+//
+//        // Add Connection header
+//        String connection = request.getHeader("Connection");
+//        if (connection != null) {
+//            fingerprintBuilder.append(connection);
+//        }
+//
+//        // Add server port
+//        fingerprintBuilder.append(request.getServerPort());
+//
+//        // Add secure flag
+//        fingerprintBuilder.append(request.isSecure());
+//
+//        // Generate a hash of the fingerprint
+//        return generateHash(fingerprintBuilder.toString());
+//    }
+//
+//    private String generateHash(String input) {
+//        try {
+//            MessageDigest digest = MessageDigest.getInstance("SHA-256");
+//            byte[] hash = digest.digest(input.getBytes());
+//            StringBuilder hexString = new StringBuilder();
+//            for (byte b : hash) {
+//                String hex = Integer.toHexString(0xff & b);
+//                if (hex.length() == 1) hexString.append('0');
+//                hexString.append(hex);
+//            }
+//            return hexString.toString();
+//        } catch (NoSuchAlgorithmException e) {
+//            throw new RuntimeException("Failed to generate fingerprint hash", e);
+//        }
+//    }
+// }

src/main/java/stirling/software/SPDF/config/interfaces/DatabaseBackupInterface.java

@@ -1,4 +1,4 @@
-package stirling.software.SPDF.config;
+package stirling.software.SPDF.config.interfaces;
 
 import java.io.IOException;
 import java.util.List;

src/main/java/stirling/software/SPDF/config/interfaces/ShowAdminInterface.java

@@ -1,4 +1,4 @@
-package stirling.software.SPDF.config;
+package stirling.software.SPDF.config.interfaces;
 
 public interface ShowAdminInterface {
     default boolean getShowUpdateOnlyAdmins() {

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

@@ -7,7 +7,7 @@ import org.springframework.security.core.Authentication;
 import org.springframework.security.core.context.SecurityContextHolder;
 import org.springframework.stereotype.Service;
 
-import stirling.software.SPDF.config.ShowAdminInterface;
+import stirling.software.SPDF.config.interfaces.ShowAdminInterface;
 import stirling.software.SPDF.model.ApplicationProperties;
 import stirling.software.SPDF.model.User;
 import stirling.software.SPDF.repository.UserRepository;
@@ -20,7 +20,7 @@ class AppUpdateAuthService implements ShowAdminInterface {
 
     @Override
     public boolean getShowUpdateOnlyAdmins() {
-        boolean showUpdate = applicationProperties.getSystem().getShowUpdate();
+        boolean showUpdate = applicationProperties.getSystem().isShowUpdate();
         if (!showUpdate) {
             return showUpdate;
         }

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

@@ -1,27 +1,237 @@
 package stirling.software.SPDF.config.security;
 
 import java.io.IOException;
+import java.security.cert.X509Certificate;
+import java.security.interfaces.RSAPrivateKey;
+import java.util.ArrayList;
+import java.util.List;
 
+import org.springframework.core.io.Resource;
+import org.springframework.security.authentication.UsernamePasswordAuthenticationToken;
 import org.springframework.security.core.Authentication;
+import org.springframework.security.oauth2.client.authentication.OAuth2AuthenticationToken;
+import org.springframework.security.saml2.provider.service.authentication.Saml2Authentication;
 import org.springframework.security.web.authentication.logout.SimpleUrlLogoutSuccessHandler;
 
+import com.coveo.saml.SamlClient;
+
 import jakarta.servlet.ServletException;
 import jakarta.servlet.http.HttpServletRequest;
 import jakarta.servlet.http.HttpServletResponse;
+import lombok.AllArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import stirling.software.SPDF.SPdfApplication;
+import stirling.software.SPDF.config.security.saml2.CertificateUtils;
+import stirling.software.SPDF.config.security.saml2.CustomSaml2AuthenticatedPrincipal;
+import stirling.software.SPDF.model.ApplicationProperties;
+import stirling.software.SPDF.model.ApplicationProperties.Security.OAUTH2;
+import stirling.software.SPDF.model.ApplicationProperties.Security.SAML2;
+import stirling.software.SPDF.model.Provider;
+import stirling.software.SPDF.model.provider.UnsupportedProviderException;
+import stirling.software.SPDF.utils.UrlUtils;
 
+@Slf4j
+@AllArgsConstructor
 public class CustomLogoutSuccessHandler extends SimpleUrlLogoutSuccessHandler {
 
+    private final ApplicationProperties applicationProperties;
+
     @Override
     public void onLogoutSuccess(
             HttpServletRequest request, HttpServletResponse response, Authentication authentication)
             throws IOException, ServletException {
 
-        if (request.getParameter("userIsDisabled") != null) {
-            getRedirectStrategy()
-                    .sendRedirect(request, response, "/login?erroroauth=userIsDisabled");
-            return;
+        if (!response.isCommitted()) {
+            // Handle user logout due to disabled account
+            if (request.getParameter("userIsDisabled") != null) {
+                response.sendRedirect(
+                        request.getContextPath() + "/login?erroroauth=userIsDisabled");
+                return;
+            }
+            // Handle OAuth2 authentication error
+            if (request.getParameter("oauth2AuthenticationErrorWeb") != null) {
+                response.sendRedirect(
+                        request.getContextPath() + "/login?erroroauth=userAlreadyExistsWeb");
+                return;
+            }
+            if (authentication != null) {
+                // Handle SAML2 logout redirection
+                if (authentication instanceof Saml2Authentication) {
+                    getRedirect_saml2(request, response, authentication);
+                    return;
+                }
+                // Handle OAuth2 logout redirection
+                else if (authentication instanceof OAuth2AuthenticationToken) {
+                    getRedirect_oauth2(request, response, authentication);
+                    return;
+                }
+                // Handle Username/Password logout
+                else if (authentication instanceof UsernamePasswordAuthenticationToken) {
+                    getRedirectStrategy().sendRedirect(request, response, "/login?logout=true");
+                    return;
+                }
+                // Handle unknown authentication types
+                else {
+                    log.error(
+                            "authentication class unknown: "
+                                    + authentication.getClass().getSimpleName());
+                    getRedirectStrategy().sendRedirect(request, response, "/login?logout=true");
+                    return;
+                }
+            } else {
+                // Redirect to login page after logout
+                getRedirectStrategy().sendRedirect(request, response, "/login?logout=true");
+                return;
+            }
+        }
+    }
+
+    // Redirect for SAML2 authentication logout
+    private void getRedirect_saml2(
+            HttpServletRequest request, HttpServletResponse response, Authentication authentication)
+            throws IOException {
+
+        SAML2 samlConf = applicationProperties.getSecurity().getSaml2();
+        String registrationId = samlConf.getRegistrationId();
+
+        Saml2Authentication samlAuthentication = (Saml2Authentication) authentication;
+        CustomSaml2AuthenticatedPrincipal principal =
+                (CustomSaml2AuthenticatedPrincipal) samlAuthentication.getPrincipal();
+
+        String nameIdValue = principal.getName();
+
+        try {
+            // Read certificate from the resource
+            Resource certificateResource = samlConf.getSpCert();
+            X509Certificate certificate = CertificateUtils.readCertificate(certificateResource);
+
+            List<X509Certificate> certificates = new ArrayList<>();
+            certificates.add(certificate);
+
+            // Construct URLs required for SAML configuration
+            String serverUrl =
+                    SPdfApplication.getStaticBaseUrl() + ":" + SPdfApplication.getStaticPort();
+
+            String relyingPartyIdentifier =
+                    serverUrl + "/saml2/service-provider-metadata/" + registrationId;
+
+            String assertionConsumerServiceUrl = serverUrl + "/login/saml2/sso/" + registrationId;
+
+            String idpUrl = samlConf.getIdpSingleLogoutUrl();
+
+            String idpIssuer = samlConf.getIdpIssuer();
+
+            // Create SamlClient instance for SAML logout
+            SamlClient samlClient =
+                    new SamlClient(
+                            relyingPartyIdentifier,
+                            assertionConsumerServiceUrl,
+                            idpUrl,
+                            idpIssuer,
+                            certificates,
+                            SamlClient.SamlIdpBinding.POST);
+
+            // Read private key for service provider
+            Resource privateKeyResource = samlConf.getPrivateKey();
+            RSAPrivateKey privateKey = CertificateUtils.readPrivateKey(privateKeyResource);
+
+            // Set service provider keys for the SamlClient
+            samlClient.setSPKeys(certificate, privateKey);
+
+            // Redirect to identity provider for logout
+            samlClient.redirectToIdentityProvider(response, null, nameIdValue);
+        } catch (Exception e) {
+            log.error(nameIdValue, e);
+            getRedirectStrategy().sendRedirect(request, response, "/login?logout=true");
+        }
+    }
+
+    // Redirect for OAuth2 authentication logout
+    private void getRedirect_oauth2(
+            HttpServletRequest request, HttpServletResponse response, Authentication authentication)
+            throws IOException {
+        String param = "logout=true";
+        String registrationId = null;
+        String issuer = null;
+        String clientId = null;
+        OAUTH2 oauth = applicationProperties.getSecurity().getOauth2();
+
+        if (authentication instanceof OAuth2AuthenticationToken) {
+            OAuth2AuthenticationToken oauthToken = (OAuth2AuthenticationToken) authentication;
+            registrationId = oauthToken.getAuthorizedClientRegistrationId();
+
+            try {
+                // Get OAuth2 provider details from configuration
+                Provider provider = oauth.getClient().get(registrationId);
+                issuer = provider.getIssuer();
+                clientId = provider.getClientId();
+            } catch (UnsupportedProviderException e) {
+                log.error(e.getMessage());
+            }
+        } else {
+            registrationId = oauth.getProvider() != null ? oauth.getProvider() : "";
+            issuer = oauth.getIssuer();
+            clientId = oauth.getClientId();
+        }
+        String errorMessage = "";
+        // Handle different error scenarios during logout
+        if (request.getParameter("oauth2AuthenticationErrorWeb") != null) {
+            param = "erroroauth=oauth2AuthenticationErrorWeb";
+        } else if ((errorMessage = request.getParameter("error")) != null) {
+            param = "error=" + sanitizeInput(errorMessage);
+        } else if ((errorMessage = request.getParameter("erroroauth")) != null) {
+            param = "erroroauth=" + sanitizeInput(errorMessage);
+        } else if (request.getParameter("oauth2AutoCreateDisabled") != null) {
+            param = "error=oauth2AutoCreateDisabled";
+        } else if (request.getParameter("oauth2_admin_blocked_user") != null) {
+            param = "erroroauth=oauth2_admin_blocked_user";
+        } else if (request.getParameter("userIsDisabled") != null) {
+            param = "erroroauth=userIsDisabled";
+        } else if (request.getParameter("badcredentials") != null) {
+            param = "error=badcredentials";
         }
 
-        getRedirectStrategy().sendRedirect(request, response, "/login?logout=true");
+        String redirect_url = UrlUtils.getOrigin(request) + "/login?" + param;
+
+        // Redirect based on OAuth2 provider
+        switch (registrationId.toLowerCase()) {
+            case "keycloak":
+                // Add Keycloak specific logout URL if needed
+                String logoutUrl =
+                        issuer
+                                + "/protocol/openid-connect/logout"
+                                + "?client_id="
+                                + clientId
+                                + "&post_logout_redirect_uri="
+                                + response.encodeRedirectURL(redirect_url);
+                log.info("Redirecting to Keycloak logout URL: " + logoutUrl);
+                response.sendRedirect(logoutUrl);
+                break;
+            case "github":
+                // Add GitHub specific logout URL if needed
+                String githubLogoutUrl = "https://github.com/logout";
+                log.info("Redirecting to GitHub logout URL: " + githubLogoutUrl);
+                response.sendRedirect(githubLogoutUrl);
+                break;
+            case "google":
+                // Add Google specific logout URL if needed
+                // String googleLogoutUrl =
+                // "https://accounts.google.com/Logout?continue=https://appengine.google.com/_ah/logout?continue="
+                //                 + response.encodeRedirectURL(redirect_url);
+                log.info("Google does not have a specific logout URL");
+                // log.info("Redirecting to Google logout URL: " + googleLogoutUrl);
+                // response.sendRedirect(googleLogoutUrl);
+                // break;
+            default:
+                String defaultRedirectUrl = request.getContextPath() + "/login?" + param;
+                log.info("Redirecting to default logout URL: " + defaultRedirectUrl);
+                response.sendRedirect(defaultRedirectUrl);
+                break;
+        }
+    }
+
+    // Sanitize input to avoid potential security vulnerabilities
+    private String sanitizeInput(String input) {
+        return input.replaceAll("[^a-zA-Z0-9 ]", "");
     }
 }

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

@@ -1,6 +1,8 @@
 package stirling.software.SPDF.config.security;
 
 import java.io.IOException;
+import java.text.SimpleDateFormat;
+import java.util.Date;
 import java.util.Optional;
 
 import org.springframework.beans.factory.annotation.Autowired;
@@ -14,9 +16,12 @@ import jakarta.servlet.FilterChain;
 import jakarta.servlet.ServletException;
 import jakarta.servlet.http.HttpServletRequest;
 import jakarta.servlet.http.HttpServletResponse;
+import jakarta.servlet.http.HttpSession;
+import lombok.extern.slf4j.Slf4j;
 import stirling.software.SPDF.model.User;
 import stirling.software.SPDF.utils.RequestUriUtils;
 
+@Slf4j
 @Component
 public class FirstLoginFilter extends OncePerRequestFilter {
 
@@ -50,6 +55,22 @@ public class FirstLoginFilter extends OncePerRequestFilter {
                 return;
             }
         }
+
+        if (log.isDebugEnabled()) {
+            HttpSession session = request.getSession(true);
+            SimpleDateFormat timeFormat = new SimpleDateFormat("HH:mm:ss");
+            String creationTime = timeFormat.format(new Date(session.getCreationTime()));
+
+            log.debug(
+                    "Request Info - New: {}, creationTimeSession {}, ID:  {}, IP: {}, User-Agent: {}, Referer: {}, Request URL: {}",
+                    session.isNew(),
+                    creationTime,
+                    session.getId(),
+                    request.getRemoteAddr(),
+                    request.getHeader("User-Agent"),
+                    request.getHeader("Referer"),
+                    request.getRequestURL().toString());
+        }
         filterChain.doFilter(request, response);
     }
 }

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

@@ -1,19 +1,14 @@
 package stirling.software.SPDF.config.security;
 
 import java.io.IOException;
-import java.nio.file.Path;
-import java.nio.file.Paths;
 import java.util.UUID;
 
-import org.simpleyaml.configuration.file.YamlFile;
-import org.simpleyaml.configuration.implementation.SimpleYamlImplementation;
-import org.simpleyaml.configuration.implementation.snakeyaml.lib.DumperOptions;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.stereotype.Component;
 
 import jakarta.annotation.PostConstruct;
 import lombok.extern.slf4j.Slf4j;
-import stirling.software.SPDF.config.DatabaseBackupInterface;
+import stirling.software.SPDF.config.interfaces.DatabaseBackupInterface;
 import stirling.software.SPDF.model.ApplicationProperties;
 import stirling.software.SPDF.model.Role;
 
@@ -35,19 +30,11 @@ public class InitialSecuritySetup {
             initializeAdminUser();
         } else {
             databaseBackupHelper.exportDatabase();
+            userService.migrateOauth2ToSSO();
         }
         initializeInternalApiUser();
     }
 
-    @PostConstruct
-    public void initSecretKey() throws IOException {
-        String secretKey = applicationProperties.getAutomaticallyGenerated().getKey();
-        if (!isValidUUID(secretKey)) {
-            secretKey = UUID.randomUUID().toString(); // Generating a random UUID as the secret key
-            saveKeyToConfig(secretKey);
-        }
-    }
-
     private void initializeAdminUser() throws IOException {
         String initialUsername =
                 applicationProperties.getSecurity().getInitialLogin().getUsername();
@@ -89,33 +76,4 @@ public class InitialSecuritySetup {
             log.info("Internal API user created: " + Role.INTERNAL_API_USER.getRoleId());
         }
     }
-
-    private void saveKeyToConfig(String key) throws IOException {
-        Path path = Paths.get("configs", "settings.yml"); // Target the configs/settings.yml
-
-        final YamlFile settingsYml = new YamlFile(path.toFile());
-        DumperOptions yamlOptionssettingsYml =
-                ((SimpleYamlImplementation) settingsYml.getImplementation()).getDumperOptions();
-        yamlOptionssettingsYml.setSplitLines(false);
-
-        settingsYml.loadWithComments();
-
-        settingsYml
-                .path("AutomaticallyGenerated.key")
-                .set(key)
-                .comment("# Automatically Generated Settings (Do Not Edit Directly)");
-        settingsYml.save();
-    }
-
-    private boolean isValidUUID(String uuid) {
-        if (uuid == null) {
-            return false;
-        }
-        try {
-            UUID.fromString(uuid);
-            return true;
-        } catch (IllegalArgumentException e) {
-            return false;
-        }
-    }
 }

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

@@ -7,21 +7,28 @@ import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.stereotype.Service;
 
 import jakarta.annotation.PostConstruct;
+import lombok.extern.slf4j.Slf4j;
 import stirling.software.SPDF.model.ApplicationProperties;
 import stirling.software.SPDF.model.AttemptCounter;
 
 @Service
+@Slf4j
 public class LoginAttemptService {
 
-    @Autowired ApplicationProperties applicationProperties;
+    @Autowired private ApplicationProperties applicationProperties;
 
     private int MAX_ATTEMPT;
     private long ATTEMPT_INCREMENT_TIME;
     private ConcurrentHashMap<String, AttemptCounter> attemptsCache;
+    private boolean isBlockedEnabled = true;
 
     @PostConstruct
     public void init() {
         MAX_ATTEMPT = applicationProperties.getSecurity().getLoginAttemptCount();
+        if (MAX_ATTEMPT == -1) {
+            isBlockedEnabled = false;
+            log.info("Login attempt tracking is disabled.");
+        }
         ATTEMPT_INCREMENT_TIME =
                 TimeUnit.MINUTES.toMillis(
                         applicationProperties.getSecurity().getLoginResetTimeMinutes());
@@ -29,14 +36,16 @@ public class LoginAttemptService {
     }
 
     public void loginSucceeded(String key) {
-        if (key == null || key.trim().isEmpty()) {
+        if (!isBlockedEnabled || key == null || key.trim().isEmpty()) {
             return;
         }
         attemptsCache.remove(key.toLowerCase());
     }
 
     public void loginFailed(String key) {
-        if (key == null || key.trim().isEmpty()) return;
+        if (!isBlockedEnabled || key == null || key.trim().isEmpty()) {
+            return;
+        }
 
         AttemptCounter attemptCounter = attemptsCache.get(key.toLowerCase());
         if (attemptCounter == null) {
@@ -51,7 +60,9 @@ public class LoginAttemptService {
     }
 
     public boolean isBlocked(String key) {
-        if (key == null || key.trim().isEmpty()) return false;
+        if (!isBlockedEnabled || key == null || key.trim().isEmpty()) {
+            return false;
+        }
         AttemptCounter attemptCounter = attemptsCache.get(key.toLowerCase());
         if (attemptCounter == null) {
             return false;
@@ -61,7 +72,9 @@ public class LoginAttemptService {
     }
 
     public int getRemainingAttempts(String key) {
-        if (key == null || key.trim().isEmpty()) return MAX_ATTEMPT;
+        if (!isBlockedEnabled || key == null || key.trim().isEmpty()) {
+            return Integer.MAX_VALUE; // Arbitrarily high number if tracking is disabled
+        }
 
         AttemptCounter attemptCounter = attemptsCache.get(key.toLowerCase());
         if (attemptCounter == null) {

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

@@ -1,15 +1,18 @@
 package stirling.software.SPDF.config.security;
 
+import java.security.cert.X509Certificate;
 import java.util.*;
 
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
+import org.opensaml.saml.saml2.core.AuthnRequest;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Qualifier;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
+import org.springframework.context.annotation.DependsOn;
 import org.springframework.context.annotation.Lazy;
+import org.springframework.core.io.Resource;
+import org.springframework.security.authentication.ProviderManager;
 import org.springframework.security.authentication.dao.DaoAuthenticationProvider;
 import org.springframework.security.config.annotation.method.configuration.EnableMethodSecurity;
 import org.springframework.security.config.annotation.web.builders.HttpSecurity;
@@ -25,20 +28,36 @@ import org.springframework.security.oauth2.client.registration.ClientRegistratio
 import org.springframework.security.oauth2.client.registration.ClientRegistrations;
 import org.springframework.security.oauth2.client.registration.InMemoryClientRegistrationRepository;
 import org.springframework.security.oauth2.core.user.OAuth2UserAuthority;
+import org.springframework.security.saml2.core.Saml2X509Credential;
+import org.springframework.security.saml2.core.Saml2X509Credential.Saml2X509CredentialType;
+import org.springframework.security.saml2.provider.service.authentication.OpenSaml4AuthenticationProvider;
+import org.springframework.security.saml2.provider.service.registration.InMemoryRelyingPartyRegistrationRepository;
+import org.springframework.security.saml2.provider.service.registration.RelyingPartyRegistration;
+import org.springframework.security.saml2.provider.service.registration.RelyingPartyRegistrationRepository;
+import org.springframework.security.saml2.provider.service.registration.Saml2MessageBinding;
+import org.springframework.security.saml2.provider.service.web.authentication.OpenSaml4AuthenticationRequestResolver;
 import org.springframework.security.web.SecurityFilterChain;
 import org.springframework.security.web.authentication.UsernamePasswordAuthenticationFilter;
 import org.springframework.security.web.authentication.rememberme.PersistentTokenRepository;
+import org.springframework.security.web.csrf.CookieCsrfTokenRepository;
+import org.springframework.security.web.csrf.CsrfTokenRequestAttributeHandler;
 import org.springframework.security.web.savedrequest.NullRequestCache;
 import org.springframework.security.web.util.matcher.AntPathRequestMatcher;
 
+import jakarta.servlet.http.HttpServletRequest;
+import lombok.extern.slf4j.Slf4j;
 import stirling.software.SPDF.config.security.oauth2.CustomOAuth2AuthenticationFailureHandler;
 import stirling.software.SPDF.config.security.oauth2.CustomOAuth2AuthenticationSuccessHandler;
-import stirling.software.SPDF.config.security.oauth2.CustomOAuth2LogoutSuccessHandler;
 import stirling.software.SPDF.config.security.oauth2.CustomOAuth2UserService;
+import stirling.software.SPDF.config.security.saml2.CertificateUtils;
+import stirling.software.SPDF.config.security.saml2.CustomSaml2AuthenticationFailureHandler;
+import stirling.software.SPDF.config.security.saml2.CustomSaml2AuthenticationSuccessHandler;
+import stirling.software.SPDF.config.security.saml2.CustomSaml2ResponseAuthenticationConverter;
 import stirling.software.SPDF.config.security.session.SessionPersistentRegistry;
 import stirling.software.SPDF.model.ApplicationProperties;
 import stirling.software.SPDF.model.ApplicationProperties.Security.OAUTH2;
 import stirling.software.SPDF.model.ApplicationProperties.Security.OAUTH2.Client;
+import stirling.software.SPDF.model.ApplicationProperties.Security.SAML2;
 import stirling.software.SPDF.model.User;
 import stirling.software.SPDF.model.provider.GithubProvider;
 import stirling.software.SPDF.model.provider.GoogleProvider;
@@ -48,12 +67,12 @@ import stirling.software.SPDF.repository.JPATokenRepositoryImpl;
 @Configuration
 @EnableWebSecurity
 @EnableMethodSecurity
+@Slf4j
+@DependsOn("runningEE")
 public class SecurityConfiguration {
 
     @Autowired private CustomUserDetailsService userDetailsService;
 
-    private static final Logger logger = LoggerFactory.getLogger(SecurityConfiguration.class);
-
     @Bean
     public PasswordEncoder passwordEncoder() {
         return new BCryptPasswordEncoder();
@@ -65,6 +84,10 @@ public class SecurityConfiguration {
     @Qualifier("loginEnabled")
     public boolean loginEnabledValue;
 
+    @Autowired
+    @Qualifier("runningEE")
+    public boolean runningEE;
+
     @Autowired ApplicationProperties applicationProperties;
 
     @Autowired private UserAuthenticationFilter userAuthenticationFilter;
@@ -76,11 +99,49 @@ public class SecurityConfiguration {
 
     @Bean
     public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
-        http.addFilterBefore(userAuthenticationFilter, UsernamePasswordAuthenticationFilter.class);
+        if (applicationProperties.getSecurity().getCsrfDisabled()) {
+            http.csrf(csrf -> csrf.disable());
+        }
 
         if (loginEnabledValue) {
+            http.addFilterBefore(
+                    userAuthenticationFilter, UsernamePasswordAuthenticationFilter.class);
+            if (!applicationProperties.getSecurity().getCsrfDisabled()) {
+                CookieCsrfTokenRepository cookieRepo =
+                        CookieCsrfTokenRepository.withHttpOnlyFalse();
+                CsrfTokenRequestAttributeHandler requestHandler =
+                        new CsrfTokenRequestAttributeHandler();
+                requestHandler.setCsrfRequestAttributeName(null);
+                http.csrf(
+                        csrf ->
+                                csrf.ignoringRequestMatchers(
+                                                request -> {
+                                                    String apiKey = request.getHeader("X-API-Key");
 
-            http.csrf(csrf -> csrf.disable());
+                                                    // If there's no API key, don't ignore CSRF
+                                                    // (return false)
+                                                    if (apiKey == null || apiKey.trim().isEmpty()) {
+                                                        return false;
+                                                    }
+
+                                                    // Validate API key using existing UserService
+                                                    try {
+                                                        Optional<User> user =
+                                                                userService.getUserByApiKey(apiKey);
+                                                        // If API key is valid, ignore CSRF (return
+                                                        // true)
+                                                        // If API key is invalid, don't ignore CSRF
+                                                        // (return false)
+                                                        return user.isPresent();
+                                                    } catch (Exception e) {
+                                                        // If there's any error validating the API
+                                                        // key, don't ignore CSRF
+                                                        return false;
+                                                    }
+                                                })
+                                        .csrfTokenRepository(cookieRepo)
+                                        .csrfTokenRequestHandler(requestHandler));
+            }
             http.addFilterBefore(rateLimitingFilter(), UsernamePasswordAuthenticationFilter.class);
             http.addFilterAfter(firstLoginFilter, UsernamePasswordAuthenticationFilter.class);
             http.sessionManagement(
@@ -92,116 +153,159 @@ public class SecurityConfiguration {
                                     .sessionRegistry(sessionRegistry)
                                     .expiredUrl("/login?logout=true"));
 
-            http.formLogin(
-                            formLogin ->
-                                    formLogin
-                                            .loginPage("/login")
-                                            .successHandler(
-                                                    new CustomAuthenticationSuccessHandler(
-                                                            loginAttemptService, userService))
-                                            .defaultSuccessUrl("/")
-                                            .failureHandler(
-                                                    new CustomAuthenticationFailureHandler(
-                                                            loginAttemptService, userService))
-                                            .permitAll())
-                    .requestCache(requestCache -> requestCache.requestCache(new NullRequestCache()))
-                    .logout(
-                            logout ->
-                                    logout.logoutRequestMatcher(
-                                                    new AntPathRequestMatcher("/logout"))
-                                            .logoutSuccessHandler(new CustomLogoutSuccessHandler())
-                                            .invalidateHttpSession(true) // Invalidate session
-                                            .deleteCookies("JSESSIONID", "remember-me"))
-                    .rememberMe(
-                            rememberMeConfigurer ->
-                                    rememberMeConfigurer // Use the configurator directly
-                                            .key("uniqueAndSecret")
-                                            .tokenRepository(persistentTokenRepository())
-                                            .tokenValiditySeconds(1209600) // 2 weeks
-                            )
-                    .authorizeHttpRequests(
-                            authz ->
-                                    authz.requestMatchers(
-                                                    req -> {
-                                                        String uri = req.getRequestURI();
-                                                        String contextPath = req.getContextPath();
+            http.authenticationProvider(daoAuthenticationProvider());
+            http.requestCache(requestCache -> requestCache.requestCache(new NullRequestCache()));
+            http.logout(
+                    logout ->
+                            logout.logoutRequestMatcher(new AntPathRequestMatcher("/logout"))
+                                    .logoutSuccessHandler(
+                                            new CustomLogoutSuccessHandler(applicationProperties))
+                                    .clearAuthentication(true)
+                                    .invalidateHttpSession(true) // Invalidate session
+                                    .deleteCookies("JSESSIONID", "remember-me"));
+            http.rememberMe(
+                    rememberMeConfigurer ->
+                            rememberMeConfigurer // Use the configurator directly
+                                    .tokenRepository(persistentTokenRepository())
+                                    .tokenValiditySeconds(14 * 24 * 60 * 60) // 14 days
+                                    .userDetailsService(
+                                            userDetailsService) // Your existing UserDetailsService
+                                    .useSecureCookie(true) // Enable secure cookie
+                                    .rememberMeParameter("remember-me") // Form parameter name
+                                    .rememberMeCookieName("remember-me") // Cookie name
+                                    .alwaysRemember(false));
+            http.authorizeHttpRequests(
+                    authz ->
+                            authz.requestMatchers(
+                                            req -> {
+                                                String uri = req.getRequestURI();
+                                                String contextPath = req.getContextPath();
 
-                                                        // Remove the context path from the URI
-                                                        String trimmedUri =
-                                                                uri.startsWith(contextPath)
-                                                                        ? uri.substring(
-                                                                                contextPath
-                                                                                        .length())
-                                                                        : uri;
+                                                // Remove the context path from the URI
+                                                String trimmedUri =
+                                                        uri.startsWith(contextPath)
+                                                                ? uri.substring(
+                                                                        contextPath.length())
+                                                                : uri;
 
-                                                        return trimmedUri.startsWith("/login")
-                                                                || trimmedUri.startsWith("/oauth")
-                                                                || trimmedUri.endsWith(".svg")
-                                                                || trimmedUri.startsWith(
-                                                                        "/register")
-                                                                || trimmedUri.startsWith("/error")
-                                                                || trimmedUri.startsWith("/images/")
-                                                                || trimmedUri.startsWith("/public/")
-                                                                || trimmedUri.startsWith("/css/")
-                                                                || trimmedUri.startsWith("/fonts/")
-                                                                || trimmedUri.startsWith("/js/")
-                                                                || trimmedUri.startsWith(
-                                                                        "/api/v1/info/status");
-                                                    })
-                                            .permitAll()
-                                            .anyRequest()
-                                            .authenticated())
-                    .authenticationProvider(authenticationProvider());
+                                                return trimmedUri.startsWith("/login")
+                                                        || trimmedUri.startsWith("/oauth")
+                                                        || trimmedUri.startsWith("/saml2")
+                                                        || trimmedUri.endsWith(".svg")
+                                                        || trimmedUri.startsWith("/register")
+                                                        || trimmedUri.startsWith("/error")
+                                                        || trimmedUri.startsWith("/images/")
+                                                        || trimmedUri.startsWith("/public/")
+                                                        || trimmedUri.startsWith("/css/")
+                                                        || trimmedUri.startsWith("/fonts/")
+                                                        || trimmedUri.startsWith("/js/")
+                                                        || trimmedUri.startsWith(
+                                                                "/api/v1/info/status");
+                                            })
+                                    .permitAll()
+                                    .anyRequest()
+                                    .authenticated());
+
+            // Handle User/Password Logins
+            if (applicationProperties.getSecurity().isUserPass()) {
+                http.formLogin(
+                        formLogin ->
+                                formLogin
+                                        .loginPage("/login")
+                                        .successHandler(
+                                                new CustomAuthenticationSuccessHandler(
+                                                        loginAttemptService, userService))
+                                        .failureHandler(
+                                                new CustomAuthenticationFailureHandler(
+                                                        loginAttemptService, userService))
+                                        .defaultSuccessUrl("/")
+                                        .permitAll());
+            }
 
             // Handle OAUTH2 Logins
-            if (applicationProperties.getSecurity().getOAUTH2() != null
-                    && applicationProperties.getSecurity().getOAUTH2().getEnabled()
-                    && !applicationProperties
-                            .getSecurity()
-                            .getLoginMethod()
-                            .equalsIgnoreCase("normal")) {
+            if (applicationProperties.getSecurity().isOauth2Activ()) {
 
                 http.oauth2Login(
-                                oauth2 ->
-                                        oauth2.loginPage("/oauth2")
-                                                /*
-                                                This Custom handler is used to check if the OAUTH2 user trying to log in, already exists in the database.
-                                                If user exists, login proceeds as usual. If user does not exist, then it is autocreated but only if 'OAUTH2AutoCreateUser'
-                                                is set as true, else login fails with an error message advising the same.
-                                                 */
+                        oauth2 ->
+                                oauth2.loginPage("/oauth2")
+                                        /*
+                                        This Custom handler is used to check if the OAUTH2 user trying to log in, already exists in the database.
+                                        If user exists, login proceeds as usual. If user does not exist, then it is autocreated but only if 'OAUTH2AutoCreateUser'
+                                        is set as true, else login fails with an error message advising the same.
+                                         */
+                                        .successHandler(
+                                                new CustomOAuth2AuthenticationSuccessHandler(
+                                                        loginAttemptService,
+                                                        applicationProperties,
+                                                        userService))
+                                        .failureHandler(
+                                                new CustomOAuth2AuthenticationFailureHandler())
+                                        // Add existing Authorities from the database
+                                        .userInfoEndpoint(
+                                                userInfoEndpoint ->
+                                                        userInfoEndpoint
+                                                                .oidcUserService(
+                                                                        new CustomOAuth2UserService(
+                                                                                applicationProperties,
+                                                                                userService,
+                                                                                loginAttemptService))
+                                                                .userAuthoritiesMapper(
+                                                                        userAuthoritiesMapper()))
+                                        .permitAll());
+            }
+
+            // Handle SAML
+            if (applicationProperties.getSecurity().isSaml2Activ()) { // && runningEE
+                // Configure the authentication provider
+                OpenSaml4AuthenticationProvider authenticationProvider =
+                        new OpenSaml4AuthenticationProvider();
+                authenticationProvider.setResponseAuthenticationConverter(
+                        new CustomSaml2ResponseAuthenticationConverter(userService));
+
+                http.authenticationProvider(authenticationProvider)
+                        .saml2Login(
+                                saml2 -> {
+                                    try {
+                                        saml2.loginPage("/saml2")
+                                                .relyingPartyRegistrationRepository(
+                                                        relyingPartyRegistrations())
+                                                .authenticationManager(
+                                                        new ProviderManager(authenticationProvider))
                                                 .successHandler(
-                                                        new CustomOAuth2AuthenticationSuccessHandler(
+                                                        new CustomSaml2AuthenticationSuccessHandler(
                                                                 loginAttemptService,
                                                                 applicationProperties,
                                                                 userService))
                                                 .failureHandler(
-                                                        new CustomOAuth2AuthenticationFailureHandler())
-                                                // Add existing Authorities from the database
-                                                .userInfoEndpoint(
-                                                        userInfoEndpoint ->
-                                                                userInfoEndpoint
-                                                                        .oidcUserService(
-                                                                                new CustomOAuth2UserService(
-                                                                                        applicationProperties,
-                                                                                        userService,
-                                                                                        loginAttemptService))
-                                                                        .userAuthoritiesMapper(
-                                                                                userAuthoritiesMapper())))
-                        .logout(
-                                logout ->
-                                        logout.logoutSuccessHandler(
-                                                new CustomOAuth2LogoutSuccessHandler(
-                                                        applicationProperties)));
+                                                        new CustomSaml2AuthenticationFailureHandler())
+                                                .authenticationRequestResolver(
+                                                        authenticationRequestResolver(
+                                                                relyingPartyRegistrations()));
+                                    } catch (Exception e) {
+                                        log.error("Error configuring SAML2 login", e);
+                                        throw new RuntimeException(e);
+                                    }
+                                });
             }
+
         } else {
-            http.csrf(csrf -> csrf.disable())
-                    .authorizeHttpRequests(authz -> authz.anyRequest().permitAll());
+            if (!applicationProperties.getSecurity().getCsrfDisabled()) {
+                CookieCsrfTokenRepository cookieRepo =
+                        CookieCsrfTokenRepository.withHttpOnlyFalse();
+                CsrfTokenRequestAttributeHandler requestHandler =
+                        new CsrfTokenRequestAttributeHandler();
+                requestHandler.setCsrfRequestAttributeName(null);
+                http.csrf(
+                        csrf ->
+                                csrf.csrfTokenRepository(cookieRepo)
+                                        .csrfTokenRequestHandler(requestHandler));
+            }
+            http.authorizeHttpRequests(authz -> authz.anyRequest().permitAll());
         }
 
         return http.build();
     }
 
-    // Client Registration Repository for OAUTH2 OIDC Login
     @Bean
     @ConditionalOnProperty(
             value = "security.oauth2.enabled",
@@ -216,7 +320,7 @@ public class SecurityConfiguration {
         keycloakClientRegistration().ifPresent(registrations::add);
 
         if (registrations.isEmpty()) {
-            logger.error("At least one OAuth2 provider must be configured");
+            log.error("At least one OAuth2 provider must be configured");
             System.exit(1);
         }
 
@@ -224,7 +328,7 @@ public class SecurityConfiguration {
     }
 
     private Optional<ClientRegistration> googleClientRegistration() {
-        OAUTH2 oauth = applicationProperties.getSecurity().getOAUTH2();
+        OAUTH2 oauth = applicationProperties.getSecurity().getOauth2();
         if (oauth == null || !oauth.getEnabled()) {
             return Optional.empty();
         }
@@ -253,7 +357,7 @@ public class SecurityConfiguration {
     }
 
     private Optional<ClientRegistration> keycloakClientRegistration() {
-        OAUTH2 oauth = applicationProperties.getSecurity().getOAUTH2();
+        OAUTH2 oauth = applicationProperties.getSecurity().getOauth2();
         if (oauth == null || !oauth.getEnabled()) {
             return Optional.empty();
         }
@@ -277,7 +381,8 @@ public class SecurityConfiguration {
     }
 
     private Optional<ClientRegistration> githubClientRegistration() {
-        OAUTH2 oauth = applicationProperties.getSecurity().getOAUTH2();
+
+        OAUTH2 oauth = applicationProperties.getSecurity().getOauth2();
         if (oauth == null || !oauth.getEnabled()) {
             return Optional.empty();
         }
@@ -306,7 +411,7 @@ public class SecurityConfiguration {
     }
 
     private Optional<ClientRegistration> oidcClientRegistration() {
-        OAUTH2 oauth = applicationProperties.getSecurity().getOAUTH2();
+        OAUTH2 oauth = applicationProperties.getSecurity().getOauth2();
         if (oauth == null
                 || oauth.getIssuer() == null
                 || oauth.getIssuer().isEmpty()
@@ -331,6 +436,124 @@ public class SecurityConfiguration {
                         .build());
     }
 
+    @Bean
+    @ConditionalOnProperty(
+            name = "security.saml2.enabled",
+            havingValue = "true",
+            matchIfMissing = false)
+    public RelyingPartyRegistrationRepository relyingPartyRegistrations() throws Exception {
+        SAML2 samlConf = applicationProperties.getSecurity().getSaml2();
+
+        X509Certificate idpCert = CertificateUtils.readCertificate(samlConf.getidpCert());
+        Saml2X509Credential verificationCredential = Saml2X509Credential.verification(idpCert);
+
+        Resource privateKeyResource = samlConf.getPrivateKey();
+        Resource certificateResource = samlConf.getSpCert();
+
+        Saml2X509Credential signingCredential =
+                new Saml2X509Credential(
+                        CertificateUtils.readPrivateKey(privateKeyResource),
+                        CertificateUtils.readCertificate(certificateResource),
+                        Saml2X509CredentialType.SIGNING);
+
+        RelyingPartyRegistration rp =
+                RelyingPartyRegistration.withRegistrationId(samlConf.getRegistrationId())
+                        .signingX509Credentials(c -> c.add(signingCredential))
+                        .assertingPartyMetadata(
+                                metadata ->
+                                        metadata.entityId(samlConf.getIdpIssuer())
+                                                .singleSignOnServiceLocation(
+                                                        samlConf.getIdpSingleLoginUrl())
+                                                .verificationX509Credentials(
+                                                        c -> c.add(verificationCredential))
+                                                .singleSignOnServiceBinding(
+                                                        Saml2MessageBinding.POST)
+                                                .wantAuthnRequestsSigned(true))
+                        .build();
+
+        return new InMemoryRelyingPartyRegistrationRepository(rp);
+    }
+
+    @Bean
+    @ConditionalOnProperty(
+            name = "security.saml2.enabled",
+            havingValue = "true",
+            matchIfMissing = false)
+    public OpenSaml4AuthenticationRequestResolver authenticationRequestResolver(
+            RelyingPartyRegistrationRepository relyingPartyRegistrationRepository) {
+        OpenSaml4AuthenticationRequestResolver resolver =
+                new OpenSaml4AuthenticationRequestResolver(relyingPartyRegistrationRepository);
+        resolver.setAuthnRequestCustomizer(
+                customizer -> {
+                    log.debug("Customizing SAML Authentication request");
+
+                    AuthnRequest authnRequest = customizer.getAuthnRequest();
+                    log.debug("AuthnRequest ID: {}", authnRequest.getID());
+
+                    if (authnRequest.getID() == null) {
+                        authnRequest.setID("ARQ" + UUID.randomUUID().toString());
+                    }
+                    log.debug("AuthnRequest new ID after set: {}", authnRequest.getID());
+                    log.debug("AuthnRequest IssueInstant: {}", authnRequest.getIssueInstant());
+                    log.debug(
+                            "AuthnRequest Issuer: {}",
+                            authnRequest.getIssuer() != null
+                                    ? authnRequest.getIssuer().getValue()
+                                    : "null");
+
+                    HttpServletRequest request = customizer.getRequest();
+
+                    // Log HTTP request details
+                    log.debug("HTTP Request Method: {}", request.getMethod());
+                    log.debug("Request URI: {}", request.getRequestURI());
+                    log.debug("Request URL: {}", request.getRequestURL().toString());
+                    log.debug("Query String: {}", request.getQueryString());
+                    log.debug("Remote Address: {}", request.getRemoteAddr());
+
+                    // Log headers
+                    Collections.list(request.getHeaderNames())
+                            .forEach(
+                                    headerName -> {
+                                        log.debug(
+                                                "Header - {}: {}",
+                                                headerName,
+                                                request.getHeader(headerName));
+                                    });
+
+                    // Log SAML specific parameters
+                    log.debug("SAML Request Parameters:");
+                    log.debug("SAMLRequest: {}", request.getParameter("SAMLRequest"));
+                    log.debug("RelayState: {}", request.getParameter("RelayState"));
+
+                    // Log session debugrmation if exists
+                    if (request.getSession(false) != null) {
+                        log.debug("Session ID: {}", request.getSession().getId());
+                    }
+
+                    // Log any assertions consumer service details if present
+                    if (authnRequest.getAssertionConsumerServiceURL() != null) {
+                        log.debug(
+                                "AssertionConsumerServiceURL: {}",
+                                authnRequest.getAssertionConsumerServiceURL());
+                    }
+
+                    // Log NameID policy if present
+                    if (authnRequest.getNameIDPolicy() != null) {
+                        log.debug(
+                                "NameIDPolicy Format: {}",
+                                authnRequest.getNameIDPolicy().getFormat());
+                    }
+                });
+        return resolver;
+    }
+
+    public DaoAuthenticationProvider daoAuthenticationProvider() {
+        DaoAuthenticationProvider provider = new DaoAuthenticationProvider();
+        provider.setUserDetailsService(userDetailsService);
+        provider.setPasswordEncoder(passwordEncoder());
+        return provider;
+    }
+
     /*
     This following function is to grant Authorities to the OAUTH2 user from the values stored in the database.
     This is required for the internal; 'hasRole()' function to give out the correct role.
@@ -354,7 +577,7 @@ public class SecurityConfiguration {
                             String useAsUsername =
                                     applicationProperties
                                             .getSecurity()
-                                            .getOAUTH2()
+                                            .getOauth2()
                                             .getUseAsUsername();
                             Optional<User> userOpt =
                                     userService.findByUsernameIgnoreCase(
@@ -379,14 +602,6 @@ public class SecurityConfiguration {
         return new IPRateLimitingFilter(maxRequestsPerIp, maxRequestsPerIp);
     }
 
-    @Bean
-    public DaoAuthenticationProvider authenticationProvider() {
-        DaoAuthenticationProvider authProvider = new DaoAuthenticationProvider();
-        authProvider.setUserDetailsService(userDetailsService);
-        authProvider.setPasswordEncoder(passwordEncoder());
-        return authProvider;
-    }
-
     @Bean
     public PersistentTokenRepository persistentTokenRepository() {
         return new JPATokenRepositoryImpl();
@@ -396,4 +611,14 @@ public class SecurityConfiguration {
     public boolean activSecurity() {
         return true;
     }
+
+    //    // Only Dev test
+    //    @Bean
+    //    public WebSecurityCustomizer webSecurityCustomizer() {
+    //        return (web) ->
+    //                web.ignoring()
+    //                        .requestMatchers(
+    //                                "/css/**", "/images/**", "/js/**", "/**.svg",
+    // "/pdfjs-legacy/**");
+    //    }
 }

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

@@ -5,7 +5,6 @@ import java.util.List;
 import java.util.Optional;
 import java.util.stream.Collectors;
 
-import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Qualifier;
 import org.springframework.context.annotation.Lazy;
 import org.springframework.http.HttpStatus;
@@ -23,6 +22,7 @@ import jakarta.servlet.FilterChain;
 import jakarta.servlet.ServletException;
 import jakarta.servlet.http.HttpServletRequest;
 import jakarta.servlet.http.HttpServletResponse;
+import stirling.software.SPDF.config.security.saml2.CustomSaml2AuthenticatedPrincipal;
 import stirling.software.SPDF.config.security.session.SessionPersistentRegistry;
 import stirling.software.SPDF.model.ApiKeyAuthenticationToken;
 import stirling.software.SPDF.model.User;
@@ -30,13 +30,18 @@ import stirling.software.SPDF.model.User;
 @Component
 public class UserAuthenticationFilter extends OncePerRequestFilter {
 
-    @Autowired @Lazy private UserService userService;
+    private final UserService userService;
+    private final SessionPersistentRegistry sessionPersistentRegistry;
+    private final boolean loginEnabledValue;
 
-    @Autowired private SessionPersistentRegistry sessionPersistentRegistry;
-
-    @Autowired
-    @Qualifier("loginEnabled")
-    public boolean loginEnabledValue;
+    public UserAuthenticationFilter(
+            @Lazy UserService userService,
+            SessionPersistentRegistry sessionPersistentRegistry,
+            @Qualifier("loginEnabled") boolean loginEnabledValue) {
+        this.userService = userService;
+        this.sessionPersistentRegistry = sessionPersistentRegistry;
+        this.loginEnabledValue = loginEnabledValue;
+    }
 
     @Override
     protected void doFilterInternal(
@@ -51,6 +56,19 @@ public class UserAuthenticationFilter extends OncePerRequestFilter {
         String requestURI = request.getRequestURI();
         Authentication authentication = SecurityContextHolder.getContext().getAuthentication();
 
+        // Check for session expiration (unsure if needed)
+        //        if (authentication != null && authentication.isAuthenticated()) {
+        //            String sessionId = request.getSession().getId();
+        //            SessionInformation sessionInfo =
+        //                    sessionPersistentRegistry.getSessionInformation(sessionId);
+        //
+        //            if (sessionInfo != null && sessionInfo.isExpired()) {
+        //                SecurityContextHolder.clearContext();
+        //                response.sendRedirect(request.getContextPath() + "/login?expired=true");
+        //                return;
+        //            }
+        //        }
+
         // Check for API key in the request headers if no authentication exists
         if (authentication == null || !authentication.isAuthenticated()) {
             String apiKey = request.getHeader("X-API-Key");
@@ -94,7 +112,9 @@ public class UserAuthenticationFilter extends OncePerRequestFilter {
                 response.setStatus(HttpStatus.UNAUTHORIZED.value());
                 response.getWriter()
                         .write(
-                                "Authentication required. Please provide a X-API-KEY in request header.\nThis is found in Settings -> Account Settings -> API Key\nAlternatively you can disable authentication if this is unexpected");
+                                "Authentication required. Please provide a X-API-KEY in request header.\n"
+                                        + "This is found in Settings -> Account Settings -> API Key\n"
+                                        + "Alternatively you can disable authentication if this is unexpected");
                 return;
             }
         }
@@ -107,6 +127,8 @@ public class UserAuthenticationFilter extends OncePerRequestFilter {
                 username = ((UserDetails) principal).getUsername();
             } else if (principal instanceof OAuth2User) {
                 username = ((OAuth2User) principal).getName();
+            } else if (principal instanceof CustomSaml2AuthenticatedPrincipal) {
+                username = ((CustomSaml2AuthenticatedPrincipal) principal).getName();
             } else if (principal instanceof String) {
                 username = (String) principal;
             }
@@ -159,7 +181,10 @@ public class UserAuthenticationFilter extends OncePerRequestFilter {
         };
 
         for (String pattern : permitAllPatterns) {
-            if (uri.startsWith(pattern) || uri.endsWith(".svg")) {
+            if (uri.startsWith(pattern)
+                    || uri.endsWith(".svg")
+                    || uri.endsWith(".png")
+                    || uri.endsWith(".ico")) {
                 return true;
             }
         }

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

@@ -1,11 +1,7 @@
 package stirling.software.SPDF.config.security;
 
 import java.io.IOException;
-import java.util.Collection;
-import java.util.HashMap;
-import java.util.Map;
-import java.util.Optional;
-import java.util.UUID;
+import java.util.*;
 import java.util.stream.Collectors;
 
 import org.springframework.beans.factory.annotation.Autowired;
@@ -15,16 +11,21 @@ import org.springframework.security.authentication.UsernamePasswordAuthenticatio
 import org.springframework.security.core.Authentication;
 import org.springframework.security.core.GrantedAuthority;
 import org.springframework.security.core.authority.SimpleGrantedAuthority;
+import org.springframework.security.core.context.SecurityContextHolder;
 import org.springframework.security.core.session.SessionInformation;
 import org.springframework.security.core.userdetails.UserDetails;
 import org.springframework.security.core.userdetails.UsernameNotFoundException;
 import org.springframework.security.crypto.password.PasswordEncoder;
 import org.springframework.security.oauth2.core.user.OAuth2User;
 import org.springframework.stereotype.Service;
+import org.springframework.transaction.annotation.Transactional;
 
-import stirling.software.SPDF.config.DatabaseBackupInterface;
+import lombok.extern.slf4j.Slf4j;
+import stirling.software.SPDF.config.interfaces.DatabaseBackupInterface;
+import stirling.software.SPDF.config.security.saml2.CustomSaml2AuthenticatedPrincipal;
 import stirling.software.SPDF.config.security.session.SessionPersistentRegistry;
 import stirling.software.SPDF.controller.api.pipeline.UserServiceInterface;
+import stirling.software.SPDF.model.ApplicationProperties;
 import stirling.software.SPDF.model.AuthenticationType;
 import stirling.software.SPDF.model.Authority;
 import stirling.software.SPDF.model.Role;
@@ -33,6 +34,7 @@ import stirling.software.SPDF.repository.AuthorityRepository;
 import stirling.software.SPDF.repository.UserRepository;
 
 @Service
+@Slf4j
 public class UserService implements UserServiceInterface {
 
     @Autowired private UserRepository userRepository;
@@ -47,8 +49,21 @@ public class UserService implements UserServiceInterface {
 
     @Autowired DatabaseBackupInterface databaseBackupHelper;
 
+    @Autowired ApplicationProperties applicationProperties;
+
+    @Transactional
+    public void migrateOauth2ToSSO() {
+        userRepository
+                .findByAuthenticationTypeIgnoreCase("OAUTH2")
+                .forEach(
+                        user -> {
+                            user.setAuthenticationType(AuthenticationType.SSO);
+                            userRepository.save(user);
+                        });
+    }
+
     // Handle OAUTH2 login and user auto creation.
-    public boolean processOAuth2PostLogin(String username, boolean autoCreateUser)
+    public boolean processSSOPostLogin(String username, boolean autoCreateUser)
             throws IllegalArgumentException, IOException {
         if (!isUsernameValid(username)) {
             return false;
@@ -58,7 +73,7 @@ public class UserService implements UserServiceInterface {
             return true;
         }
         if (autoCreateUser) {
-            saveUser(username, AuthenticationType.OAUTH2);
+            saveUser(username, AuthenticationType.SSO);
             return true;
         }
         return false;
@@ -221,7 +236,7 @@ public class UserService implements UserServiceInterface {
 
     public void updateUserSettings(String username, Map<String, String> updates)
             throws IOException {
-        Optional<User> userOpt = findByUsernameIgnoreCase(username);
+        Optional<User> userOpt = findByUsernameIgnoreCaseWithSettings(username);
         if (userOpt.isPresent()) {
             User user = userOpt.get();
             Map<String, String> settingsMap = user.getSettings();
@@ -246,6 +261,10 @@ public class UserService implements UserServiceInterface {
         return userRepository.findByUsernameIgnoreCase(username);
     }
 
+    public Optional<User> findByUsernameIgnoreCaseWithSettings(String username) {
+        return userRepository.findByUsernameIgnoreCaseWithSettings(username);
+    }
+
     public Authority findRole(User user) {
         return authorityRepository.findByUserId(user.getId());
     }
@@ -297,7 +316,13 @@ public class UserService implements UserServiceInterface {
         boolean isValidEmail =
                 username.matches(
                         "^(?=.{1,64}@)[A-Za-z0-9]+(\\.[A-Za-z0-9_+.-]+)*@[^-][A-Za-z0-9-]+(\\.[A-Za-z0-9-]+)*(\\.[A-Za-z]{2,})$");
-        return isValidSimpleUsername || isValidEmail;
+
+        List<String> notAllowedUserList = new ArrayList<>();
+        notAllowedUserList.add("ALL_USERS".toLowerCase());
+
+        boolean notAllowedUser = notAllowedUserList.contains(username.toLowerCase());
+
+        return (isValidSimpleUsername || isValidEmail) && !notAllowedUser;
     }
 
     private String getInvalidUsernameMessage() {
@@ -333,6 +358,10 @@ public class UserService implements UserServiceInterface {
                 } else if (principal instanceof OAuth2User) {
                     OAuth2User oAuth2User = (OAuth2User) principal;
                     usernameP = oAuth2User.getName();
+                } else if (principal instanceof CustomSaml2AuthenticatedPrincipal) {
+                    CustomSaml2AuthenticatedPrincipal saml2User =
+                            (CustomSaml2AuthenticatedPrincipal) principal;
+                    usernameP = saml2User.getName();
                 } else if (principal instanceof String) {
                     usernameP = (String) principal;
                 }
@@ -342,4 +371,27 @@ public class UserService implements UserServiceInterface {
             }
         }
     }
+
+    public String getCurrentUsername() {
+        Object principal = SecurityContextHolder.getContext().getAuthentication().getPrincipal();
+
+        if (principal instanceof UserDetails) {
+            return ((UserDetails) principal).getUsername();
+        } else if (principal instanceof OAuth2User) {
+            return ((OAuth2User) principal)
+                    .getAttribute(
+                            applicationProperties.getSecurity().getOauth2().getUseAsUsername());
+        } else if (principal instanceof CustomSaml2AuthenticatedPrincipal) {
+            return ((CustomSaml2AuthenticatedPrincipal) principal).getName();
+        } else if (principal instanceof String) {
+            return (String) principal;
+        } else {
+            return principal.toString();
+        }
+    }
+
+    @Override
+    public long getTotalUsersCount() {
+        return userRepository.count();
+    }
 }

src/main/java/stirling/software/SPDF/config/security/database/DatabaseBackupHelper.java

@@ -24,7 +24,7 @@ import org.springframework.beans.factory.annotation.Value;
 import org.springframework.context.annotation.Configuration;
 
 import lombok.extern.slf4j.Slf4j;
-import stirling.software.SPDF.config.DatabaseBackupInterface;
+import stirling.software.SPDF.config.interfaces.DatabaseBackupInterface;
 import stirling.software.SPDF.utils.FileInfo;
 
 @Slf4j
@@ -34,6 +34,12 @@ public class DatabaseBackupHelper implements DatabaseBackupInterface {
     @Value("${spring.datasource.url}")
     private String url;
 
+    @Value("${spring.datasource.username}")
+    private String databaseUsername;
+
+    @Value("${spring.datasource.password}")
+    private String databasePassword;
+
     private Path backupPath = Paths.get("configs/db/backup/");
 
     @Override
@@ -134,7 +140,8 @@ public class DatabaseBackupHelper implements DatabaseBackupInterface {
                 this.getBackupFilePath("backup_" + dateNow.format(myFormatObj) + ".sql");
         String query = "SCRIPT SIMPLE COLUMNS DROP to ?;";
 
-        try (Connection conn = DriverManager.getConnection(url, "sa", "");
+        try (Connection conn =
+                        DriverManager.getConnection(url, databaseUsername, databasePassword);
                 PreparedStatement stmt = conn.prepareStatement(query)) {
             stmt.setString(1, insertOutputFilePath.toString());
             stmt.execute();
@@ -147,7 +154,8 @@ public class DatabaseBackupHelper implements DatabaseBackupInterface {
     // Retrieves the H2 database version.
     public String getH2Version() {
         String version = "Unknown";
-        try (Connection conn = DriverManager.getConnection(url, "sa", "")) {
+        try (Connection conn =
+                DriverManager.getConnection(url, databaseUsername, databasePassword)) {
             try (Statement stmt = conn.createStatement();
                     ResultSet rs = stmt.executeQuery("SELECT H2VERSION() AS version")) {
                 if (rs.next()) {
@@ -163,6 +171,10 @@ public class DatabaseBackupHelper implements DatabaseBackupInterface {
 
     // Deletes a backup file.
     public boolean deleteBackupFile(String fileName) throws IOException {
+        if (!isValidFileName(fileName)) {
+            log.error("Invalid file name: {}", fileName);
+            return false;
+        }
         Path filePath = this.getBackupFilePath(fileName);
         if (Files.deleteIfExists(filePath)) {
             log.info("Deleted backup file: {}", fileName);
@@ -175,13 +187,18 @@ public class DatabaseBackupHelper implements DatabaseBackupInterface {
 
     // Gets the Path object for a given backup file name.
     public Path getBackupFilePath(String fileName) {
-        return Paths.get(backupPath.toString(), fileName);
+        Path filePath = Paths.get(backupPath.toString(), fileName).normalize();
+        if (!filePath.startsWith(backupPath)) {
+            throw new SecurityException("Path traversal detected");
+        }
+        return filePath;
     }
 
     private boolean executeDatabaseScript(Path scriptPath) {
         String query = "RUNSCRIPT from ?;";
 
-        try (Connection conn = DriverManager.getConnection(url, "sa", "");
+        try (Connection conn =
+                        DriverManager.getConnection(url, databaseUsername, databasePassword);
                 PreparedStatement stmt = conn.prepareStatement(query)) {
             stmt.setString(1, scriptPath.toString());
             stmt.execute();
@@ -202,4 +219,19 @@ public class DatabaseBackupHelper implements DatabaseBackupInterface {
             }
         }
     }
+
+    private boolean isValidFileName(String fileName) {
+        // Check for invalid characters or sequences
+        return fileName != null
+                && !fileName.contains("..")
+                && !fileName.contains("/")
+                && !fileName.contains("\\")
+                && !fileName.contains(":")
+                && !fileName.contains("*")
+                && !fileName.contains("?")
+                && !fileName.contains("\"")
+                && !fileName.contains("<")
+                && !fileName.contains(">")
+                && !fileName.contains("|");
+    }
 }

src/main/java/stirling/software/SPDF/config/security/oauth2/CustomOAuth2AuthenticationFailureHandler.java

@@ -51,8 +51,7 @@ public class CustomOAuth2AuthenticationFailureHandler
             }
             log.error("OAuth2 Authentication error: " + errorCode);
             log.error("OAuth2AuthenticationException", exception);
-            getRedirectStrategy()
-                    .sendRedirect(request, response, "/logout?erroroauth=" + errorCode);
+            getRedirectStrategy().sendRedirect(request, response, "/login?erroroauth=" + errorCode);
             return;
         }
         log.error("Unhandled authentication exception", exception);

src/main/java/stirling/software/SPDF/config/security/oauth2/CustomOAuth2AuthenticationSuccessHandler.java

@@ -66,7 +66,7 @@ public class CustomOAuth2AuthenticationSuccessHandler
             // Redirect to the original destination
             super.onAuthenticationSuccess(request, response, authentication);
         } else {
-            OAUTH2 oAuth = applicationProperties.getSecurity().getOAUTH2();
+            OAUTH2 oAuth = applicationProperties.getSecurity().getOauth2();
 
             if (loginAttemptService.isBlocked(username)) {
                 if (session != null) {
@@ -75,10 +75,14 @@ public class CustomOAuth2AuthenticationSuccessHandler
                 throw new LockedException(
                         "Your account has been locked due to too many failed login attempts.");
             }
+            if (userService.isUserDisabled(username)) {
+                getRedirectStrategy()
+                        .sendRedirect(request, response, "/logout?userIsDisabled=true");
+                return;
+            }
             if (userService.usernameExistsIgnoreCase(username)
                     && userService.hasPassword(username)
-                    && !userService.isAuthenticationTypeByUsername(
-                            username, AuthenticationType.OAUTH2)
+                    && !userService.isAuthenticationTypeByUsername(username, AuthenticationType.SSO)
                     && oAuth.getAutoCreateUser()) {
                 response.sendRedirect(contextPath + "/logout?oauth2AuthenticationErrorWeb=true");
                 return;
@@ -90,7 +94,7 @@ public class CustomOAuth2AuthenticationSuccessHandler
                     return;
                 }
                 if (principal instanceof OAuth2User) {
-                    userService.processOAuth2PostLogin(username, oAuth.getAutoCreateUser());
+                    userService.processSSOPostLogin(username, oAuth.getAutoCreateUser());
                 }
                 response.sendRedirect(contextPath + "/");
                 return;

src/main/java/stirling/software/SPDF/config/security/oauth2/CustomOAuth2LogoutSuccessHandler.java

@@ -1,122 +0,0 @@
-package stirling.software.SPDF.config.security.oauth2;
-
-import java.io.IOException;
-
-import org.springframework.security.core.Authentication;
-import org.springframework.security.oauth2.client.authentication.OAuth2AuthenticationToken;
-import org.springframework.security.web.authentication.logout.SimpleUrlLogoutSuccessHandler;
-
-import jakarta.servlet.ServletException;
-import jakarta.servlet.http.HttpServletRequest;
-import jakarta.servlet.http.HttpServletResponse;
-import lombok.extern.slf4j.Slf4j;
-import stirling.software.SPDF.model.ApplicationProperties;
-import stirling.software.SPDF.model.ApplicationProperties.Security.OAUTH2;
-import stirling.software.SPDF.model.Provider;
-import stirling.software.SPDF.model.provider.UnsupportedProviderException;
-import stirling.software.SPDF.utils.UrlUtils;
-
-@Slf4j
-public class CustomOAuth2LogoutSuccessHandler extends SimpleUrlLogoutSuccessHandler {
-
-    private final ApplicationProperties applicationProperties;
-
-    public CustomOAuth2LogoutSuccessHandler(ApplicationProperties applicationProperties) {
-        this.applicationProperties = applicationProperties;
-    }
-
-    @Override
-    public void onLogoutSuccess(
-            HttpServletRequest request, HttpServletResponse response, Authentication authentication)
-            throws IOException, ServletException {
-        String param = "logout=true";
-        String registrationId = null;
-        String issuer = null;
-        String clientId = null;
-
-        if (authentication == null) {
-            if (request.getParameter("userIsDisabled") != null) {
-                response.sendRedirect(
-                        request.getContextPath() + "/login?erroroauth=userIsDisabled");
-            } else {
-                super.onLogoutSuccess(request, response, authentication);
-            }
-            return;
-        }
-        OAUTH2 oauth = applicationProperties.getSecurity().getOAUTH2();
-
-        if (authentication instanceof OAuth2AuthenticationToken) {
-            OAuth2AuthenticationToken oauthToken = (OAuth2AuthenticationToken) authentication;
-            registrationId = oauthToken.getAuthorizedClientRegistrationId();
-
-            try {
-                Provider provider = oauth.getClient().get(registrationId);
-                issuer = provider.getIssuer();
-                clientId = provider.getClientId();
-            } catch (UnsupportedProviderException e) {
-                log.error(e.getMessage());
-            }
-        } else {
-            registrationId = oauth.getProvider() != null ? oauth.getProvider() : "";
-            issuer = oauth.getIssuer();
-            clientId = oauth.getClientId();
-        }
-        String errorMessage = "";
-        if (request.getParameter("oauth2AuthenticationErrorWeb") != null) {
-            param = "erroroauth=oauth2AuthenticationErrorWeb";
-        } else if ((errorMessage = request.getParameter("error")) != null) {
-            param = "error=" + sanitizeInput(errorMessage);
-        } else if ((errorMessage = request.getParameter("erroroauth")) != null) {
-            param = "erroroauth=" + sanitizeInput(errorMessage);
-        } else if (request.getParameter("oauth2AutoCreateDisabled") != null) {
-            param = "error=oauth2AutoCreateDisabled";
-        } else if (request.getParameter("oauth2_admin_blocked_user") != null) {
-            param = "erroroauth=oauth2_admin_blocked_user";
-        } else if (request.getParameter("userIsDisabled") != null) {
-            param = "erroroauth=userIsDisabled";
-        } else if (request.getParameter("badcredentials") != null) {
-            param = "error=badcredentials";
-        }
-
-        String redirect_url = UrlUtils.getOrigin(request) + "/login?" + param;
-
-        switch (registrationId.toLowerCase()) {
-            case "keycloak":
-                // Add Keycloak specific logout URL if needed
-                String logoutUrl =
-                        issuer
-                                + "/protocol/openid-connect/logout"
-                                + "?client_id="
-                                + clientId
-                                + "&post_logout_redirect_uri="
-                                + response.encodeRedirectURL(redirect_url);
-                log.info("Redirecting to Keycloak logout URL: " + logoutUrl);
-                response.sendRedirect(logoutUrl);
-                break;
-            case "github":
-                // Add GitHub specific logout URL if needed
-                String githubLogoutUrl = "https://github.com/logout";
-                log.info("Redirecting to GitHub logout URL: " + githubLogoutUrl);
-                response.sendRedirect(githubLogoutUrl);
-                break;
-            case "google":
-                // Add Google specific logout URL if needed
-                // String googleLogoutUrl =
-                // "https://accounts.google.com/Logout?continue=https://appengine.google.com/_ah/logout?continue="
-                //                 + response.encodeRedirectURL(redirect_url);
-                log.info("Google does not have a specific logout URL");
-                // log.info("Redirecting to Google logout URL: " + googleLogoutUrl);
-                // response.sendRedirect(googleLogoutUrl);
-                // break;
-            default:
-                String defaultRedirectUrl = request.getContextPath() + "/login?" + param;
-                log.info("Redirecting to default logout URL: " + defaultRedirectUrl);
-                response.sendRedirect(defaultRedirectUrl);
-                break;
-        }
-    }
-
-    private String sanitizeInput(String input) {
-        return input.replaceAll("[^a-zA-Z0-9 ]", "");
-    }
-}

src/main/java/stirling/software/SPDF/config/security/oauth2/CustomOAuth2UserService.java

@@ -43,7 +43,7 @@ public class CustomOAuth2UserService implements OAuth2UserService<OidcUserReques
 
     @Override
     public OidcUser loadUser(OidcUserRequest userRequest) throws OAuth2AuthenticationException {
-        OAUTH2 oauth2 = applicationProperties.getSecurity().getOAUTH2();
+        OAUTH2 oauth2 = applicationProperties.getSecurity().getOauth2();
         String usernameAttribute = oauth2.getUseAsUsername();
         if (usernameAttribute == null || usernameAttribute.trim().isEmpty()) {
             Client client = oauth2.getClient();

src/main/java/stirling/software/SPDF/config/security/saml2/CertificateUtils.java

@@ -0,0 +1,55 @@
+package stirling.software.SPDF.config.security.saml2;
+
+import java.io.ByteArrayInputStream;
+import java.io.InputStreamReader;
+import java.nio.charset.StandardCharsets;
+import java.security.cert.CertificateFactory;
+import java.security.cert.X509Certificate;
+import java.security.interfaces.RSAPrivateKey;
+
+import org.bouncycastle.asn1.pkcs.PrivateKeyInfo;
+import org.bouncycastle.openssl.PEMKeyPair;
+import org.bouncycastle.openssl.PEMParser;
+import org.bouncycastle.openssl.jcajce.JcaPEMKeyConverter;
+import org.bouncycastle.util.io.pem.PemObject;
+import org.bouncycastle.util.io.pem.PemReader;
+import org.springframework.core.io.Resource;
+
+public class CertificateUtils {
+
+    public static X509Certificate readCertificate(Resource certificateResource) throws Exception {
+        try (PemReader pemReader =
+                new PemReader(
+                        new InputStreamReader(
+                                certificateResource.getInputStream(), StandardCharsets.UTF_8))) {
+            PemObject pemObject = pemReader.readPemObject();
+            byte[] decodedCert = pemObject.getContent();
+            CertificateFactory cf = CertificateFactory.getInstance("X.509");
+            return (X509Certificate) cf.generateCertificate(new ByteArrayInputStream(decodedCert));
+        }
+    }
+
+    public static RSAPrivateKey readPrivateKey(Resource privateKeyResource) throws Exception {
+        try (PEMParser pemParser =
+                new PEMParser(
+                        new InputStreamReader(
+                                privateKeyResource.getInputStream(), StandardCharsets.UTF_8))) {
+
+            Object object = pemParser.readObject();
+            JcaPEMKeyConverter converter = new JcaPEMKeyConverter();
+
+            if (object instanceof PEMKeyPair) {
+                // Handle traditional RSA private key format
+                PEMKeyPair keypair = (PEMKeyPair) object;
+                return (RSAPrivateKey) converter.getPrivateKey(keypair.getPrivateKeyInfo());
+            } else if (object instanceof PrivateKeyInfo) {
+                // Handle PKCS#8 format
+                return (RSAPrivateKey) converter.getPrivateKey((PrivateKeyInfo) object);
+            } else {
+                throw new IllegalArgumentException(
+                        "Unsupported key format: "
+                                + (object != null ? object.getClass().getName() : "null"));
+            }
+        }
+    }
+}

src/main/java/stirling/software/SPDF/config/security/saml2/CustomSaml2AuthenticatedPrincipal.java

@@ -0,0 +1,45 @@
+package stirling.software.SPDF.config.security.saml2;
+
+import java.io.Serializable;
+import java.util.List;
+import java.util.Map;
+
+import org.springframework.security.saml2.provider.service.authentication.Saml2AuthenticatedPrincipal;
+
+public class CustomSaml2AuthenticatedPrincipal
+        implements Saml2AuthenticatedPrincipal, Serializable {
+
+    private final String name;
+    private final Map<String, List<Object>> attributes;
+    private final String nameId;
+    private final List<String> sessionIndexes;
+
+    public CustomSaml2AuthenticatedPrincipal(
+            String name,
+            Map<String, List<Object>> attributes,
+            String nameId,
+            List<String> sessionIndexes) {
+        this.name = name;
+        this.attributes = attributes;
+        this.nameId = nameId;
+        this.sessionIndexes = sessionIndexes;
+    }
+
+    @Override
+    public String getName() {
+        return this.name;
+    }
+
+    @Override
+    public Map<String, List<Object>> getAttributes() {
+        return this.attributes;
+    }
+
+    public String getNameId() {
+        return this.nameId;
+    }
+
+    public List<String> getSessionIndexes() {
+        return this.sessionIndexes;
+    }
+}

src/main/java/stirling/software/SPDF/config/security/saml2/CustomSaml2AuthenticationFailureHandler.java

@@ -0,0 +1,38 @@
+package stirling.software.SPDF.config.security.saml2;
+
+import java.io.IOException;
+
+import org.springframework.security.authentication.ProviderNotFoundException;
+import org.springframework.security.core.AuthenticationException;
+import org.springframework.security.saml2.core.Saml2Error;
+import org.springframework.security.saml2.provider.service.authentication.Saml2AuthenticationException;
+import org.springframework.security.web.authentication.SimpleUrlAuthenticationFailureHandler;
+
+import jakarta.servlet.ServletException;
+import jakarta.servlet.http.HttpServletRequest;
+import jakarta.servlet.http.HttpServletResponse;
+import lombok.extern.slf4j.Slf4j;
+
+@Slf4j
+public class CustomSaml2AuthenticationFailureHandler extends SimpleUrlAuthenticationFailureHandler {
+
+    @Override
+    public void onAuthenticationFailure(
+            HttpServletRequest request,
+            HttpServletResponse response,
+            AuthenticationException exception)
+            throws IOException, ServletException {
+        if (exception instanceof Saml2AuthenticationException) {
+            Saml2Error error = ((Saml2AuthenticationException) exception).getSaml2Error();
+            getRedirectStrategy()
+                    .sendRedirect(request, response, "/login?erroroauth=" + error.getErrorCode());
+        } else if (exception instanceof ProviderNotFoundException) {
+            getRedirectStrategy()
+                    .sendRedirect(
+                            request,
+                            response,
+                            "/login?erroroauth=not_authentication_provider_found");
+        }
+        log.error("AuthenticationException: " + exception);
+    }
+}

src/main/java/stirling/software/SPDF/config/security/saml2/CustomSaml2AuthenticationSuccessHandler.java

@@ -0,0 +1,125 @@
+package stirling.software.SPDF.config.security.saml2;
+
+import java.io.IOException;
+
+import org.springframework.security.authentication.LockedException;
+import org.springframework.security.core.Authentication;
+import org.springframework.security.web.authentication.SavedRequestAwareAuthenticationSuccessHandler;
+import org.springframework.security.web.savedrequest.SavedRequest;
+
+import jakarta.servlet.ServletException;
+import jakarta.servlet.http.HttpServletRequest;
+import jakarta.servlet.http.HttpServletResponse;
+import jakarta.servlet.http.HttpSession;
+import lombok.AllArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import stirling.software.SPDF.config.security.LoginAttemptService;
+import stirling.software.SPDF.config.security.UserService;
+import stirling.software.SPDF.model.ApplicationProperties;
+import stirling.software.SPDF.model.ApplicationProperties.Security.SAML2;
+import stirling.software.SPDF.model.AuthenticationType;
+import stirling.software.SPDF.utils.RequestUriUtils;
+
+@AllArgsConstructor
+@Slf4j
+public class CustomSaml2AuthenticationSuccessHandler
+        extends SavedRequestAwareAuthenticationSuccessHandler {
+
+    private LoginAttemptService loginAttemptService;
+    private ApplicationProperties applicationProperties;
+    private UserService userService;
+
+    @Override
+    public void onAuthenticationSuccess(
+            HttpServletRequest request, HttpServletResponse response, Authentication authentication)
+            throws ServletException, IOException {
+
+        Object principal = authentication.getPrincipal();
+        log.debug("Starting SAML2 authentication success handling");
+
+        if (principal instanceof CustomSaml2AuthenticatedPrincipal) {
+            String username = ((CustomSaml2AuthenticatedPrincipal) principal).getName();
+            log.debug("Authenticated principal found for user: {}", username);
+
+            HttpSession session = request.getSession(false);
+            String contextPath = request.getContextPath();
+            SavedRequest savedRequest =
+                    (session != null)
+                            ? (SavedRequest) session.getAttribute("SPRING_SECURITY_SAVED_REQUEST")
+                            : null;
+
+            log.debug(
+                    "Session exists: {}, Saved request exists: {}",
+                    session != null,
+                    savedRequest != null);
+
+            if (savedRequest != null
+                    && !RequestUriUtils.isStaticResource(
+                            contextPath, savedRequest.getRedirectUrl())) {
+                log.debug(
+                        "Valid saved request found, redirecting to original destination: {}",
+                        savedRequest.getRedirectUrl());
+                super.onAuthenticationSuccess(request, response, authentication);
+            } else {
+                SAML2 saml2 = applicationProperties.getSecurity().getSaml2();
+                log.debug(
+                        "Processing SAML2 authentication with autoCreateUser: {}",
+                        saml2.getAutoCreateUser());
+
+                if (loginAttemptService.isBlocked(username)) {
+                    log.debug("User {} is blocked due to too many login attempts", username);
+                    if (session != null) {
+                        session.removeAttribute("SPRING_SECURITY_SAVED_REQUEST");
+                    }
+                    throw new LockedException(
+                            "Your account has been locked due to too many failed login attempts.");
+                }
+
+                boolean userExists = userService.usernameExistsIgnoreCase(username);
+                boolean hasPassword = userExists && userService.hasPassword(username);
+                boolean isSSOUser =
+                        userExists
+                                && userService.isAuthenticationTypeByUsername(
+                                        username, AuthenticationType.SSO);
+
+                log.debug(
+                        "User status - Exists: {}, Has password: {}, Is SSO user: {}",
+                        userExists,
+                        hasPassword,
+                        isSSOUser);
+
+                if (userExists && hasPassword && !isSSOUser && saml2.getAutoCreateUser()) {
+                    log.debug(
+                            "User {} exists with password but is not SSO user, redirecting to logout",
+                            username);
+                    response.sendRedirect(
+                            contextPath + "/logout?oauth2AuthenticationErrorWeb=true");
+                    return;
+                }
+
+                try {
+                    if (saml2.getBlockRegistration() && !userExists) {
+                        log.debug("Registration blocked for new user: {}", username);
+                        response.sendRedirect(
+                                contextPath + "/login?erroroauth=oauth2_admin_blocked_user");
+                        return;
+                    }
+                    log.debug("Processing SSO post-login for user: {}", username);
+                    userService.processSSOPostLogin(username, saml2.getAutoCreateUser());
+                    log.debug("Successfully processed authentication for user: {}", username);
+                    response.sendRedirect(contextPath + "/");
+                    return;
+                } catch (IllegalArgumentException e) {
+                    log.debug(
+                            "Invalid username detected for user: {}, redirecting to logout",
+                            username);
+                    response.sendRedirect(contextPath + "/logout?invalidUsername=true");
+                    return;
+                }
+            }
+        } else {
+            log.debug("Non-SAML2 principal detected, delegating to parent handler");
+            super.onAuthenticationSuccess(request, response, authentication);
+        }
+    }
+}

src/main/java/stirling/software/SPDF/config/security/saml2/CustomSaml2ResponseAuthenticationConverter.java

@@ -0,0 +1,117 @@
+package stirling.software.SPDF.config.security.saml2;
+
+import java.util.*;
+
+import org.opensaml.core.xml.XMLObject;
+import org.opensaml.saml.saml2.core.Assertion;
+import org.opensaml.saml.saml2.core.Attribute;
+import org.opensaml.saml.saml2.core.AttributeStatement;
+import org.opensaml.saml.saml2.core.AuthnStatement;
+import org.springframework.core.convert.converter.Converter;
+import org.springframework.security.core.authority.SimpleGrantedAuthority;
+import org.springframework.security.saml2.provider.service.authentication.OpenSaml4AuthenticationProvider.ResponseToken;
+import org.springframework.security.saml2.provider.service.authentication.Saml2Authentication;
+import org.springframework.stereotype.Component;
+
+import lombok.extern.slf4j.Slf4j;
+import stirling.software.SPDF.config.security.UserService;
+import stirling.software.SPDF.model.User;
+
+@Component
+@Slf4j
+public class CustomSaml2ResponseAuthenticationConverter
+        implements Converter<ResponseToken, Saml2Authentication> {
+
+    private UserService userService;
+
+    public CustomSaml2ResponseAuthenticationConverter(UserService userService) {
+        this.userService = userService;
+    }
+
+    private Map<String, List<Object>> extractAttributes(Assertion assertion) {
+        Map<String, List<Object>> attributes = new HashMap<>();
+
+        for (AttributeStatement attributeStatement : assertion.getAttributeStatements()) {
+            for (Attribute attribute : attributeStatement.getAttributes()) {
+                String attributeName = attribute.getName();
+                List<Object> values = new ArrayList<>();
+
+                for (XMLObject xmlObject : attribute.getAttributeValues()) {
+                    // Get the text content directly
+                    String value = xmlObject.getDOM().getTextContent();
+                    if (value != null && !value.trim().isEmpty()) {
+                        values.add(value);
+                    }
+                }
+
+                if (!values.isEmpty()) {
+                    // Store with both full URI and last part of the URI
+                    attributes.put(attributeName, values);
+                    String shortName = attributeName.substring(attributeName.lastIndexOf('/') + 1);
+                    attributes.put(shortName, values);
+                }
+            }
+        }
+
+        return attributes;
+    }
+
+    @Override
+    public Saml2Authentication convert(ResponseToken responseToken) {
+        Assertion assertion = responseToken.getResponse().getAssertions().get(0);
+        Map<String, List<Object>> attributes = extractAttributes(assertion);
+
+        // Debug log with actual values
+        log.debug("Extracted SAML Attributes: " + attributes);
+
+        // Try to get username/identifier in order of preference
+        String userIdentifier = null;
+        if (hasAttribute(attributes, "username")) {
+            userIdentifier = getFirstAttributeValue(attributes, "username");
+        } else if (hasAttribute(attributes, "emailaddress")) {
+            userIdentifier = getFirstAttributeValue(attributes, "emailaddress");
+        } else if (hasAttribute(attributes, "name")) {
+            userIdentifier = getFirstAttributeValue(attributes, "name");
+        } else if (hasAttribute(attributes, "upn")) {
+            userIdentifier = getFirstAttributeValue(attributes, "upn");
+        } else if (hasAttribute(attributes, "uid")) {
+            userIdentifier = getFirstAttributeValue(attributes, "uid");
+        } else {
+            userIdentifier = assertion.getSubject().getNameID().getValue();
+        }
+
+        // Rest of your existing code...
+        Optional<User> userOpt = userService.findByUsernameIgnoreCase(userIdentifier);
+        SimpleGrantedAuthority simpleGrantedAuthority = new SimpleGrantedAuthority("ROLE_USER");
+        if (userOpt.isPresent()) {
+            User user = userOpt.get();
+            if (user != null) {
+                simpleGrantedAuthority =
+                        new SimpleGrantedAuthority(userService.findRole(user).getAuthority());
+            }
+        }
+
+        List<String> sessionIndexes = new ArrayList<>();
+        for (AuthnStatement authnStatement : assertion.getAuthnStatements()) {
+            sessionIndexes.add(authnStatement.getSessionIndex());
+        }
+
+        CustomSaml2AuthenticatedPrincipal principal =
+                new CustomSaml2AuthenticatedPrincipal(
+                        userIdentifier, attributes, userIdentifier, sessionIndexes);
+
+        return new Saml2Authentication(
+                principal,
+                responseToken.getToken().getSaml2Response(),
+                Collections.singletonList(simpleGrantedAuthority));
+    }
+
+    private boolean hasAttribute(Map<String, List<Object>> attributes, String name) {
+        return attributes.containsKey(name) && !attributes.get(name).isEmpty();
+    }
+
+    private String getFirstAttributeValue(Map<String, List<Object>> attributes, String name) {
+        List<Object> values = attributes.get(name);
+        return values != null && !values.isEmpty() ? values.get(0).toString() : null;
+    }
+}

src/main/java/stirling/software/SPDF/config/security/session/CustomHttpSessionListener.java

@@ -11,16 +11,19 @@ import lombok.extern.slf4j.Slf4j;
 @Slf4j
 public class CustomHttpSessionListener implements HttpSessionListener {
 
-    @Autowired private SessionPersistentRegistry sessionPersistentRegistry;
+    private SessionPersistentRegistry sessionPersistentRegistry;
+
+    @Autowired
+    public CustomHttpSessionListener(SessionPersistentRegistry sessionPersistentRegistry) {
+        super();
+        this.sessionPersistentRegistry = sessionPersistentRegistry;
+    }
 
     @Override
-    public void sessionCreated(HttpSessionEvent se) {
-        log.info("Session created: " + se.getSession().getId());
-    }
+    public void sessionCreated(HttpSessionEvent se) {}
 
     @Override
     public void sessionDestroyed(HttpSessionEvent se) {
-        log.info("Session destroyed: " + se.getSession().getId());
         sessionPersistentRegistry.expireSession(se.getSession().getId());
     }
 }

src/main/java/stirling/software/SPDF/config/security/session/SessionPersistentRegistry.java

@@ -16,6 +16,7 @@ import org.springframework.security.oauth2.core.user.OAuth2User;
 import org.springframework.stereotype.Component;
 
 import jakarta.transaction.Transactional;
+import stirling.software.SPDF.config.security.saml2.CustomSaml2AuthenticatedPrincipal;
 import stirling.software.SPDF.model.SessionEntity;
 
 @Component
@@ -50,6 +51,8 @@ public class SessionPersistentRegistry implements SessionRegistry {
             principalName = ((UserDetails) principal).getUsername();
         } else if (principal instanceof OAuth2User) {
             principalName = ((OAuth2User) principal).getName();
+        } else if (principal instanceof CustomSaml2AuthenticatedPrincipal) {
+            principalName = ((CustomSaml2AuthenticatedPrincipal) principal).getName();
         } else if (principal instanceof String) {
             principalName = (String) principal;
         }
@@ -79,11 +82,21 @@ public class SessionPersistentRegistry implements SessionRegistry {
             principalName = ((UserDetails) principal).getUsername();
         } else if (principal instanceof OAuth2User) {
             principalName = ((OAuth2User) principal).getName();
+        } else if (principal instanceof CustomSaml2AuthenticatedPrincipal) {
+            principalName = ((CustomSaml2AuthenticatedPrincipal) principal).getName();
         } else if (principal instanceof String) {
             principalName = (String) principal;
         }
 
         if (principalName != null) {
+            // Clear old sessions for the principal (unsure if needed)
+            //            List<SessionEntity> existingSessions =
+            //                    sessionRepository.findByPrincipalName(principalName);
+            //            for (SessionEntity session : existingSessions) {
+            //                session.setExpired(true);
+            //                sessionRepository.save(session);
+            //            }
+
             SessionEntity sessionEntity = new SessionEntity();
             sessionEntity.setSessionId(sessionId);
             sessionEntity.setPrincipalName(principalName);

src/main/java/stirling/software/SPDF/controller/api/AdditionalLanguageJsController.java

@@ -0,0 +1,65 @@
+package stirling.software.SPDF.controller.api;
+
+import java.io.IOException;
+import java.io.PrintWriter;
+import java.util.List;
+
+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 io.swagger.v3.oas.annotations.Hidden;
+
+import jakarta.servlet.http.HttpServletResponse;
+import stirling.software.SPDF.service.LanguageService;
+
+@RestController
+@RequestMapping("/js")
+public class AdditionalLanguageJsController {
+
+    @Autowired private LanguageService languageService;
+
+    @Hidden
+    @GetMapping(value = "/additionalLanguageCode.js", produces = "application/javascript")
+    public void generateAdditionalLanguageJs(HttpServletResponse response) throws IOException {
+        List<String> supportedLanguages = languageService.getSupportedLanguages();
+
+        response.setContentType("application/javascript");
+        PrintWriter writer = response.getWriter();
+
+        // Erstelle das JavaScript dynamisch
+        writer.println("const supportedLanguages = " + toJsonArray(supportedLanguages) + ";");
+
+        // Generiere die `getDetailedLanguageCode`-Funktion
+        writer.println(
+                """
+                function getDetailedLanguageCode() {
+                    const userLanguages = navigator.languages ? navigator.languages : [navigator.language];
+                    for (let lang of userLanguages) {
+                        let matchedLang = supportedLanguages.find(supportedLang => supportedLang.startsWith(lang.replace('-', '_')));
+                        if (matchedLang) {
+                            return matchedLang;
+                        }
+                    }
+                    // Fallback
+                    return "en_GB";
+                }
+                """);
+
+        writer.flush();
+    }
+
+    // Hilfsfunktion zum Konvertieren der Liste in ein JSON-Array
+    private String toJsonArray(List<String> list) {
+        StringBuilder jsonArray = new StringBuilder("[");
+        for (int i = 0; i < list.size(); i++) {
+            jsonArray.append("\"").append(list.get(i)).append("\"");
+            if (i < list.size() - 1) {
+                jsonArray.append(",");
+            }
+        }
+        jsonArray.append("]");
+        return jsonArray.toString();
+    }
+}

src/main/java/stirling/software/SPDF/controller/api/CropController.java

@@ -13,6 +13,7 @@ import org.apache.pdfbox.pdmodel.common.PDRectangle;
 import org.apache.pdfbox.pdmodel.graphics.form.PDFormXObject;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
+import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.ModelAttribute;
 import org.springframework.web.bind.annotation.PostMapping;
@@ -23,6 +24,8 @@ import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.tags.Tag;
 
 import stirling.software.SPDF.model.api.general.CropPdfForm;
+import stirling.software.SPDF.service.CustomPDDocumentFactory;
+import stirling.software.SPDF.service.PostHogService;
 import stirling.software.SPDF.utils.WebResponseUtils;
 
 @RestController
@@ -32,6 +35,17 @@ public class CropController {
 
     private static final Logger logger = LoggerFactory.getLogger(CropController.class);
 
+    private final CustomPDDocumentFactory pdfDocumentFactory;
+
+    private final PostHogService postHogService;
+
+    @Autowired
+    public CropController(
+            CustomPDDocumentFactory pdfDocumentFactory, PostHogService postHogService) {
+        this.pdfDocumentFactory = pdfDocumentFactory;
+        this.postHogService = postHogService;
+    }
+
     @PostMapping(value = "/crop", consumes = "multipart/form-data")
     @Operation(
             summary = "Crops a PDF document",
@@ -40,7 +54,8 @@ public class CropController {
     public ResponseEntity<byte[]> cropPdf(@ModelAttribute CropPdfForm form) throws IOException {
         PDDocument sourceDocument = Loader.loadPDF(form.getFileInput().getBytes());
 
-        PDDocument newDocument = new PDDocument();
+        PDDocument newDocument =
+                pdfDocumentFactory.createNewDocumentBasedOnOldDocument(sourceDocument);
 
         int totalPages = sourceDocument.getNumberOfPages();
 

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

@@ -22,6 +22,7 @@ import org.apache.pdfbox.pdmodel.interactive.form.PDField;
 import org.apache.pdfbox.pdmodel.interactive.form.PDSignatureField;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
+import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.ModelAttribute;
 import org.springframework.web.bind.annotation.PostMapping;
@@ -33,6 +34,7 @@ import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.tags.Tag;
 
 import stirling.software.SPDF.model.api.general.MergePdfsRequest;
+import stirling.software.SPDF.service.CustomPDDocumentFactory;
 import stirling.software.SPDF.utils.GeneralUtils;
 import stirling.software.SPDF.utils.WebResponseUtils;
 
@@ -43,9 +45,16 @@ public class MergeController {
 
     private static final Logger logger = LoggerFactory.getLogger(MergeController.class);
 
+    private final CustomPDDocumentFactory pdfDocumentFactory;
+
+    @Autowired
+    public MergeController(CustomPDDocumentFactory pdfDocumentFactory) {
+        this.pdfDocumentFactory = pdfDocumentFactory;
+    }
+
     // Merges a list of PDDocument objects into a single PDDocument
     public PDDocument mergeDocuments(List<PDDocument> documents) throws IOException {
-        PDDocument mergedDoc = new PDDocument();
+        PDDocument mergedDoc = pdfDocumentFactory.createNewDocument();
         for (PDDocument doc : documents) {
             for (PDPage page : doc.getPages()) {
                 mergedDoc.addPage(page);