Update survey version cache (#3071)

# Description of Changes

Please provide a summary of the changes, including:

- What was changed
- Why the change was made
- Any challenges encountered

Closes #(issue_number)

---

## Checklist

### General

- [ ] I have read the [Contribution
Guidelines](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/CONTRIBUTING.md)
- [ ] I have read the [Stirling-PDF Developer
Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/DeveloperGuide.md)
(if applicable)
- [ ] I have read the [How to add new languages to
Stirling-PDF](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/HowToAddNewLanguage.md)
(if applicable)
- [ ] I have performed a self-review of my own code
- [ ] My changes generate no new warnings

### Documentation

- [ ] I have updated relevant docs on [Stirling-PDF's doc
repo](https://github.com/Stirling-Tools/Stirling-Tools.github.io/blob/main/docs/)
(if functionality has heavily changed)
- [ ] 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)

### UI Changes (if applicable)

- [ ] Screenshots or videos demonstrating the UI changes are attached
(e.g., as comments or direct attachments in the PR)

### Testing (if applicable)

- [ ] I have tested my changes locally. Refer to the [Testing
Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/DeveloperGuide.md#6-testing)
for more details.

.github/CODEOWNERS

@@ -1,2 +1,2 @@
 # All PRs to V1 must be approved by Frooodle
-* @Frooodle @reecebrowne @Ludy87 @DarioGii
+* @Frooodle @reecebrowne @Ludy87 @DarioGii @ConnorYoh

.github/labeler-config.yml

@@ -9,6 +9,7 @@ Front End:
     - any-glob-to-any-file: 'src/main/resources/templates/**/*'
     - any-glob-to-any-file: 'src/main/resources/static/**/*'
     - any-glob-to-any-file: 'src/main/java/stirling/software/SPDF/controller/web/**'
+    - any-glob-to-any-file: 'src/main/java/stirling/software/SPDF/UI/**/*'
 
 Java:
   - changed-files:
@@ -29,6 +30,7 @@ Security:
     - any-glob-to-any-file: 'src/main/java/stirling/software/SPDF/config/security/**/*'
     - 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: 'src/main/java/stirling/software/SPDF/model/BackupNotFoundException.java'
     - any-glob-to-any-file: 'scripts/download-security-jar.sh'
     - any-glob-to-any-file: '.github/workflows/dependency-review.yml'
     - any-glob-to-any-file: '.github/workflows/scorecards.yml'
@@ -49,12 +51,17 @@ Documentation:
 
 Docker:
   - changed-files:
+    - any-glob-to-any-file: '.github/workflows/build.yml'
+    - any-glob-to-any-file: '.github/workflows/push-docker.yml'
     - any-glob-to-any-file: 'Dockerfile'
-    - 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/download-security-jar.sh'
     - 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'
+    - any-glob-to-any-file: 'test.sh'
+    - any-glob-to-any-file: 'test2.sh'
 
 Test:
   - changed-files:

.github/pull_request_template.md

@@ -1,15 +1,34 @@
-# Description
+# Description of Changes
 
-Please provide a summary of the changes, including relevant motivation and context.
+Please provide a summary of the changes, including:
+
+- What was changed
+- Why the change was made
+- Any challenges encountered
 
 Closes #(issue_number)
 
+---
+
 ## Checklist
 
+### General
+
 - [ ] I have read the [Contribution Guidelines](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/CONTRIBUTING.md)
+- [ ] I have read the [Stirling-PDF Developer Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/DeveloperGuide.md) (if applicable)
+- [ ] I have read the [How to add new languages to Stirling-PDF](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/HowToAddNewLanguage.md) (if applicable)
 - [ ] 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
+
+### Documentation
+
+- [ ] I have updated relevant docs on [Stirling-PDF's doc repo](https://github.com/Stirling-Tools/Stirling-Tools.github.io/blob/main/docs/) (if functionality has heavily changed)
 - [ ] 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)
+
+### UI Changes (if applicable)
+
+- [ ] Screenshots or videos demonstrating the UI changes are attached (e.g., as comments or direct attachments in the PR)
+
+### Testing (if applicable)
+
+- [ ] I have tested my changes locally. Refer to the [Testing Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/DeveloperGuide.md#6-testing) for more details.

.github/release.yml

@@ -1,10 +1,4 @@
 changelog:
-  exclude:
-    labels:
-      - Documentation
-      - Test
-      - Github
-
   categories:
     - title: Bug Fixes
       labels:

.github/scripts/check_duplicates.py

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

.github/scripts/check_language_properties.py

@@ -11,6 +11,8 @@ 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>]
 """
+# Sample for Windows:
+# python .github/scripts/check_language_properties.py --reference-file src\main\resources\messages_en_GB.properties --branch "" --files src\main\resources\messages_de_DE.properties src\main\resources\messages_uk_UA.properties
 
 import copy
 import glob
@@ -19,25 +21,60 @@ import argparse
 import re
 
 
+def find_duplicate_keys(file_path):
+    """
+    Identifies duplicate keys in a .properties file.
+    :param file_path: Path to the .properties file.
+    :return: List of tuples (key, first_occurrence_line, duplicate_line).
+    """
+    keys = {}
+    duplicates = []
+
+    with open(file_path, "r", encoding="utf-8") as file:
+        for line_number, line in enumerate(file, start=1):
+            stripped_line = line.strip()
+
+            # Skip empty lines and comments
+            if not stripped_line or stripped_line.startswith("#"):
+                continue
+
+            # Split the line into key and value
+            if "=" in stripped_line:
+                key, _ = stripped_line.split("=", 1)
+                key = key.strip()
+
+                # Check if the key already exists
+                if key in keys:
+                    duplicates.append((key, keys[key], line_number))
+                else:
+                    keys[key] = line_number
+
+    return duplicates
+
+
 # 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)."""
+    """
+    Parses a .properties file and returns a structured list of its contents.
+    :param file_path: Path to the .properties file.
+    :return: List of dictionaries representing each line in the file.
+    """
     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
+            # Handle empty lines
             if not stripped_line:
                 properties_list.append(
                     {"line_number": line_number, "type": "empty", "content": ""}
                 )
                 continue
 
-            # Comments
+            # Handle comments
             if stripped_line.startswith("#"):
                 properties_list.append(
                     {
@@ -48,7 +85,7 @@ def parse_properties_file(file_path):
                 )
                 continue
 
-            # Key-value pairs
+            # Handle key-value pairs
             match = re.match(r"^([^=]+)=(.*)$", line)
             if match:
                 key, value = match.groups()
@@ -65,9 +102,14 @@ def parse_properties_file(file_path):
 
 
 def write_json_file(file_path, updated_properties):
+    """
+    Writes updated properties back to the file in their original format.
+    :param file_path: Path to the .properties file.
+    :param updated_properties: List of updated properties to write.
+    """
     updated_lines = {entry["line_number"]: entry for entry in updated_properties}
 
-    # Sort by line numbers and retain comments and empty lines
+    # Sort lines by their numbers and retain comments and empty lines
     all_lines = sorted(set(updated_lines.keys()))
 
     original_format = []
@@ -86,8 +128,8 @@ def write_json_file(file_path, updated_properties):
             # 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:
+    # Write the updated content back to the file
+    with open(file_path, "w", encoding="utf-8", newline="\n") as file:
         for entry in original_format:
             if entry["type"] == "comment":
                 file.write(f"{entry['content']}\n")
@@ -98,6 +140,12 @@ def write_json_file(file_path, updated_properties):
 
 
 def update_missing_keys(reference_file, file_list, branch=""):
+    """
+    Updates missing keys in the translation files based on the reference file.
+    :param reference_file: Path to the reference .properties file.
+    :param file_list: List of translation files to update.
+    :param branch: Branch where the files are located.
+    """
     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))
@@ -116,7 +164,7 @@ def update_missing_keys(reference_file, file_list, branch=""):
                 if current_entry["type"] == "entry":
                     if ref_entry_copy["type"] != "entry":
                         continue
-                    if ref_entry_copy["key"] == current_entry["key"]:
+                    if ref_entry_copy["key"].lower() == current_entry["key"].lower():
                         ref_entry_copy["value"] = current_entry["value"]
             updated_properties.append(ref_entry_copy)
         write_json_file(os.path.join(branch, file_path), updated_properties)
@@ -151,23 +199,30 @@ def check_for_differences(reference_file, file_list, branch, actor):
     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)
+        file_normpath = os.path.normpath(file_path)
+        absolute_path = os.path.abspath(file_normpath)
         # Verify that file is within the expected directory
         if not absolute_path.startswith(base_dir):
-            raise ValueError(f"Unsafe file found: {file_path}")
+            raise ValueError(f"Unsafe file found: {file_normpath}")
         # Verify file size before processing
-        if os.path.getsize(os.path.join(branch, file_path)) > MAX_FILE_SIZE:
+        if os.path.getsize(os.path.join(branch, file_normpath)) > MAX_FILE_SIZE:
             raise ValueError(
-                f"The file {file_path} is too large and could pose a security risk."
+                f"The file {file_normpath} is too large and could pose a security risk."
             )
 
-        basename_current_file = os.path.basename(os.path.join(branch, file_path))
+        basename_current_file = os.path.basename(os.path.join(branch, file_normpath))
         if (
             basename_current_file == basename_reference_file
-            or not file_path.startswith(
-                os.path.join("src", "main", "resources", "messages_")
+            or (
+                # only local windows command
+                not file_normpath.startswith(
+                    os.path.join("", "src", "main", "resources", "messages_")
+                )
+                and not file_normpath.startswith(
+                    os.path.join(os.getcwd(), "src", "main", "resources", "messages_")
+                )
             )
-            or not file_path.endswith(".properties")
+            or not file_normpath.endswith(".properties")
             or not basename_current_file.startswith("messages_")
         ):
             continue
@@ -237,6 +292,24 @@ def check_for_differences(reference_file, file_list, branch, actor):
                 )
         else:
             report.append("2. **Test Status:** ✅ **_Passed_**")
+
+        if find_duplicate_keys(os.path.join(branch, file_normpath)):
+            has_differences = True
+            output = "\n".join(
+                [
+                    f"      - `{key}`: first at line {first}, duplicate at `line {duplicate}`"
+                    for key, first, duplicate in find_duplicate_keys(
+                        os.path.join(branch, file_normpath)
+                    )
+                ]
+            )
+            report.append("3. **Test Status:** ❌ **_Failed_**")
+            report.append("  - **Issue:**")
+            report.append("    - duplicate entries were found:")
+            report.append(output)
+        else:
+            report.append("3. **Test Status:** ✅ **_Passed_**")
+
         report.append("")
         report.append("---")
         report.append("")
@@ -275,6 +348,12 @@ if __name__ == "__main__":
         required=True,
         help="Branch name.",
     )
+    parser.add_argument(
+        "--check-file",
+        type=str,
+        required=False,
+        help="List of changed files, separated by spaces.",
+    )
     parser.add_argument(
         "--files",
         nargs="+",
@@ -293,11 +372,14 @@ if __name__ == "__main__":
 
     file_list = args.files
     if file_list is None:
-        file_list = glob.glob(
-            os.path.join(
-                os.getcwd(), "src", "main", "resources", "messages_*.properties"
+        if args.check_file:
+            file_list = [args.check_file]
+        else:
+            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/check_tabulator.py

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

.github/scripts/requirements_pre_commit.in

@@ -0,0 +1 @@
+pre-commit

.github/scripts/requirements_pre_commit.txt

@@ -0,0 +1,93 @@
+#
+# This file is autogenerated by pip-compile with Python 3.10
+# by the following command:
+#
+#    pip-compile --generate-hashes --output-file='.github\scripts\requirements_pre_commit.txt' '.github\scripts\requirements_pre_commit.in'
+#
+cfgv==3.4.0 \
+    --hash=sha256:b7265b1f29fd3316bfcd2b330d63d024f2bfd8bcb8b0272f8e19a504856c48f9 \
+    --hash=sha256:e52591d4c5f5dead8e0f673fb16db7949d2cfb3f7da4582893288f0ded8fe560
+    # via pre-commit
+distlib==0.3.9 \
+    --hash=sha256:47f8c22fd27c27e25a65601af709b38e4f0a45ea4fc2e710f65755fa8caaaf87 \
+    --hash=sha256:a60f20dea646b8a33f3e7772f74dc0b2d0772d2837ee1342a00645c81edf9403
+    # via virtualenv
+filelock==3.16.1 \
+    --hash=sha256:2082e5703d51fbf98ea75855d9d5527e33d8ff23099bec374a134febee6946b0 \
+    --hash=sha256:c249fbfcd5db47e5e2d6d62198e565475ee65e4831e2561c8e313fa7eb961435
+    # via virtualenv
+identify==2.6.5 \
+    --hash=sha256:14181a47091eb75b337af4c23078c9d09225cd4c48929f521f3bf16b09d02566 \
+    --hash=sha256:c10b33f250e5bba374fae86fb57f3adcebf1161bce7cdf92031915fd480c13bc
+    # via pre-commit
+nodeenv==1.9.1 \
+    --hash=sha256:6ec12890a2dab7946721edbfbcd91f3319c6ccc9aec47be7c7e6b7011ee6645f \
+    --hash=sha256:ba11c9782d29c27c70ffbdda2d7415098754709be8a7056d79a737cd901155c9
+    # via pre-commit
+platformdirs==4.3.6 \
+    --hash=sha256:357fb2acbc885b0419afd3ce3ed34564c13c9b95c89360cd9563f73aa5e2b907 \
+    --hash=sha256:73e575e1408ab8103900836b97580d5307456908a03e92031bab39e4554cc3fb
+    # via virtualenv
+pre-commit==4.0.1 \
+    --hash=sha256:80905ac375958c0444c65e9cebebd948b3cdb518f335a091a670a89d652139d2 \
+    --hash=sha256:efde913840816312445dc98787724647c65473daefe420785f885e8ed9a06878
+    # via -r .github\scripts\requirements_pre_commit.in
+pyyaml==6.0.2 \
+    --hash=sha256:01179a4a8559ab5de078078f37e5c1a30d76bb88519906844fd7bdea1b7729ff \
+    --hash=sha256:0833f8694549e586547b576dcfaba4a6b55b9e96098b36cdc7ebefe667dfed48 \
+    --hash=sha256:0a9a2848a5b7feac301353437eb7d5957887edbf81d56e903999a75a3d743086 \
+    --hash=sha256:0b69e4ce7a131fe56b7e4d770c67429700908fc0752af059838b1cfb41960e4e \
+    --hash=sha256:0ffe8360bab4910ef1b9e87fb812d8bc0a308b0d0eef8c8f44e0254ab3b07133 \
+    --hash=sha256:11d8f3dd2b9c1207dcaf2ee0bbbfd5991f571186ec9cc78427ba5bd32afae4b5 \
+    --hash=sha256:17e311b6c678207928d649faa7cb0d7b4c26a0ba73d41e99c4fff6b6c3276484 \
+    --hash=sha256:1e2120ef853f59c7419231f3bf4e7021f1b936f6ebd222406c3b60212205d2ee \
+    --hash=sha256:1f71ea527786de97d1a0cc0eacd1defc0985dcf6b3f17bb77dcfc8c34bec4dc5 \
+    --hash=sha256:23502f431948090f597378482b4812b0caae32c22213aecf3b55325e049a6c68 \
+    --hash=sha256:24471b829b3bf607e04e88d79542a9d48bb037c2267d7927a874e6c205ca7e9a \
+    --hash=sha256:29717114e51c84ddfba879543fb232a6ed60086602313ca38cce623c1d62cfbf \
+    --hash=sha256:2e99c6826ffa974fe6e27cdb5ed0021786b03fc98e5ee3c5bfe1fd5015f42b99 \
+    --hash=sha256:39693e1f8320ae4f43943590b49779ffb98acb81f788220ea932a6b6c51004d8 \
+    --hash=sha256:3ad2a3decf9aaba3d29c8f537ac4b243e36bef957511b4766cb0057d32b0be85 \
+    --hash=sha256:3b1fdb9dc17f5a7677423d508ab4f243a726dea51fa5e70992e59a7411c89d19 \
+    --hash=sha256:41e4e3953a79407c794916fa277a82531dd93aad34e29c2a514c2c0c5fe971cc \
+    --hash=sha256:43fa96a3ca0d6b1812e01ced1044a003533c47f6ee8aca31724f78e93ccc089a \
+    --hash=sha256:50187695423ffe49e2deacb8cd10510bc361faac997de9efef88badc3bb9e2d1 \
+    --hash=sha256:5ac9328ec4831237bec75defaf839f7d4564be1e6b25ac710bd1a96321cc8317 \
+    --hash=sha256:5d225db5a45f21e78dd9358e58a98702a0302f2659a3c6cd320564b75b86f47c \
+    --hash=sha256:6395c297d42274772abc367baaa79683958044e5d3835486c16da75d2a694631 \
+    --hash=sha256:688ba32a1cffef67fd2e9398a2efebaea461578b0923624778664cc1c914db5d \
+    --hash=sha256:68ccc6023a3400877818152ad9a1033e3db8625d899c72eacb5a668902e4d652 \
+    --hash=sha256:70b189594dbe54f75ab3a1acec5f1e3faa7e8cf2f1e08d9b561cb41b845f69d5 \
+    --hash=sha256:797b4f722ffa07cc8d62053e4cff1486fa6dc094105d13fea7b1de7d8bf71c9e \
+    --hash=sha256:7c36280e6fb8385e520936c3cb3b8042851904eba0e58d277dca80a5cfed590b \
+    --hash=sha256:7e7401d0de89a9a855c839bc697c079a4af81cf878373abd7dc625847d25cbd8 \
+    --hash=sha256:80bab7bfc629882493af4aa31a4cfa43a4c57c83813253626916b8c7ada83476 \
+    --hash=sha256:82d09873e40955485746739bcb8b4586983670466c23382c19cffecbf1fd8706 \
+    --hash=sha256:8388ee1976c416731879ac16da0aff3f63b286ffdd57cdeb95f3f2e085687563 \
+    --hash=sha256:8824b5a04a04a047e72eea5cec3bc266db09e35de6bdfe34c9436ac5ee27d237 \
+    --hash=sha256:8b9c7197f7cb2738065c481a0461e50ad02f18c78cd75775628afb4d7137fb3b \
+    --hash=sha256:9056c1ecd25795207ad294bcf39f2db3d845767be0ea6e6a34d856f006006083 \
+    --hash=sha256:936d68689298c36b53b29f23c6dbb74de12b4ac12ca6cfe0e047bedceea56180 \
+    --hash=sha256:9b22676e8097e9e22e36d6b7bda33190d0d400f345f23d4065d48f4ca7ae0425 \
+    --hash=sha256:a4d3091415f010369ae4ed1fc6b79def9416358877534caf6a0fdd2146c87a3e \
+    --hash=sha256:a8786accb172bd8afb8be14490a16625cbc387036876ab6ba70912730faf8e1f \
+    --hash=sha256:a9f8c2e67970f13b16084e04f134610fd1d374bf477b17ec1599185cf611d725 \
+    --hash=sha256:bc2fa7c6b47d6bc618dd7fb02ef6fdedb1090ec036abab80d4681424b84c1183 \
+    --hash=sha256:c70c95198c015b85feafc136515252a261a84561b7b1d51e3384e0655ddf25ab \
+    --hash=sha256:cc1c1159b3d456576af7a3e4d1ba7e6924cb39de8f67111c735f6fc832082774 \
+    --hash=sha256:ce826d6ef20b1bc864f0a68340c8b3287705cae2f8b4b1d932177dcc76721725 \
+    --hash=sha256:d584d9ec91ad65861cc08d42e834324ef890a082e591037abe114850ff7bbc3e \
+    --hash=sha256:d7fded462629cfa4b685c5416b949ebad6cec74af5e2d42905d41e257e0869f5 \
+    --hash=sha256:d84a1718ee396f54f3a086ea0a66d8e552b2ab2017ef8b420e92edbc841c352d \
+    --hash=sha256:d8e03406cac8513435335dbab54c0d385e4a49e4945d2909a581c83647ca0290 \
+    --hash=sha256:e10ce637b18caea04431ce14fabcf5c64a1c61ec9c56b071a4b7ca131ca52d44 \
+    --hash=sha256:ec031d5d2feb36d1d1a24380e4db6d43695f3748343d99434e6f5f9156aaa2ed \
+    --hash=sha256:ef6107725bd54b262d6dedcc2af448a266975032bc85ef0172c5f059da6325b4 \
+    --hash=sha256:efdca5630322a10774e8e98e1af481aad470dd62c3170801852d752aa7a783ba \
+    --hash=sha256:f753120cb8181e736c57ef7636e83f31b9c0d1722c516f7e86cf15b7aa57ff12 \
+    --hash=sha256:ff3824dc5261f50c9b0dfb3be22b4567a6f938ccce4587b38952d85fd9e9afe4
+    # via pre-commit
+virtualenv==20.28.1 \
+    --hash=sha256:412773c85d4dab0409b83ec36f7a6499e72eaf08c80e81e9576bca61831c71cb \
+    --hash=sha256:5d34ab240fdb5d21549b76f9e8ff3af28252f5499fb6d6f031adac4e5a8c5329
+    # via pre-commit

.github/scripts/requirements_sync_readme.in

@@ -0,0 +1 @@
+tomlkit

.github/scripts/requirements_sync_readme.txt

@@ -0,0 +1,10 @@
+#
+# This file is autogenerated by pip-compile with Python 3.10
+# by the following command:
+#
+#    pip-compile --generate-hashes --output-file='.github\scripts\requirements_sync_readme.txt' '.github\scripts\requirements_sync_readme.in'
+#
+tomlkit==0.13.2 \
+    --hash=sha256:7a974427f6e119197f670fbbbeae7bef749a6c14e793db934baefc1b5f03efde \
+    --hash=sha256:fff5fe59a87295b278abd31bec92c15d9bc4a06885ab12bcea52c71119392e79
+    # via -r .github\scripts\requirements_sync_readme.in

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

@@ -4,9 +4,15 @@ on:
   issue_comment:
     types: [created]
 
+permissions:
+  contents: read
+
 jobs:
   check-comment:
     runs-on: ubuntu-latest
+    permissions:
+      pull-requests: read
+      issues: read
     if: |
       github.event.issue.pull_request &&
       (
@@ -20,7 +26,9 @@ jobs:
         github.event.comment.user.login == 'Ludy87' ||
         github.event.comment.user.login == 'LaserKaspar' ||
         github.event.comment.user.login == 'sbplat' ||
-        github.event.comment.user.login == 'reecebrowne'
+        github.event.comment.user.login == 'reecebrowne' ||
+        github.event.comment.user.login == 'DarioGii' ||
+        github.event.comment.user.login == 'ConnorYoh'
       )
     outputs:
       pr_number: ${{ steps.get-pr.outputs.pr_number }}
@@ -29,7 +37,7 @@ jobs:
 
     steps:
       - name: Harden Runner
-        uses: step-security/harden-runner@0080882f6c36860b6ba35c610c98ce87d4e2f26f # v2.10.2
+        uses: step-security/harden-runner@4d991eb9b905ef189e4c376166672c3f2f230481 # v2.11.0
         with:
           egress-policy: audit
 
@@ -68,10 +76,13 @@ jobs:
   deploy-pr:
     needs: check-comment
     runs-on: ubuntu-latest
+    permissions:
+      pull-requests: write
+      issues: write
 
     steps:
       - name: Harden Runner
-        uses: step-security/harden-runner@0080882f6c36860b6ba35c610c98ce87d4e2f26f # v2.10.2
+        uses: step-security/harden-runner@4d991eb9b905ef189e4c376166672c3f2f230481 # v2.11.0
         with:
           egress-policy: audit
 
@@ -83,22 +94,25 @@ jobs:
           token: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Set up JDK
-        uses: actions/setup-java@7a6d8a8234af8eb26422e24e3006232cccaa061b # v4.6.0
+        uses: actions/setup-java@3a4f6e1af504cf6a31855fa899c6aa5355ba6c12 # v4.7.0
         with:
-          java-version: '17'
-          distribution: 'temurin'
+          java-version: "17"
+          distribution: "temurin"
 
       - name: Run Gradle Command
         run: ./gradlew clean build
         env:
           DOCKER_ENABLE_SECURITY: false
+          STIRLING_PDF_DESKTOP_UI: false
 
       - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@6524bf65af31da8d45b59e8c27de4bd072b392f5 # v3.8.0
+        uses: docker/setup-buildx-action@f7ce87c1d6bead3e36075b2ce75da1f6cc28aaca # v3.9.0
 
       - name: Get version number
         id: versionNumber
-        run: echo "versionNumber=$(./gradlew printVersion --quiet | tail -1)" >> $GITHUB_OUTPUT
+        run: |
+          VERSION=$(grep "^version =" build.gradle | awk -F'"' '{print $2}')
+          echo "versionNumber=$VERSION" >> $GITHUB_OUTPUT
 
       - name: Login to Docker Hub
         uses: docker/login-action@9780b0c442fbb1117ed29e0efdff1e18412f7567 # v3.3.0
@@ -107,7 +121,7 @@ jobs:
           password: ${{ secrets.DOCKER_HUB_API }}
 
       - name: Build and push PR-specific image
-        uses: docker/build-push-action@48aba3b46d1b1fec4febb7c5d0c644b249a11355 # v6.10.0
+        uses: docker/build-push-action@0adf9959216b96bec444f325f1e493d4aa344497 # v6.14.0
         with:
           context: .
           file: ./Dockerfile

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

@@ -4,11 +4,12 @@ on:
   pull_request:
     types: [opened, synchronize, reopened, closed]
 
-permissions: read-all
+permissions:
+  contents: read
 
 env:
-  SERVER_IP: ${{ secrets.VPS_IP }}  # Add this to your GitHub secrets
-  CLEANUP_PERFORMED: 'false'  # Add flag to track if cleanup occurred
+  SERVER_IP: ${{ secrets.VPS_IP }} # Add this to your GitHub secrets
+  CLEANUP_PERFORMED: "false" # Add flag to track if cleanup occurred
 
 jobs:
   cleanup:
@@ -20,7 +21,7 @@ jobs:
 
     steps:
       - name: Harden Runner
-        uses: step-security/harden-runner@0080882f6c36860b6ba35c610c98ce87d4e2f26f # v2.10.2
+        uses: step-security/harden-runner@4d991eb9b905ef189e4c376166672c3f2f230481 # v2.11.0
         with:
           egress-policy: audit
 
@@ -33,7 +34,7 @@ jobs:
       - 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'
+          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..."
 
@@ -56,29 +57,3 @@ jobs:
               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@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
-        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/auto-labeler.yml

@@ -3,7 +3,8 @@ on:
   pull_request_target:
     types: [opened, synchronize]
 
-permissions: read-all
+permissions:
+  contents: read
 
 jobs:
   labeler:
@@ -12,7 +13,7 @@ jobs:
       pull-requests: write
     steps:
       - name: Harden Runner
-        uses: step-security/harden-runner@0080882f6c36860b6ba35c610c98ce87d4e2f26f # v2.10.2
+        uses: step-security/harden-runner@4d991eb9b905ef189e4c376166672c3f2f230481 # v2.11.0
         with:
           egress-policy: audit
 

.github/workflows/build.yml

@@ -6,13 +6,15 @@ on:
   pull_request:
     branches: ["main"]
 
-permissions: read-all
+permissions:
+  contents: read
 
 jobs:
   build:
     runs-on: ubuntu-latest
 
     permissions:
+      actions: read
       security-events: write
 
     strategy:
@@ -22,7 +24,7 @@ jobs:
 
     steps:
       - name: Harden Runner
-        uses: step-security/harden-runner@0080882f6c36860b6ba35c610c98ce87d4e2f26f # v2.10.2
+        uses: step-security/harden-runner@4d991eb9b905ef189e4c376166672c3f2f230481 # v2.11.0
         with:
           egress-policy: audit
 
@@ -30,18 +32,60 @@ jobs:
         uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
 
       - name: Set up JDK ${{ matrix.jdk-version }}
-        uses: actions/setup-java@7a6d8a8234af8eb26422e24e3006232cccaa061b # v4.6.0
+        uses: actions/setup-java@3a4f6e1af504cf6a31855fa899c6aa5355ba6c12 # v4.7.0
         with:
           java-version: ${{ matrix.jdk-version }}
           distribution: "temurin"
 
-      - name: Set up Gradle
-        uses: gradle/actions/setup-gradle@0bdd871935719febd78681f197cd39af5b6e16a6 # v4.2.2
-        with:
-          gradle-version: 8.7
+      - name: Build with Gradle and no spring security
+        run: ./gradlew clean build
+        env:
+          DOCKER_ENABLE_SECURITY: false
 
-      - name: Build with Gradle
-        run: ./gradlew build --no-build-cache
+      - name: Build with Gradle and with spring security
+        run: ./gradlew clean build
+        env:
+          DOCKER_ENABLE_SECURITY: true
+
+      - name: Upload Test Reports
+        if: always()
+        uses: actions/upload-artifact@4cec3d8aa04e39d1a68397de0c4cd6fb9dce8ec1 # v4.6.1
+        with:
+          name: test-reports-jdk-${{ matrix.jdk-version }}
+          path: |
+            build/reports/tests/
+            build/test-results/
+            build/reports/problems/
+          retention-days: 3
+
+  check-licence:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Harden Runner
+        uses: step-security/harden-runner@4d991eb9b905ef189e4c376166672c3f2f230481 # v2.11.0
+        with:
+          egress-policy: audit
+
+      - name: Checkout repository
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+
+      - name: Set up JDK 17
+        uses: actions/setup-java@3a4f6e1af504cf6a31855fa899c6aa5355ba6c12 # v4.7.0
+        with:
+          java-version: "17"
+          distribution: "adopt"
+
+      - name: check the licenses for compatibility
+        run: ./gradlew clean checkLicense
+
+      - name: FAILED - check the licenses for compatibility
+        if: failure()
+        uses: actions/upload-artifact@4cec3d8aa04e39d1a68397de0c4cd6fb9dce8ec1 # v4.6.1
+        with:
+          name: dependencies-without-allowed-license.json
+          path: |
+            build/reports/dependency-license/dependencies-without-allowed-license.json
+          retention-days: 3
 
   docker-compose-tests:
     # if: github.event_name == 'push' && github.ref == 'refs/heads/main' ||
@@ -62,7 +106,7 @@ jobs:
 
     steps:
       - name: Harden Runner
-        uses: step-security/harden-runner@0080882f6c36860b6ba35c610c98ce87d4e2f26f # v2.10.2
+        uses: step-security/harden-runner@4d991eb9b905ef189e4c376166672c3f2f230481 # v2.11.0
         with:
           egress-policy: audit
 
@@ -70,29 +114,31 @@ jobs:
         uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
 
       - name: Set up Java 17
-        uses: actions/setup-java@7a6d8a8234af8eb26422e24e3006232cccaa061b # v4.6.0
+        uses: actions/setup-java@3a4f6e1af504cf6a31855fa899c6aa5355ba6c12 # v4.7.0
         with:
           java-version: "17"
           distribution: "adopt"
 
       - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@6524bf65af31da8d45b59e8c27de4bd072b392f5 # v3.8.0
+        uses: docker/setup-buildx-action@f7ce87c1d6bead3e36075b2ce75da1f6cc28aaca # v3.9.0
 
       - name: Install Docker Compose
         run: |
-          sudo curl -SL "https://github.com/docker/compose/releases/download/v2.29.1/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
+          sudo curl -SL "https://github.com/docker/compose/releases/download/v2.32.4/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
           sudo chmod +x /usr/local/bin/docker-compose
 
       - name: Set up Python
-        uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0
+        uses: actions/setup-python@42375524e23c412d93fb67b49958b491fce71c38 # v5.4.0
         with:
           python-version: "3.12"
+          cache: 'pip' # caching pip dependencies
 
       - name: Pip requirements
         run: |
-           pip install -r ./cucumber/requirements.txt
+          pip install --require-hashes -r ./testing/cucumber/requirements.txt
 
       - name: Run Docker Compose Tests
         run: |
-          chmod +x ./test.sh
-          ./test.sh
+          chmod +x ./testing/test_webpages.sh
+          chmod +x ./testing/test.sh
+          ./testing/test.sh

.github/workflows/check_properties.yml

@@ -6,40 +6,50 @@ on:
     paths:
       - "src/main/resources/messages_*.properties"
 
-permissions: read-all
+permissions:
+  contents: read # Allow read access to repository content
 
 jobs:
   check-files:
     if: github.event_name == 'pull_request_target'
     runs-on: ubuntu-latest
+    permissions:
+      issues: write # Allow posting comments on issues/PRs
+      pull-requests: write
     steps:
       - name: Harden Runner
-        uses: step-security/harden-runner@0080882f6c36860b6ba35c610c98ce87d4e2f26f # v2.10.2
+        uses: step-security/harden-runner@4d991eb9b905ef189e4c376166672c3f2f230481 # v2.11.0
         with:
           egress-policy: audit
 
       - name: Checkout main branch first
         uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
-        with:
-          ref: main
-          path: main-branch
-          fetch-depth: 0
-
-      - name: Checkout PR branch
-        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
-        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@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0
+        uses: actions/setup-python@42375524e23c412d93fb67b49958b491fce71c38 # v5.4.0
         with:
-          python-version: "3.x"
+          python-version: "3.12"
 
-      - name: Install GitHub CLI
-        run: sudo apt-get update && sudo apt-get install -y gh
+      - name: Get PR data
+        id: get-pr-data
+        uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
+        with:
+          script: |
+            const prNumber = context.payload.pull_request.number;
+            const repoOwner = context.payload.repository.owner.login;
+            const repoName = context.payload.repository.name;
+            const branch = context.payload.pull_request.head.ref;
+
+            console.log(`PR Number: ${prNumber}`);
+            console.log(`Repo Owner: ${repoOwner}`);
+            console.log(`Repo Name: ${repoName}`);
+            console.log(`Branch: ${branch}`);
+
+            core.setOutput("pr_number", prNumber);
+            core.setOutput("repo_owner", repoOwner);
+            core.setOutput("repo_name", repoName);
+            core.setOutput("branch", branch);
+        continue-on-error: true
 
       - name: Fetch PR changed files
         id: fetch-pr-changes
@@ -47,45 +57,125 @@ jobs:
           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 ..
+          gh pr view ${{ steps.get-pr-data.outputs.pr_number }} --json files -q ".files[].path" | grep -E '^src/main/resources/messages_[a-zA-Z_]{2}_[a-zA-Z_]{2,7}\.properties$' > changed_files.txt # Filter only matching property files
 
-          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
+      - name: Determine reference file test
         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
+        uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
+        with:
+          script: |
+            const fs = require("fs");
+            const path = require("path");
 
-      - name: Show REFERENCE_FILE
-        run: echo "Reference file is set to ${REFERENCE_FILE}"
+            const prNumber = ${{ steps.get-pr-data.outputs.pr_number }};
+            const repoOwner = "${{ steps.get-pr-data.outputs.repo_owner }}";
+            const repoName = "${{ steps.get-pr-data.outputs.repo_name }}";
+
+            const prRepoOwner = "${{ github.event.pull_request.head.repo.owner.login }}";
+            const prRepoName = "${{ github.event.pull_request.head.repo.name }}";
+            const branch = "${{ steps.get-pr-data.outputs.branch }}";
+
+            console.log(`Determining reference file for PR #${prNumber}`);
+
+            // Validate inputs
+            const validateInput = (input, regex, name) => {
+              if (!regex.test(input)) {
+                throw new Error(`Invalid ${name}: ${input}`);
+              }
+            };
+
+            validateInput(repoOwner, /^[a-zA-Z0-9_-]+$/, "repository owner");
+            validateInput(repoName, /^[a-zA-Z0-9._-]+$/, "repository name");
+            validateInput(branch, /^[a-zA-Z0-9._/-]+$/, "branch name");
+
+            // Get the list of changed files in the PR
+            const { data: files } = await github.rest.pulls.listFiles({
+              owner: repoOwner,
+              repo: repoName,
+              pull_number: prNumber,
+            });
+
+            // Filter for relevant files based on the PR changes
+            const changedFiles = files
+              .map(file => file.filename)
+              .filter(file => /^src\/main\/resources\/messages_[a-zA-Z_]{2}_[a-zA-Z_]{2,7}\.properties$/.test(file));
+
+            console.log("Changed files:", changedFiles);
+
+            // Create a temporary directory for PR files
+            const tempDir = "pr-branch";
+            if (!fs.existsSync(tempDir)) {
+              fs.mkdirSync(tempDir, { recursive: true });
+            }
+
+            // Download and save each changed file
+            for (const file of changedFiles) {
+              const { data: fileContent } = await github.rest.repos.getContent({
+                owner: prRepoOwner,
+                repo: prRepoName,
+                path: file,
+                ref: branch,
+              });
+
+              const content = Buffer.from(fileContent.content, "base64").toString("utf-8");
+              const filePath = path.join(tempDir, file);
+              const dirPath = path.dirname(filePath);
+
+              if (!fs.existsSync(dirPath)) {
+                fs.mkdirSync(dirPath, { recursive: true });
+              }
+
+              fs.writeFileSync(filePath, content);
+              console.log(`Saved file: ${filePath}`);
+            }
+
+            // Output the list of changed files for further processing
+            const fileList = changedFiles.join(" ");
+            core.exportVariable("FILES_LIST", fileList);
+            console.log("Files saved and listed in FILES_LIST.");
+
+            // Determine reference file
+            let referenceFilePath;
+            if (changedFiles.includes("src/main/resources/messages_en_GB.properties")) {
+              console.log("Using PR branch reference file.");
+              const { data: fileContent } = await github.rest.repos.getContent({
+                owner: prRepoOwner,
+                repo: prRepoName,
+                path: "src/main/resources/messages_en_GB.properties",
+                ref: branch,
+              });
+
+              referenceFilePath = "pr-branch-messages_en_GB.properties";
+              const content = Buffer.from(fileContent.content, "base64").toString("utf-8");
+              fs.writeFileSync(referenceFilePath, content);
+            } else {
+              console.log("Using main branch reference file.");
+              const { data: fileContent } = await github.rest.repos.getContent({
+                owner: repoOwner,
+                repo: repoName,
+                path: "src/main/resources/messages_en_GB.properties",
+                ref: "main",
+              });
+
+              referenceFilePath = "main-branch-messages_en_GB.properties";
+              const content = Buffer.from(fileContent.content, "base64").toString("utf-8");
+              fs.writeFileSync(referenceFilePath, content);
+            }
+
+            console.log(`Reference file path: ${referenceFilePath}`);
+            core.exportVariable("REFERENCE_FILE", referenceFilePath);
 
       - 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 \
+          python .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
+            --branch "pr-branch" \
+            --files "${FILES_LIST[@]}" > result.txt
+        continue-on-error: true # Continue the job even if this step fails
 
       - name: Capture output
         id: capture-output
@@ -98,7 +188,7 @@ jobs:
             echo "EOF" >> $GITHUB_ENV
             echo "${SCRIPT_OUTPUT}"
 
-            # Set FAIL_JOB to true if SCRIPT_OUTPUT contains ❌
+            # Determine job failure based on script output
             if [[ "$SCRIPT_OUTPUT" == *"❌"* ]]; then
               echo "FAIL_JOB=true" >> $GITHUB_ENV
             else
@@ -117,18 +207,18 @@ jobs:
           script: |
             const { GITHUB_REPOSITORY, SCRIPT_OUTPUT } = process.env;
             const [repoOwner, repoName] = GITHUB_REPOSITORY.split('/');
-            const prNumber = context.issue.number;
+            const issueNumber = context.issue.number;
 
             // Find existing comment
             const comments = await github.rest.issues.listComments({
               owner: repoOwner,
               repo: repoName,
-              issue_number: prNumber
+              issue_number: issueNumber
             });
 
             const comment = comments.data.find(c => c.body.includes("## 🚀 Translation Verification Summary"));
 
-            // Only allow the action user to update comments
+            // Only update or create comments by the action user
             const expectedActor = "github-actions[bot]";
 
             if (comment && comment.user.login === expectedActor) {
@@ -145,7 +235,7 @@ jobs:
               await github.rest.issues.createComment({
                 owner: repoOwner,
                 repo: repoName,
-                issue_number: prNumber,
+                issue_number: issueNumber,
                 body: `## 🚀 Translation Verification Summary\n\n\n${SCRIPT_OUTPUT}\n`
               });
               console.log("Created new comment.");

.github/workflows/codeql.yml-disabled

@@ -42,7 +42,7 @@ jobs:
 
     steps:
       - name: Harden Runner
-        uses: step-security/harden-runner@0080882f6c36860b6ba35c610c98ce87d4e2f26f # v2.10.2
+        uses: step-security/harden-runner@c95a14d0e5bab51a9f56296a4eb0e416910cd350 # v2.10.3
         with:
           egress-policy: audit
 

.github/workflows/dependency-review.yml

@@ -6,7 +6,7 @@
 # PRs introducing known-vulnerable packages will be blocked from merging.
 #
 # Source repository: https://github.com/actions/dependency-review-action
-name: 'Dependency Review'
+name: "Dependency Review"
 on: [pull_request]
 
 permissions:
@@ -17,11 +17,11 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Harden Runner
-        uses: step-security/harden-runner@0080882f6c36860b6ba35c610c98ce87d4e2f26f # v2.10.2
+        uses: step-security/harden-runner@4d991eb9b905ef189e4c376166672c3f2f230481 # v2.11.0
         with:
           egress-policy: audit
 
-      - name: 'Checkout Repository'
+      - name: "Checkout Repository"
         uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
-      - name: 'Dependency Review'
+      - name: "Dependency Review"
         uses: actions/dependency-review-action@3b139cfc5fae8b618d3eae3675e383bb1769c019 # v4.5.0

.github/workflows/licenses-update.yml

@@ -7,7 +7,8 @@ on:
     paths:
       - "build.gradle"
 
-permissions: read-all
+permissions:
+  contents: read
 
 jobs:
   generate-license-report:
@@ -17,23 +18,39 @@ jobs:
       pull-requests: write
     steps:
       - name: Harden Runner
-        uses: step-security/harden-runner@0080882f6c36860b6ba35c610c98ce87d4e2f26f # v2.10.2
+        uses: step-security/harden-runner@4d991eb9b905ef189e4c376166672c3f2f230481 # v2.11.0
         with:
           egress-policy: audit
 
+      - name: Generate GitHub App Token
+        id: generate-token
+        uses: actions/create-github-app-token@0d564482f06ca65fa9e77e2510873638c82206f2 # v1.11.5
+        with:
+          app-id: ${{ secrets.GH_APP_ID }}
+          private-key: ${{ secrets.GH_APP_PRIVATE_KEY }}
+
       - name: Check out code
         uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
 
       - name: Set up JDK 17
-        uses: actions/setup-java@7a6d8a8234af8eb26422e24e3006232cccaa061b # v4.6.0
+        uses: actions/setup-java@3a4f6e1af504cf6a31855fa899c6aa5355ba6c12 # v4.7.0
         with:
           java-version: "17"
           distribution: "adopt"
 
-      - uses: gradle/actions/setup-gradle@0bdd871935719febd78681f197cd39af5b6e16a6 # v4.2.2
+      - uses: gradle/actions/setup-gradle@94baf225fe0a508e581a564467443d0e2379123b # v4.3.0
 
-      - name: Run Gradle Command
-        run: ./gradlew clean generateLicenseReport
+      - name: check the licenses for compatibility
+        run: ./gradlew clean checkLicense
+
+      - name: FAILED - check the licenses for compatibility
+        if: failure()
+        uses: actions/upload-artifact@4cec3d8aa04e39d1a68397de0c4cd6fb9dce8ec1 # v4.6.1
+        with:
+          name: dependencies-without-allowed-license.json
+          path: |
+            build/reports/dependency-license/dependencies-without-allowed-license.json
+          retention-days: 3
 
       - name: Move and Rename License File
         run: |
@@ -41,8 +58,8 @@ jobs:
 
       - 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"
+          git config --global user.name "stirlingbot[bot]"
+          git config --global user.email "1113334+stirlingbot[bot]@users.noreply.github.com"
 
       - name: Run git add
         run: |
@@ -52,34 +69,24 @@ jobs:
       - name: Create Pull Request
         id: cpr
         if: env.CHANGES_DETECTED == 'true'
-        uses: peter-evans/create-pull-request@5e914681df9dc83aa4e4905692ca88beb2f9e91f # v7.0.5
+        uses: peter-evans/create-pull-request@dd2324fc52d5d43c699a5636bcf19fceaa70c284 # v7.0.7
         with:
-          token: ${{ secrets.GITHUB_TOKEN }}
+          token: ${{ steps.generate-token.outputs.token }}
           commit-message: "Update 3rd Party Licenses"
-          committer: GitHub Action <action@github.com>
-          author: GitHub Action <action@github.com>
+          committer: "stirlingbot[bot] <1113334+stirlingbot[bot]@users.noreply.github.com>"
+          author: "stirlingbot[bot] <1113334+stirlingbot[bot]@users.noreply.github.com>"
           signoff: true
           branch: update-3rd-party-licenses
           title: "Update 3rd Party Licenses"
           body: |
-            Auto-generated by [create-pull-request][1]
-
-            [1]: https://github.com/peter-evans/create-pull-request
+            Auto-generated by StirlingBot
           labels: licenses,github-actions
           draft: false
           delete-branch: true
           sign-commits: true
 
-      - name: Auto approve
+      - name: Enable Pull Request Automerge
         if: steps.cpr.outputs.pull-request-operation == 'created'
-        run: gh pr review --approve "${{ steps.cpr.outputs.pull-request-number }}"
+        run: gh pr merge --squash --auto "${{ steps.cpr.outputs.pull-request-number }}"
         env:
-          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
-      - name: Enable auto-merge
-        if: steps.cpr.outputs.pull-request-operation == 'created'
-        uses: peter-evans/enable-pull-request-automerge@a660677d5469627102a1c1e11409dd063606628d # v3.0.0
-        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
+          GH_TOKEN: ${{ steps.generate-token.outputs.token }}

.github/workflows/manage-label.yml

@@ -4,7 +4,8 @@ on:
   schedule:
     - cron: "30 20 * * *"
 
-permissions: read-all
+permissions:
+  contents: read
 
 jobs:
   labeler:
@@ -14,7 +15,7 @@ jobs:
       issues: write
     steps:
       - name: Harden Runner
-        uses: step-security/harden-runner@0080882f6c36860b6ba35c610c98ce87d4e2f26f # v2.10.2
+        uses: step-security/harden-runner@4d991eb9b905ef189e4c376166672c3f2f230481 # v2.11.0
         with:
           egress-policy: audit
 
@@ -22,7 +23,7 @@ jobs:
         uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
 
       - name: Run Labeler
-        uses: crazy-max/ghaction-github-labeler@b54af0c25861143e7c8813d7cbbf46d2c341680c # v5.1.0
+        uses: crazy-max/ghaction-github-labeler@31674a3852a9074f2086abcf1c53839d466a47e7 # v5.2.0
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           yaml-file: .github/labels.yml

.github/workflows/multiOSReleases.yml

@@ -5,44 +5,155 @@ on:
   release:
     types: [created]
 
-permissions: read-all
+permissions:
+  contents: read
 
 jobs:
-  build-installers:
-    strategy:
-      matrix:
-        include:
-          - os: windows-latest
-            platform: win
-            ext: exe
-         #- os: macos-latest
-         #  platform: mac
-         # ext: dmg
-         #- os: ubuntu-latest
-         #  platform: linux
-         #  ext: deb
-    runs-on: ${{ matrix.os }}
-    permissions:
-      contents: write
-      packages: write
-
+  read_versions:
+    runs-on: ubuntu-latest
+    outputs:
+      version: ${{ steps.versionNumber.outputs.versionNumber }}
+      versionMac: ${{ steps.versionNumberMac.outputs.versionNumberMac }}
     steps:
       - name: Harden Runner
-        uses: step-security/harden-runner@0080882f6c36860b6ba35c610c98ce87d4e2f26f # v2.10.2
+        uses: step-security/harden-runner@4d991eb9b905ef189e4c376166672c3f2f230481 # v2.11.0
+        with:
+          egress-policy: audit
+
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+
+      # Get version number
+      - name: Get version number
+        id: versionNumber
+        run: |
+          VERSION=$(grep "^version =" build.gradle | awk -F'"' '{print $2}')
+          echo "versionNumber=$VERSION" >> $GITHUB_OUTPUT
+
+      - name: Get version number mac
+        id: versionNumberMac
+        run: |
+          VERSION=$(grep "^version =" build.gradle | awk -F'"' '{print $2}')
+          CURRENT_YEAR=$(date +'%Y')
+          IFS='.' read -r -a VERSION_PARTS <<< "$VERSION"
+          MAC_VERSION="$CURRENT_YEAR.${VERSION_PARTS[1]:-0}.${VERSION_PARTS[2]:-0}"
+          echo "versionNumberMac=$MAC_VERSION" >> $GITHUB_OUTPUT
+
+  build-portable:
+    needs: read_versions
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        enable_security: [true, false]
+        include:
+          - enable_security: true
+            file_suffix: "-with-login"
+          - enable_security: false
+            file_suffix: ""
+    steps:
+      - name: Harden Runner
+        uses: step-security/harden-runner@4d991eb9b905ef189e4c376166672c3f2f230481 # v2.11.0
         with:
           egress-policy: audit
 
       - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
 
       - name: Set up JDK 21
-        uses: actions/setup-java@7a6d8a8234af8eb26422e24e3006232cccaa061b # v4.6.0
+        uses: actions/setup-java@3a4f6e1af504cf6a31855fa899c6aa5355ba6c12 # v4.7.0
         with:
           java-version: "21"
           distribution: "temurin"
 
-      - uses: gradle/actions/setup-gradle@0bdd871935719febd78681f197cd39af5b6e16a6 # v4.2.2
+      - uses: gradle/actions/setup-gradle@94baf225fe0a508e581a564467443d0e2379123b # v4.3.0
         with:
-          gradle-version: 8.7
+          gradle-version: 8.12
+
+      - name: Generate jar (With Security=${{ matrix.enable_security }})
+        run: ./gradlew clean createExe
+        env:
+          DOCKER_ENABLE_SECURITY: ${{ matrix.enable_security }}
+          STIRLING_PDF_DESKTOP_UI: false
+
+      - name: Rename binaries
+        run: |
+          mkdir ./binaries
+          mv ./build/launch4j/Stirling-PDF.exe ./binaries/win-Stirling-PDF-portable-Server${{ matrix.file_suffix }}.exe
+          mv ./build/libs/Stirling-PDF-${{ needs.read_versions.outputs.version }}.jar ./binaries/Stirling-PDF${{ matrix.file_suffix }}.jar
+
+      - name: Upload build artifacts
+        uses: actions/upload-artifact@4cec3d8aa04e39d1a68397de0c4cd6fb9dce8ec1 # v4.6.1
+        with:
+          retention-days: 1
+          if-no-files-found: error
+          name: stirling${{ matrix.file_suffix }}-binaries
+          path: |
+            ./binaries/*
+
+  sign_verify-portable:
+    needs: [build-portable, read_versions]
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        enable_security: [true, false]
+        include:
+          - enable_security: true
+            file_suffix: "with-login-"
+          - enable_security: false
+            file_suffix: ""
+    steps:
+      - name: Harden Runner
+        uses: step-security/harden-runner@4d991eb9b905ef189e4c376166672c3f2f230481 # v2.11.0
+        with:
+          egress-policy: audit
+
+      - name: Download build artifacts
+        uses: actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16 # v4.1.8
+        with:
+          name: stirling-${{ matrix.file_suffix }}binaries
+
+      - name: Display structure of downloaded files
+        run: ls -R
+
+      - name: Upload signed artifacts
+        uses: actions/upload-artifact@4cec3d8aa04e39d1a68397de0c4cd6fb9dce8ec1 # v4.6.1
+        with:
+          retention-days: 1
+          if-no-files-found: error
+          name: stirling-${{ matrix.file_suffix }}signed
+          path: |
+            ./*
+            !cosign.*
+
+  build-installers:
+    needs: read_versions
+    strategy:
+      matrix:
+        include:
+          - os: windows-latest
+            platform: win-
+          - os: macos-latest
+            platform: mac-
+          # - os: ubuntu-latest
+          #   platform: linux-
+    runs-on: ${{ matrix.os }}
+    permissions:
+      contents: write
+    steps:
+      - name: Harden Runner
+        uses: step-security/harden-runner@4d991eb9b905ef189e4c376166672c3f2f230481 # v2.11.0
+        with:
+          egress-policy: audit
+
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+
+      - name: Set up JDK 21
+        uses: actions/setup-java@3a4f6e1af504cf6a31855fa899c6aa5355ba6c12 # v4.7.0
+        with:
+          java-version: "21"
+          distribution: "temurin"
+
+      - uses: gradle/actions/setup-gradle@94baf225fe0a508e581a564467443d0e2379123b # v4.3.0
+        with:
+          gradle-version: 8.12
 
       # Install Windows dependencies
       - name: Install WiX Toolset
@@ -51,54 +162,127 @@ jobs:
           curl -L -o wix.exe https://github.com/wixtoolset/wix3/releases/download/wix3141rtm/wix314.exe
           .\wix.exe /install /quiet
 
-      # Install Linux dependencies
-      - name: Install Linux Dependencies
-        if: matrix.os == 'ubuntu-latest'
-        run: |
-          sudo apt-get update
-          sudo apt-get install -y fakeroot rpm
-
-      # Get version number
-      - name: Get version number
-        id: versionNumber
-        run: echo "versionNumber=$(./gradlew printVersion --quiet | tail -1)" >> $GITHUB_OUTPUT
-        shell: bash
-
-      - name: Get version number mac
-        id: versionNumberMac
-        run: echo "versionNumberMac=$(./gradlew printMacVersion --quiet | tail -1)" >> $GITHUB_OUTPUT
-        shell: bash
-
       # Build installer
       - name: Build Installer
         run: ./gradlew build jpackage -x test --info
         env:
           DOCKER_ENABLE_SECURITY: false
           STIRLING_PDF_DESKTOP_UI: true
+          BROWSER_OPEN: true
 
       # Rename and collect artifacts based on OS
       - name: Prepare artifacts
         id: prepare
         shell: bash
         run: |
+          mkdir ./binaries
           if [ "${{ matrix.os }}" = "windows-latest" ]; then
-            mv "build/jpackage/Stirling-PDF-${{ steps.versionNumber.outputs.versionNumber }}.exe" "Stirling-PDF-${{ matrix.platform }}-installer.${{ matrix.ext }}"
+            mv "./build/jpackage/Stirling-PDF-${{ needs.read_versions.outputs.version }}.exe" "./binaries/Stirling-PDF-win-installer.exe"
           elif [ "${{ matrix.os }}" = "macos-latest" ]; then
-            mv "build/jpackage/Stirling-PDF-${{ steps.versionNumberMac.outputs.versionNumberMac }}.dmg" "Stirling-PDF-${{ steps.versionNumber.outputs.versionNumber }}-${{ matrix.platform }}.${{ matrix.ext }}"
+            mv "./build/jpackage/Stirling-PDF-${{ needs.read_versions.outputs.versionMac }}.dmg" "./binaries/Stirling-PDF-mac-installer.dmg"
           else
-            mv "build/jpackage/stirling-pdf_${{ steps.versionNumber.outputs.versionNumber }}-1_amd64.deb" "Stirling-PDF-${{ steps.versionNumber.outputs.versionNumber }}-${{ matrix.platform }}.${{ matrix.ext }}"
+            mv "./build/jpackage/stirling-pdf_${{ needs.read_versions.outputs.version }}-1_amd64.deb" "./binaries/Stirling-PDF-linux-installer.deb"
           fi
 
-      # Upload installer as artifact for testing
-      - name: Upload Installer Artifact
-        uses: actions/upload-artifact@6f51ac03b9356f520e9adb1b1b7802705f340c2b # v4.5.0
+      - name: Display structure of downloaded files
+        run: ls -R ./binaries
+
+      - name: Upload build artifacts
+        uses: actions/upload-artifact@4cec3d8aa04e39d1a68397de0c4cd6fb9dce8ec1 # v4.6.1
         with:
-          name: Stirling-PDF-${{ matrix.platform }}-installer.${{ matrix.ext }}
-          path: Stirling-PDF-${{ matrix.platform }}-installer.${{ matrix.ext }}
           retention-days: 1
           if-no-files-found: error
+          name: ${{ matrix.platform }}binaries
+          path: |
+            ./binaries/*
 
-      - name: Upload binaries to release
+  sign_verify:
+    needs: [read_versions, build-installers]
+    strategy:
+      matrix:
+        include:
+          - os: windows-latest
+            platform: win-
+          - os: macos-latest
+            platform: mac-
+          # - os: ubuntu-latest
+          #   platform: linux-
+    runs-on: ubuntu-latest
+    steps:
+      - name: Harden Runner
+        uses: step-security/harden-runner@4d991eb9b905ef189e4c376166672c3f2f230481 # v2.11.0
+        with:
+          egress-policy: audit
+
+      - name: Download build artifacts
+        uses: actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16 # v4.1.8
+        with:
+          name: ${{ matrix.platform }}binaries
+
+      - name: Display structure of downloaded files
+        run: ls -R
+
+      - name: Install Cosign
+        if: matrix.os == 'windows-latest'
+        uses: sigstore/cosign-installer@d7d6bc7722e3daa8354c50bcb52f4837da5e9b6a # v3.8.1
+
+      - name: Generate key pair
+        if: matrix.os == 'windows-latest'
+        run: cosign generate-key-pair
+
+      - name: Sign and generate attestations
+        if: matrix.os == 'windows-latest'
+        run: |
+          cosign sign-blob \
+            --key ./cosign.key \
+            --yes \
+            --output-signature ./Stirling-PDF-win-installer.exe.sig \
+            ./Stirling-PDF-win-installer.exe
+
+          cosign attest-blob \
+            --predicate - \
+            --key ./cosign.key \
+            --yes \
+            --output-attestation ./Stirling-PDF-win-installer.exe.intoto.jsonl \
+            ./Stirling-PDF-win-installer.exe
+
+          cosign verify-blob \
+            --key ./cosign.pub \
+            --signature ./Stirling-PDF-win-installer.exe.sig \
+            ./Stirling-PDF-win-installer.exe
+
+      - name: Display structure of downloaded files
+        run: ls -R
+
+      - name: Upload signed artifacts
+        uses: actions/upload-artifact@4cec3d8aa04e39d1a68397de0c4cd6fb9dce8ec1 # v4.6.1
+        with:
+          retention-days: 1
+          if-no-files-found: error
+          name: ${{ matrix.platform }}signed
+          path: |
+            ./Stirling-PDF-${{ matrix.platform }}installer.*
+            !cosign.*
+
+  create-release:
+    needs: [read_versions, sign_verify, sign_verify-portable]
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Harden Runner
+        uses: step-security/harden-runner@4d991eb9b905ef189e4c376166672c3f2f230481 # v2.11.0
+        with:
+          egress-policy: audit
+
+      - name: Download signed artifacts
+        uses: actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16 # v4.1.8
+      - name: Display structure of downloaded files
+        run: ls -R
+      - name: Upload binaries, attestations and signatures to Release and create GitHub Release
         uses: softprops/action-gh-release@01570a1f39cb168c169c802c3bceb9e93fb10974 # v2.1.0
         with:
-          files: ./Stirling-PDF-${{ matrix.platform }}-installer.${{ matrix.ext }}
+          tag_name: v${{ needs.read_versions.outputs.version }}
+          generate_release_notes: true
+          files: |
+            ./*signed/*

.github/workflows/pre_commit.yml

@@ -1,51 +1,77 @@
 name: Pre-commit
 
 on:
-  push:
-    branches: [main]
+  workflow_dispatch:
+  schedule:
+    - cron: "0 0 * * 1"
 
-permissions: read-all
+permissions:
+  contents: read
 
 jobs:
-  update:
-    if: ${{ github.event.pull_request.user.login != 'dependabot[bot]' }}
+  pre-commit:
     runs-on: ubuntu-latest
     permissions:
       contents: write
       pull-requests: write
     steps:
+      - name: Harden Runner
+        uses: step-security/harden-runner@4d991eb9b905ef189e4c376166672c3f2f230481 # v2.11.0
+        with:
+          egress-policy: audit
+
+      - name: Generate GitHub App Token
+        id: generate-token
+        uses: actions/create-github-app-token@0d564482f06ca65fa9e77e2510873638c82206f2 # v1.11.5
+        with:
+          app-id: ${{ secrets.GH_APP_ID }}
+          private-key: ${{ secrets.GH_APP_PRIVATE_KEY }}
+
+      - name: Get GitHub App User ID
+        id: get-user-id
+        run: echo "user-id=$(gh api "/users/${{ steps.generate-token.outputs.app-slug }}[bot]" --jq .id)" >> $GITHUB_OUTPUT
+        env:
+          GH_TOKEN: ${{ steps.generate-token.outputs.token }}
+
+      - id: committer
+        run: |
+          echo "string=${{ steps.generate-token.outputs.app-slug }}[bot] <${{ steps.get-user-id.outputs.user-id }}+${{ steps.generate-token.outputs.app-slug }}[bot]@users.noreply.github.com>"  >> "$GITHUB_OUTPUT"
+
       - name: Checkout repository
         uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
         with:
           fetch-depth: 0
       - name: Set up Python
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@42375524e23c412d93fb67b49958b491fce71c38 # v5.4.0
         with:
           python-version: 3.12
+          cache: 'pip' # caching pip dependencies
       - name: Run Pre-Commit Hooks
-        uses: pre-commit/action@2c7b3805fd2a0fd8c1884dcaebf91fc102a13ecd # v3.0.1
+        run: |
+          pip install --require-hashes -r ./.github/scripts/requirements_pre_commit.txt
+      - run: pre-commit run --all-files -c .pre-commit-config.yaml
         continue-on-error: true
       - 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"
+          git config --global user.name ${{ steps.generate-token.outputs.app-slug }}[bot]
+          git config --global user.email "${{ steps.get-user-id.outputs.user-id }}+${{ steps.generate-token.outputs.app-slug }}[bot]@users.noreply.github.com"
       - name: git add
         run: |
           git add .
-          git diff --staged --quiet || git commit -m ":file_folder: pre-commit
-          > Made via .github/workflows/pre_commit.yml" || echo "pre-commit: no changes"
+          git diff --staged --quiet || echo "CHANGES_DETECTED=true" >> $GITHUB_ENV
       - name: Create Pull Request
-        uses: peter-evans/create-pull-request@5e914681df9dc83aa4e4905692ca88beb2f9e91f # v7.0.5
+        if: env.CHANGES_DETECTED == 'true'
+        uses: peter-evans/create-pull-request@dd2324fc52d5d43c699a5636bcf19fceaa70c284 # v7.0.7
         with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-          commit-message: "ci: 🤖 format everything with pre-commit"
-          committer: GitHub Action <action@github.com>
-          author: GitHub Action <action@github.com>
+          token: ${{ steps.generate-token.outputs.token }}
+          commit-message: ":file_folder: pre-commit"
+          committer: ${{ steps.committer.outputs.string }}
+          author: ${{ steps.committer.outputs.string }}
           signoff: true
           branch: pre-commit
-          title: "🤖 format everything with pre-commit by <github-actions[bot]>"
+          title: "🤖 format everything with pre-commit by <${{ steps.generate-token.outputs.app-slug }}>"
           body: |
-            Auto-generated by [create-pull-request][1]
+            Auto-generated by [create-pull-request][1] with **${{ steps.generate-token.outputs.app-slug }}**
 
             [1]: https://github.com/peter-evans/create-pull-request
           draft: false

.github/workflows/push-docker.yml

@@ -9,45 +9,46 @@ on:
 
 permissions:
   contents: read
-  packages: write
-  id-token: write
 
 jobs:
   push:
     runs-on: ubuntu-latest
     permissions:
       packages: write
+      id-token: write
     steps:
       - name: Harden Runner
-        uses: step-security/harden-runner@0080882f6c36860b6ba35c610c98ce87d4e2f26f # v2.10.2
+        uses: step-security/harden-runner@4d991eb9b905ef189e4c376166672c3f2f230481 # v2.11.0
         with:
           egress-policy: audit
 
       - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
 
       - name: Set up JDK 17
-        uses: actions/setup-java@7a6d8a8234af8eb26422e24e3006232cccaa061b # v4.6.0
+        uses: actions/setup-java@3a4f6e1af504cf6a31855fa899c6aa5355ba6c12 # v4.7.0
         with:
           java-version: "17"
           distribution: "temurin"
 
-      - uses: gradle/actions/setup-gradle@0bdd871935719febd78681f197cd39af5b6e16a6 # v4.2.2
+      - uses: gradle/actions/setup-gradle@94baf225fe0a508e581a564467443d0e2379123b # v4.3.0
         with:
-          gradle-version: 8.7
+          gradle-version: 8.12
 
       - name: Run Gradle Command
         run: ./gradlew clean build
         env:
           DOCKER_ENABLE_SECURITY: false
+          STIRLING_PDF_DESKTOP_UI: false
 
       - name: Install cosign
-        uses: sigstore/cosign-installer@v3.7.0
+        if: github.ref == 'refs/heads/master'
+        uses: sigstore/cosign-installer@d7d6bc7722e3daa8354c50bcb52f4837da5e9b6a # v3.8.1
         with:
-          cosign-release: 'v2.4.1'
+          cosign-release: "v2.4.1"
 
       - name: Set up Docker Buildx
         id: buildx
-        uses: docker/setup-buildx-action@6524bf65af31da8d45b59e8c27de4bd072b392f5 # v3.8.0
+        uses: docker/setup-buildx-action@f7ce87c1d6bead3e36075b2ce75da1f6cc28aaca # v3.9.0
 
       - name: Get version number
         id: versionNumber
@@ -67,7 +68,7 @@ jobs:
           password: ${{ github.token }}
 
       - name: Set up QEMU
-        uses: docker/setup-qemu-action@49b3bc8e6bdd4a60e6116a5414239cba5943d3cf # v3.2.0
+        uses: docker/setup-qemu-action@4574d27a4764455b42196d70a065bc6853246a25 # v3.4.0
 
       - name: Convert repository owner to lowercase
         id: repoowner
@@ -89,7 +90,7 @@ jobs:
 
       - name: Build and push main Dockerfile
         id: build-push-regular
-        uses: docker/build-push-action@48aba3b46d1b1fec4febb7c5d0c644b249a11355 # v6.10.0
+        uses: docker/build-push-action@0adf9959216b96bec444f325f1e493d4aa344497 # v6.14.0
         with:
           builder: ${{ steps.buildx.outputs.name }}
           context: .
@@ -105,31 +106,18 @@ jobs:
           sbom: true
 
       - name: Sign regular images
+        if: github.ref == 'refs/heads/master'
         env:
           DIGEST: ${{ steps.build-push-regular.outputs.digest }}
           TAGS: ${{ steps.meta.outputs.tags }}
           COSIGN_PRIVATE_KEY: ${{ secrets.COSIGN_PRIVATE_KEY }}
           COSIGN_PASSWORD: ${{ secrets.COSIGN_PASSWORD }}
         run: |
-          # Always sign images regardless of branch
           echo "$TAGS" | tr ',' '\n' | while read -r tag; do
             cosign sign --yes \
               --key env://COSIGN_PRIVATE_KEY \
               "${tag}@${DIGEST}"
           done
-          
-          # For alpha builds specifically, we want to ensure they're marked as development builds
-          if [[ "${{ github.ref }}" == "refs/heads/main" ]]; then
-            echo "Signing alpha build with development attestation"
-            echo "$TAGS" | tr ',' '\n' | while read -r tag; do
-              if [[ $tag == *":alpha" ]]; then
-                cosign attest --key env://COSIGN_PRIVATE_KEY \
-                  --predicate <(echo '{"type":"development"}') \
-                  --yes "${tag}@${DIGEST}"
-              fi
-            done
-          fi
-
 
       - name: Generate tags ultra-lite
         id: meta2
@@ -147,7 +135,7 @@ jobs:
 
       - name: Build and push Dockerfile-ultra-lite
         id: build-push-lite
-        uses: docker/build-push-action@48aba3b46d1b1fec4febb7c5d0c644b249a11355 # v6.10.0
+        uses: docker/build-push-action@0adf9959216b96bec444f325f1e493d4aa344497 # v6.14.0
         if: github.ref != 'refs/heads/main'
         with:
           context: .
@@ -162,18 +150,6 @@ jobs:
           provenance: true
           sbom: true
 
-      - name: Sign ultra-lite images
-        if: github.ref != 'refs/heads/main'
-        env:
-          DIGEST: ${{ steps.build-push-lite.outputs.digest }}
-          TAGS: ${{ steps.meta2.outputs.tags }}
-          COSIGN_PRIVATE_KEY: ${{ secrets.COSIGN_PRIVATE_KEY }}
-          COSIGN_PASSWORD: ${{ secrets.COSIGN_PASSWORD }}
-        run: |
-          echo "$TAGS" | tr ',' '\n' | while read -r tag; do
-            cosign sign --key env://COSIGN_PRIVATE_KEY --yes "${tag}@${DIGEST}"
-          done
-
       - name: Generate tags fat
         id: meta3
         uses: docker/metadata-action@369eb591f429131d6889c46b94e711f089e6ca96 # v5.6.1
@@ -190,7 +166,7 @@ jobs:
 
       - name: Build and push main Dockerfile fat
         id: build-push-fat
-        uses: docker/build-push-action@48aba3b46d1b1fec4febb7c5d0c644b249a11355 # v6.10.0
+        uses: docker/build-push-action@0adf9959216b96bec444f325f1e493d4aa344497 # v6.14.0
         if: github.ref != 'refs/heads/main'
         with:
           builder: ${{ steps.buildx.outputs.name }}
@@ -207,7 +183,7 @@ jobs:
           sbom: true
 
       - name: Sign fat images
-        if: github.ref != 'refs/heads/main'
+        if: github.ref == 'refs/heads/master'
         env:
           DIGEST: ${{ steps.build-push-fat.outputs.digest }}
           TAGS: ${{ steps.meta3.outputs.tags }}

.github/workflows/releaseArtifacts.yml

@@ -5,14 +5,74 @@ on:
   release:
     types: [created]
 
-permissions: read-all
+permissions:
+  contents: read
 
 jobs:
-  push:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        enable_security: [true, false]
+        include:
+          - enable_security: true
+            file_suffix: "-with-login"
+          - enable_security: false
+            file_suffix: ""
+    outputs:
+      version: ${{ steps.versionNumber.outputs.versionNumber }}
+    steps:
+      - name: Harden Runner
+        uses: step-security/harden-runner@4d991eb9b905ef189e4c376166672c3f2f230481 # v2.11.0
+        with:
+          egress-policy: audit
+
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+
+      - name: Set up JDK 17
+        uses: actions/setup-java@3a4f6e1af504cf6a31855fa899c6aa5355ba6c12 # v4.7.0
+        with:
+          java-version: "17"
+          distribution: "temurin"
+
+      - uses: gradle/actions/setup-gradle@94baf225fe0a508e581a564467443d0e2379123b # v4.3.0
+        with:
+          gradle-version: 8.12
+
+      - name: Generate jar (With Security=${{ matrix.enable_security }})
+        run: ./gradlew clean createExe
+        env:
+          DOCKER_ENABLE_SECURITY: ${{ matrix.enable_security }}
+          STIRLING_PDF_DESKTOP_UI: false
+
+      - name: Get version number
+        id: versionNumber
+        run: |
+          VERSION=$(grep "^version =" build.gradle | awk -F'"' '{print $2}')
+          echo "versionNumber=$VERSION" >> $GITHUB_OUTPUT
+
+      - name: Rename binaries
+        run: |
+          mv ./build/launch4j/Stirling-PDF.exe ./build/launch4j/Stirling-PDF-Server${{ matrix.file_suffix }}.exe
+          mv ./build/libs/Stirling-PDF-${{ steps.versionNumber.outputs.versionNumber }}.jar ./build/libs/Stirling-PDF${{ matrix.file_suffix }}.jar
+
+      - name: Debug build artifacts
+        run: |
+          echo "Current Directory: $(pwd)"
+          ls -R ./build/libs
+          ls -R ./build/launch4j
+
+      - name: Upload build artifacts
+        uses: actions/upload-artifact@4cec3d8aa04e39d1a68397de0c4cd6fb9dce8ec1 # v4.6.1
+        with:
+          name: binaries${{ matrix.file_suffix }}
+          path: |
+            ./build/launch4j/Stirling-PDF-Server${{ matrix.file_suffix }}.*
+            ./build/libs/Stirling-PDF${{ matrix.file_suffix }}.*
+
+  sign_verify:
+    needs: build
     runs-on: ubuntu-latest
-    permissions:
-      contents: write
-      packages: write
     strategy:
       matrix:
         enable_security: [true, false]
@@ -23,62 +83,98 @@ jobs:
             file_suffix: ""
     steps:
       - name: Harden Runner
-        uses: step-security/harden-runner@0080882f6c36860b6ba35c610c98ce87d4e2f26f # v2.10.2
+        uses: step-security/harden-runner@4d991eb9b905ef189e4c376166672c3f2f230481 # v2.11.0
         with:
           egress-policy: audit
 
-      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
-
-      - name: Set up JDK 17
-        uses: actions/setup-java@7a6d8a8234af8eb26422e24e3006232cccaa061b # v4.6.0
+      - name: Download build artifacts
+        uses: actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16 # v4.1.8
         with:
-          java-version: "17"
-          distribution: "temurin"
+          name: binaries${{ matrix.file_suffix }}
+      - name: Display structure of downloaded files
+        run: ls -R
 
-      - uses: gradle/actions/setup-gradle@0bdd871935719febd78681f197cd39af5b6e16a6 # v4.2.2
+      - name: Install Cosign
+        uses: sigstore/cosign-installer@d7d6bc7722e3daa8354c50bcb52f4837da5e9b6a # v3.8.1
+
+      - name: Generate key pair
+        run: cosign generate-key-pair
+
+      - name: Sign and generate attestations
+        run: |
+          cosign sign-blob \
+            --key ./cosign.key \
+            --yes \
+            --output-signature ./libs/Stirling-PDF${{ matrix.file_suffix }}.jar.sig \
+            ./libs/Stirling-PDF${{ matrix.file_suffix }}.jar
+
+          cosign attest-blob \
+            --predicate - \
+            --key ./cosign.key \
+            --yes \
+            --output-attestation ./libs/Stirling-PDF${{ matrix.file_suffix }}.jar.intoto.jsonl \
+            ./libs/Stirling-PDF${{ matrix.file_suffix }}.jar
+
+          cosign verify-blob \
+            --key ./cosign.pub \
+            --signature ./libs/Stirling-PDF${{ matrix.file_suffix }}.jar.sig \
+            ./libs/Stirling-PDF${{ matrix.file_suffix }}.jar
+
+          cosign sign-blob \
+            --key ./cosign.key \
+            --yes \
+            --output-signature ./launch4j/Stirling-PDF-Server${{ matrix.file_suffix }}.exe.sig \
+            ./launch4j/Stirling-PDF-Server${{ matrix.file_suffix }}.exe
+
+          cosign attest-blob \
+            --predicate - \
+            --key ./cosign.key \
+            --yes \
+            --output-attestation ./launch4j/Stirling-PDF-Server${{ matrix.file_suffix }}.exe.intoto.jsonl \
+            ./launch4j/Stirling-PDF-Server${{ matrix.file_suffix }}.exe
+
+          cosign verify-blob \
+            --key ./cosign.pub \
+            --signature ./launch4j/Stirling-PDF-Server${{ matrix.file_suffix }}.exe.sig \
+            ./launch4j/Stirling-PDF-Server${{ matrix.file_suffix }}.exe
+
+      - name: Upload signed artifacts
+        uses: actions/upload-artifact@4cec3d8aa04e39d1a68397de0c4cd6fb9dce8ec1 # v4.6.1
         with:
-          gradle-version: 8.7
+          name: signed${{ matrix.file_suffix }}
+          path: |
+            ./libs/Stirling-PDF${{ matrix.file_suffix }}.*
+            ./launch4j/Stirling-PDF-Server${{ matrix.file_suffix }}.*
 
-      - name: Generate jar (With Security=${{ matrix.enable_security }})
-        run: ./gradlew clean createExe
-        env:
-          DOCKER_ENABLE_SECURITY: ${{ matrix.enable_security }}
-          STIRLING_PDF_DESKTOP_UI: false
-
-      - name: Get version number
-        id: versionNumber
-        run: echo "versionNumber=$(./gradlew printVersion --quiet | tail -1)" >> $GITHUB_OUTPUT
-
-      - name: Rename binarie
-        run: cp ./build/launch4j/Stirling-PDF.exe ./build/launch4j/Stirling-PDF-Server${{ matrix.file_suffix }}.exe
-
-      - name: Upload Assets binarie
-        uses: actions/upload-artifact@6f51ac03b9356f520e9adb1b1b7802705f340c2b # v4.5.0
+  release:
+    needs: [build, sign_verify]
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    strategy:
+      matrix:
+        enable_security: [true, false]
+        include:
+          - enable_security: true
+            file_suffix: "-with-login"
+          - enable_security: false
+            file_suffix: ""
+    steps:
+      - name: Harden Runner
+        uses: step-security/harden-runner@4d991eb9b905ef189e4c376166672c3f2f230481 # v2.11.0
         with:
-          path: ./build/launch4j/Stirling-PDF-Server${{ matrix.file_suffix }}.exe
-          name: Stirling-PDF-Server${{ matrix.file_suffix }}.exe
-          overwrite: true
-          retention-days: 1
-          if-no-files-found: error
+          egress-policy: audit
 
-      - name: Upload binaries to release
+      - name: Download signed artifacts
+        uses: actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16 # v4.1.8
+        with:
+          name: signed${{ matrix.file_suffix }}
+
+      - name: Upload binaries, attestations and signatures to Release and create GitHub Release
         uses: softprops/action-gh-release@01570a1f39cb168c169c802c3bceb9e93fb10974 # v2.1.0
         with:
-          files: ./build/launch4j/Stirling-PDF-Server${{ matrix.file_suffix }}.exe
-
-      - name: Rename jar binaries
-        run: cp ./build/libs/Stirling-PDF-${{ steps.versionNumber.outputs.versionNumber }}.jar ./build/libs/Stirling-PDF${{ matrix.file_suffix }}.jar
-
-      - name: Upload Assets jar binaries
-        uses: actions/upload-artifact@6f51ac03b9356f520e9adb1b1b7802705f340c2b # v4.5.0
-        with:
-          path: ./build/libs/Stirling-PDF${{ matrix.file_suffix }}.jar
-          name: Stirling-PDF${{ matrix.file_suffix }}.jar
-          overwrite: true
-          retention-days: 1
-          if-no-files-found: error
-
-      - name: Upload jar binaries to release
-        uses: softprops/action-gh-release@01570a1f39cb168c169c802c3bceb9e93fb10974 # v2.1.0
-        with:
-          files: ./build/libs/Stirling-PDF${{ matrix.file_suffix }}.jar
+          tag_name: v${{ needs.build.outputs.version }}
+          generate_release_notes: true
+          files: |
+            ./libs/Stirling-PDF*
+            ./launch4j/Stirling-PDF-Server*

.github/workflows/scorecards.yml

@@ -10,7 +10,7 @@ on:
   # To guarantee Maintained check is occasionally updated. See
   # https://github.com/ossf/scorecard/blob/main/docs/checks.md#maintained
   schedule:
-    - cron: '20 7 * * 2'
+    - cron: "20 7 * * 2"
   push:
     branches: ["main"]
 permissions: read-all
@@ -34,7 +34,7 @@ jobs:
 
     steps:
       - name: Harden Runner
-        uses: step-security/harden-runner@0080882f6c36860b6ba35c610c98ce87d4e2f26f # v2.10.2
+        uses: step-security/harden-runner@4d991eb9b905ef189e4c376166672c3f2f230481 # v2.11.0
         with:
           egress-policy: audit
 
@@ -44,7 +44,7 @@ jobs:
           persist-credentials: false
 
       - name: "Run analysis"
-        uses: ossf/scorecard-action@62b2cac7ed8198b15735ed49ab1e5cf35480ba46 # v2.4.0
+        uses: ossf/scorecard-action@f49aabe0b5af0936a0987cfb85d86b75731b0186 # v2.4.1
         with:
           results_file: results.sarif
           results_format: sarif
@@ -66,7 +66,7 @@ jobs:
       # Upload the results as artifacts (optional). Commenting out will disable uploads of run results in SARIF
       # format to the repository Actions tab.
       - name: "Upload artifact"
-        uses: actions/upload-artifact@6f51ac03b9356f520e9adb1b1b7802705f340c2b # v4.5.0
+        uses: actions/upload-artifact@4cec3d8aa04e39d1a68397de0c4cd6fb9dce8ec1 # v4.6.1
         with:
           name: SARIF file
           path: results.sarif
@@ -74,6 +74,6 @@ jobs:
 
       # Upload the results to GitHub's code scanning dashboard.
       - name: "Upload to code-scanning"
-        uses: github/codeql-action/upload-sarif@48ab28a6f5dbc2a99bf1e0131198dd8f1df78169 # v3.28.0
+        uses: github/codeql-action/upload-sarif@b56ba49b26e50535fa1e7f7db0f4f7b4bf65d80d # v3.28.10
         with:
           sarif_file: results.sarif

.github/workflows/sonarqube.yml

@@ -0,0 +1,63 @@
+name: Run Sonarqube
+
+on:
+  push:
+    branches:
+      - master
+  pull_request_target:
+    branches:
+      - main
+  workflow_dispatch:
+
+permissions:
+  pull-requests: read
+  actions: read
+
+jobs:
+  sonarqube:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Harden Runner
+        uses: step-security/harden-runner@4d991eb9b905ef189e4c376166672c3f2f230481 # v2.11.0
+        with:
+          egress-policy: audit
+
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        with:
+          fetch-depth: 0
+
+      - name: Setup Gradle
+        uses: gradle/actions/setup-gradle@94baf225fe0a508e581a564467443d0e2379123b # v4.3.0
+
+      - name: Build and analyze with Gradle
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+          DOCKER_ENABLE_SECURITY: true
+          STIRLING_PDF_DESKTOP_UI: true
+        run: |
+          ./gradlew clean build sonar \
+            -Dsonar.projectKey=Stirling-Tools_Stirling-PDF \
+            -Dsonar.organization=stirling-tools \
+            -Dsonar.host.url=https://sonarcloud.io \
+            -Dsonar.login=${SONAR_TOKEN} \
+            -Dsonar.log.level=DEBUG \
+            --info
+
+      - name: Upload Problems Report on Failure
+        if: failure()
+        uses: actions/upload-artifact@4cec3d8aa04e39d1a68397de0c4cd6fb9dce8ec1 # v4.6.1
+        with:
+          name: gradle-problems-report
+          path: build/reports/problems/problems-report.html
+          retention-days: 7
+
+      - name: Upload Sonar Logs on Failure
+        if: failure()
+        uses: actions/upload-artifact@4cec3d8aa04e39d1a68397de0c4cd6fb9dce8ec1 # v4.6.1
+        with:
+          name: sonar-logs
+          path: |
+            .scannerwork/report-task.txt
+            build/sonar/
+          retention-days: 7

.github/workflows/stale.yml

@@ -5,7 +5,8 @@ on:
     - cron: "30 0 * * *"
   workflow_dispatch:
 
-permissions: read-all
+permissions:
+  contents: read
 
 jobs:
   stale:
@@ -15,12 +16,12 @@ jobs:
       pull-requests: write
     steps:
       - name: Harden Runner
-        uses: step-security/harden-runner@0080882f6c36860b6ba35c610c98ce87d4e2f26f # v2.10.2
+        uses: step-security/harden-runner@4d991eb9b905ef189e4c376166672c3f2f230481 # v2.11.0
         with:
           egress-policy: audit
 
       - name: 30 days stale issues
-        uses: actions/stale@28ca1036281a5e5922ead5184a1bbf96e5fc984e # v9.0.0
+        uses: actions/stale@5bef64f19d7facfb25b37b414482c7164d639639 # v9.1.0
         with:
           repo-token: ${{ secrets.GITHUB_TOKEN }}
           days-before-stale: 30
@@ -36,4 +37,4 @@ jobs:
           only-issue-labels: "more-info-needed"
           days-before-pr-stale: -1 # Prevents PRs from being marked as stale
           days-before-pr-close: -1 # Prevents PRs from being closed
-          start-date: '2024-07-06T00:00:00Z'  # ISO 8601 Format
+          start-date: "2024-07-06T00:00:00Z" # ISO 8601 Format

.github/workflows/swagger.yml

@@ -6,26 +6,27 @@ on:
     branches:
       - master
 
-permissions: read-all
+permissions:
+  contents: read
 
 jobs:
   push:
     runs-on: ubuntu-latest
     steps:
       - name: Harden Runner
-        uses: step-security/harden-runner@0080882f6c36860b6ba35c610c98ce87d4e2f26f # v2.10.2
+        uses: step-security/harden-runner@4d991eb9b905ef189e4c376166672c3f2f230481 # v2.11.0
         with:
           egress-policy: audit
 
       - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
 
       - name: Set up JDK 17
-        uses: actions/setup-java@7a6d8a8234af8eb26422e24e3006232cccaa061b # v4.6.0
+        uses: actions/setup-java@3a4f6e1af504cf6a31855fa899c6aa5355ba6c12 # v4.7.0
         with:
           java-version: "17"
           distribution: "temurin"
 
-      - uses: gradle/actions/setup-gradle@0bdd871935719febd78681f197cd39af5b6e16a6 # v4.2.2
+      - uses: gradle/actions/setup-gradle@94baf225fe0a508e581a564467443d0e2379123b # v4.3.0
 
       - name: Generate Swagger documentation
         run: ./gradlew generateOpenApiDocs

.github/workflows/sync_files.yml

@@ -1,61 +1,145 @@
 name: Sync Files
 
 on:
+  workflow_dispatch:
   push:
     branches:
       - main
     paths:
       - "build.gradle"
+      - "README.md"
       - "src/main/resources/messages_*.properties"
+      - "src/main/resources/static/3rdPartyLicenses.json"
       - "scripts/ignore_translation.toml"
 
-permissions: read-all
+permissions:
+  contents: read
 
 jobs:
-  sync-readme:
+  read_bot_entries:
     runs-on: ubuntu-latest
-    permissions:
-      contents: write
-      pull-requests: write
+    outputs:
+      userName: ${{ steps.get-user-id.outputs.user_name }}
+      userEmail: ${{ steps.get-user-id.outputs.user_email }}
+      committer: ${{ steps.committer.outputs.committer }}
     steps:
       - name: Harden Runner
-        uses: step-security/harden-runner@0080882f6c36860b6ba35c610c98ce87d4e2f26f # v2.10.2
+        uses: step-security/harden-runner@4d991eb9b905ef189e4c376166672c3f2f230481 # v2.11.0
         with:
           egress-policy: audit
 
-      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
-      - name: Set up Python
-        uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0
+      - name: Generate GitHub App Token
+        id: generate-token
+        uses: actions/create-github-app-token@0d564482f06ca65fa9e77e2510873638c82206f2 # v1.11.5
         with:
-          python-version: "3.x"
-      - name: Install dependencies
-        run: pip install tomlkit
-      - name: Sync README
-        run: python scripts/counter_translation.py
+          app-id: ${{ secrets.GH_APP_ID }}
+          private-key: ${{ secrets.GH_APP_PRIVATE_KEY }}
+
+      - name: Get GitHub App User ID
+        id: get-user-id
+        run: |
+          USER_NAME="${{ steps.generate-token.outputs.app-slug }}[bot]"
+          USER_ID=$(gh api "/users/$USER_NAME" --jq .id)
+          USER_EMAIL="$USER_ID+$USER_NAME@users.noreply.github.com"
+          echo "user_name=$USER_NAME" >> "$GITHUB_OUTPUT"
+          echo "user_email=$USER_EMAIL" >> "$GITHUB_OUTPUT"
+          echo "user-id=$USER_ID" >> "$GITHUB_OUTPUT"
+        env:
+          GH_TOKEN: ${{ steps.generate-token.outputs.token }}
+
+      - id: committer
+        run: |
+          COMMITTER="${{ steps.get-user-id.outputs.user_name }} <${{ steps.get-user-id.outputs.user_email }}>"
+          echo "committer=$COMMITTER" >> "$GITHUB_OUTPUT"
+
+  sync-files:
+    needs: ["read_bot_entries"]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Harden Runner
+        uses: step-security/harden-runner@4d991eb9b905ef189e4c376166672c3f2f230481 # v2.11.0
+        with:
+          egress-policy: audit
+
+      - name: Generate GitHub App Token
+        id: generate-token
+        uses: actions/create-github-app-token@0d564482f06ca65fa9e77e2510873638c82206f2 # v1.11.5
+        with:
+          app-id: ${{ vars.GH_APP_ID }}
+          private-key: ${{ secrets.GH_APP_PRIVATE_KEY }}
+
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+
+      - name: Set up Python
+        uses: actions/setup-python@42375524e23c412d93fb67b49958b491fce71c38 # v5.4.0
+        with:
+          python-version: "3.12"
+          cache: 'pip' # caching pip dependencies
+
+      - name: Sync translation property files
+        run: |
+          python .github/scripts/check_language_properties.py --reference-file "src/main/resources/messages_en_GB.properties" --branch main
+
       - name: Set up git config
         run: |
-          git config --global user.name "github-actions[bot]"
-          git config --global user.email "github-actions[bot]@users.noreply.github.com"
+          git config --global user.name ${{ needs.read_bot_entries.outputs.userName }}
+          git config --global user.email ${{ needs.read_bot_entries.outputs.userEmail }}
+
       - name: Run git add
         run: |
-          git add .
-          git diff --staged --quiet || git commit -m ":memo: Sync README
-          > Made via sync_files.yml" || echo "no changes"
+          git add src/main/resources/messages_*.properties
+          git diff --staged --quiet || git commit -m ":memo: Sync translation files" || echo "no changes"
+
+      - name: Install dependencies
+        run: pip install --require-hashes -r ./.github/scripts/requirements_sync_readme.txt
+
+      - name: Sync README.md
+        run: |
+          python scripts/counter_translation.py
+
+      - name: Run git add
+        run: |
+          git add README.md
+          git diff --staged --quiet || git commit -m ":memo: Sync README.md" || echo "no changes"
+
       - name: Create Pull Request
-        uses: peter-evans/create-pull-request@5e914681df9dc83aa4e4905692ca88beb2f9e91f # v7.0.5
+        uses: peter-evans/create-pull-request@dd2324fc52d5d43c699a5636bcf19fceaa70c284 # v7.0.7
         with:
-          token: ${{ secrets.GITHUB_TOKEN }}
+          token: ${{ steps.generate-token.outputs.token }}
           commit-message: Update files
-          committer: GitHub Action <action@github.com>
-          author: GitHub Action <action@github.com>
+          committer: ${{ needs.read_bot_entries.outputs.committer }}
+          author: ${{ needs.read_bot_entries.outputs.committer }}
           signoff: true
           branch: sync_readme
-          title: ":memo: Update README: Translation Progress Table"
+          title: ":globe_with_meridians: Sync Translations + Update README Progress Table"
           body: |
-            Auto-generated by [create-pull-request][1]
+            ### Description of Changes
+
+            This Pull Request was automatically generated to synchronize updates to translation files and documentation. Below are the details of the changes made:
+
+            #### **1. Synchronization of Translation Files**
+            - Updated translation files (`messages_*.properties`) to reflect changes in the reference file `messages_en_GB.properties`.
+            - Ensured consistency and synchronization across all supported language files.
+            - Highlighted any missing or incomplete translations.
+
+            #### **2. Update README.md**
+            - Generated the translation progress table in `README.md`.
+            - Added a summary of the current translation status for all supported languages.
+            - Included up-to-date statistics on translation coverage.
+
+            #### **Why these changes are necessary**
+            - Keeps translation files aligned with the latest reference updates.
+            - Ensures the documentation reflects the current translation progress.
+
+            ---
+
+            Auto-generated by [create-pull-request][1].
 
             [1]: https://github.com/peter-evans/create-pull-request
           draft: false
           delete-branch: true
-          labels: Documentation,Translation,github-actions
+          labels: github-actions
           sign-commits: true
+          add-paths: |
+            README.md
+            src/main/resources/messages_*.properties

.github/workflows/testdriver.yml

@@ -0,0 +1,154 @@
+name: UI test with TestDriverAI
+
+on:
+  push:
+    branches: ["master", "UITest", "testdriver"]
+
+permissions:
+  contents: read
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Harden Runner
+        uses: step-security/harden-runner@4d991eb9b905ef189e4c376166672c3f2f230481 # v2.11.0
+        with:
+          egress-policy: audit
+
+      - name: Checkout repository
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+
+      - name: Set up JDK
+        uses: actions/setup-java@3a4f6e1af504cf6a31855fa899c6aa5355ba6c12 # v4.7.0
+        with:
+          java-version: '17'
+          distribution: 'temurin'
+
+      - name: Build with Gradle
+        run: ./gradlew clean build
+        env:
+          DOCKER_ENABLE_SECURITY: false
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@f7ce87c1d6bead3e36075b2ce75da1f6cc28aaca # v3.9.0
+
+      - name: Get version number
+        id: versionNumber
+        run: |
+          VERSION=$(grep "^version =" build.gradle | awk -F'"' '{print $2}')
+          echo "versionNumber=$VERSION" >> $GITHUB_OUTPUT
+
+      - name: Login to Docker Hub
+        uses: docker/login-action@9780b0c442fbb1117ed29e0efdff1e18412f7567 # v3.3.0
+        with:
+          username: ${{ secrets.DOCKER_HUB_USERNAME }}
+          password: ${{ secrets.DOCKER_HUB_API }}
+
+      - name: Build and push test image
+        uses: docker/build-push-action@0adf9959216b96bec444f325f1e493d4aa344497 # v6.14.0
+        with:
+          context: .
+          file: ./Dockerfile
+          push: true
+          tags: ${{ secrets.DOCKER_HUB_USERNAME }}/test:test-${{ github.sha }}
+          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: |
+          cat > docker-compose.yml << EOF
+          version: '3.3'
+          services:
+            stirling-pdf:
+              container_name: stirling-pdf-test-${{ github.sha }}
+              image: ${{ secrets.DOCKER_HUB_USERNAME }}/test:test-${{ github.sha }}
+              ports:
+                - "1337:8080"
+              volumes:
+                - /stirling/test-${{ github.sha }}/data:/usr/share/tessdata:rw
+                - /stirling/test-${{ github.sha }}/config:/configs:rw
+                - /stirling/test-${{ github.sha }}/logs:/logs:rw
+              environment:
+                DOCKER_ENABLE_SECURITY: "false"
+                SECURITY_ENABLELOGIN: "false"
+                SYSTEM_DEFAULTLOCALE: en-GB
+                UI_APPNAME: "Stirling-PDF Test"
+                UI_HOMEDESCRIPTION: "Test Deployment"
+                UI_APPNAMENAVBAR: "Test"
+                SYSTEM_MAXFILESIZE: "100"
+                METRICS_ENABLED: "true"
+                SYSTEM_GOOGLEVISIBILITY: "false"
+                SYSTEM_ENABLEANALYTICS: "false"
+              restart: on-failure:5
+          EOF
+
+          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 ${{ secrets.VPS_USERNAME }}@${{ secrets.VPS_HOST }} << EOF
+            mkdir -p /stirling/test-${{ github.sha }}/{data,config,logs}
+            mv /tmp/docker-compose.yml /stirling/test-${{ github.sha }}/docker-compose.yml
+            cd /stirling/test-${{ github.sha }}
+            docker-compose pull
+            docker-compose up -d
+          EOF
+
+  test:
+    needs: deploy
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Harden Runner
+        uses: step-security/harden-runner@4d991eb9b905ef189e4c376166672c3f2f230481 # v2.11.0
+        with:
+          egress-policy: audit
+
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+
+      - name: Run TestDriver.ai
+        uses: testdriverai/action@f0d0f45fdd684db628baa843fe9313f3ca3a8aa8 #1.1.3
+        with:
+          key: ${{secrets.TESTDRIVER_API_KEY}}
+          prerun: |
+            npm install
+            npm run build
+            npm install dashcam-chrome --save
+            Start-Process "C:/Program Files/Google/Chrome/Application/chrome.exe" -ArgumentList "--start-maximized", "--load-extension=$(pwd)/node_modules/dashcam-chrome/build", "http://${{ secrets.VPS_HOST }}:1337"
+            Start-Sleep -Seconds 20
+          prompt: |
+            1. /run testing/testdriver/test.yml
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          FORCE_COLOR: "3"
+
+  cleanup:
+    needs: [deploy, test]
+    runs-on: ubuntu-latest
+    if: always()
+
+    steps:
+      - name: Harden Runner
+        uses: step-security/harden-runner@4d991eb9b905ef189e4c376166672c3f2f230481 # v2.11.0
+        with:
+          egress-policy: audit
+
+      - name: Set up SSH
+        run: |
+          mkdir -p ~/.ssh/
+          echo "${{ secrets.VPS_SSH_KEY }}" > ../private.key
+          sudo chmod 600 ../private.key
+
+      - name: Cleanup deployment
+        run: |
+          ssh -i ../private.key -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null ${{ secrets.VPS_USERNAME }}@${{ secrets.VPS_HOST }} << EOF
+            cd /stirling/test-${{ github.sha }}
+            docker-compose down
+            cd /stirling
+            rm -rf test-${{ github.sha }}
+          EOF

.github/workflows/update-translations.yml

@@ -1,71 +0,0 @@
-name: Update Translations
-
-on:
-  push:
-    branches: ["main"]
-    paths:
-      - "src/main/resources/messages_en_GB.properties"
-
-permissions: read-all
-
-jobs:
-  update-translations-main:
-    if: github.event_name == 'push'
-    runs-on: ubuntu-latest
-    permissions:
-      contents: write
-      pull-requests: write
-    steps:
-      - name: Harden Runner
-        uses: step-security/harden-runner@0080882f6c36860b6ba35c610c98ce87d4e2f26f # v2.10.2
-        with:
-          egress-policy: audit
-
-      - name: Checkout repository
-        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
-
-      - name: Set up Python
-        uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0
-        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@5e914681df9dc83aa4e4905692ca88beb2f9e91f # v7.0.5
-        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
-          draft: false
-          delete-branch: true
-          labels: Translation,github-actions
-          sign-commits: true

.gitignore

@@ -14,12 +14,18 @@ local.properties
 .classpath
 .project
 version.properties
+
+#### Stirling-PDF Files ###
 pipeline/watchedFolders/
 pipeline/finishedFolders/
-#### Stirling-PDF Files ###
 customFiles/
 configs/
 watchedFolders/
+clientWebUI/
+!cucumber/
+!cucumber/exampleFiles/
+!cucumber/exampleFiles/example_html.zip
+exampleYmlFiles/stirling/
 
 # Gradle
 .gradle
@@ -111,6 +117,7 @@ watchedFolders/
 *.war
 *.nar
 *.ear
+*.zip
 *.tar.gz
 *.rar
 *.db
@@ -133,6 +140,7 @@ venv.bak/
 # VS Code
 /.vscode/**/*
 !/.vscode/settings.json
+!/.vscode/extensions.json
 
 # IntelliJ IDEA
 .idea/
@@ -146,19 +154,37 @@ out/
 # cucumber
 /cucumber/reports/**
 
-# Certs
+# Certs and Security Files
 *.p12
+*.pk8
 *.pem
 *.crt
 *.cer
+*.cert
 *.der
 *.key
 *.csr
+*.kdbx
+*.jks
+*.asc
+
+# SSH Keys
+*.pub
+*.priv
+id_rsa
+id_rsa.pub
+id_ecdsa
+id_ecdsa.pub
+id_ed25519
+id_ed25519.pub
+.ssh/
+*ssh
 
 # cache
+.cache
 .ruff_cache
 .mypy_cache
 .pytest_cache
 .ipynb_checkpoints
 
-**/jcef-bundle/
+**/jcef-bundle/

.pre-commit-config.yaml

@@ -6,10 +6,10 @@ repos:
         args:
           - --fix
           - --line-length=127
-        files: ^((.github/scripts|scripts)/.+)?[^/]+\.py$
+        files: ^((\.github/scripts|scripts)/.+)?[^/]+\.py$
         exclude: (split_photos.py)
       - id: ruff-format
-        files: ^((.github/scripts|scripts)/.+)?[^/]+\.py$
+        files: ^((\.github/scripts|scripts)/.+)?[^/]+\.py$
         exclude: (split_photos.py)
   - repo: https://github.com/codespell-project/codespell
     rev: v2.3.0
@@ -19,39 +19,18 @@ repos:
           - --ignore-words-list=
           - --skip="./.*,*.csv,*.json,*.ambr"
           - --quiet-level=2
-        files: \.(properties|html|css|js|py|md)$
-        exclude: (.vscode|.devcontainer|src/main/resources|Dockerfile)
+        files: \.(html|css|js|py|md)$
+        exclude: (.vscode|.devcontainer|src/main/resources|Dockerfile|.*/pdfjs.*|.*/thirdParty.*|bootstrap.*|.*\.min\..*|.*diff\.js)
   - repo: https://github.com/gitleaks/gitleaks
     rev: v8.22.0
     hooks:
       - id: gitleaks
-  - repo: https://github.com/jumanjihouse/pre-commit-hooks
-    rev: 3.0.0
-    hooks:
-      - id: shellcheck
-        files: ^.*(\.bash|\.sh|\.ksh|\.zsh)$
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v5.0.0
     hooks:
       - id: end-of-file-fixer
         files: ^.*(\.js|\.java|\.py|\.yml)$
-        exclude: ^(.*/pdfjs.*|.*/thirdParty.*|bootstrap.*|.*\.min\..*|.*diff\.js$)
+        exclude: ^(.*/pdfjs.*|.*/thirdParty.*|bootstrap.*|.*\.min\..*|.*diff\.js|\.github/workflows/.*$)
       - id: trailing-whitespace
         files: ^.*(\.js|\.java|\.py|\.yml)$
-        exclude: ^(.*/pdfjs.*|.*/thirdParty.*|bootstrap.*|.*\.min\..*|.*diff\.js$)
-
-  - repo: local
-    hooks:
-      - id: check-duplicate-properties-keys
-        name: Check Duplicate Properties Keys
-        entry: python .github/scripts/check_duplicates.py
-        language: python
-        files: ^(src)/.+\.properties$
-      - id: check-html-tabs
-        name: Check HTML for tabs
-        description: Ensures HTML/CSS/JS files do not contain tab characters
-        # args: ["--replace_with=  "]
-        entry: python .github/scripts/check_tabulator.py
-        language: python
-        exclude: ^(.*/pdfjs.*|.*/thirdParty.*|bootstrap.*|.*\.min\..*|.*diff\.js$)
-        files: ^.*(\.html|\.css|\.js)$
+        exclude: ^(.*/pdfjs.*|.*/thirdParty.*|bootstrap.*|.*\.min\..*|.*diff\.js|\.github/workflows/.*$)

.vscode/extensions.json

@@ -0,0 +1,23 @@
+{
+  "recommendations": [
+    "elagil.pre-commit-helper", // Support for pre-commit hooks to enforce code quality
+    "josevseb.google-java-format-for-vs-code", // Google Java code formatter to follow the Google Java Style Guide
+    "ms-python.black-formatter", // Python code formatter using Black
+    "ms-python.flake8", // Flake8 linter for Python to enforce code quality
+    "ms-python.python", // Official Microsoft Python extension with IntelliSense, debugging, and Jupyter support
+    // "ms-vscode-remote.remote-containers", // Support for remote development with containers (Docker, Dev Containers)
+    // "ms-vscode-remote.vscode-remote-extensionpack", // Remote Development Pack for SSH, WSL, and Containers
+    "Oracle.oracle-java", // Oracle Java extension with additional features for Java development
+    "redhat.java", // Java support by Red Hat with IntelliSense, debugging, and code navigation
+    "streetsidesoftware.code-spell-checker", // Spell checker for code to avoid typos
+    "vmware.vscode-boot-dev-pack", // Developer tools for Spring Boot by VMware
+    "vmware.vscode-spring-boot", // Spring Boot tools by VMware for enhanced Spring development
+    "vscjava.vscode-gradle", // Gradle extension for build and automation support
+    "vscjava.vscode-java-debug", // Debugging support for Java projects
+    "vscjava.vscode-java-dependency", // Java dependency management within VS Code
+    "vscjava.vscode-java-pack", // Java Extension Pack with essential Java tools for VS Code
+    "vscjava.vscode-java-test", // Java test framework for running and debugging tests in VS Code
+    "vscjava.vscode-spring-boot-dashboard", // Spring Boot dashboard for managing and visualizing Spring Boot applications
+    "vscjava.vscode-spring-initializr" // Support for Spring Initializr to create new Spring projects
+  ]
+}

.vscode/settings.json

@@ -2,54 +2,147 @@
   "java.compile.nullAnalysis.mode": "automatic",
   "files.eol": "auto",
   "java.configuration.updateBuildConfiguration": "interactive",
-  "black-formatter.args": ["--line-length", "127"],
-  "flake8.args": ["--max-line-length", "127"],
-  "pylint.args": ["max-line-length", "127"],
+  "black-formatter.args": [
+    "--line-length",
+    "127"
+  ],
+  "flake8.args": [
+    "--max-line-length",
+    "127"
+  ],
   "[java]": {
     "editor.tabSize": 4,
     "editor.detectIndentation": false,
-    "editor.rulers": [127]
+    "editor.rulers": [
+      127
+    ],
+    "editor.defaultFormatter": "josevseb.google-java-format-for-vs-code"
   },
   "[python]": {
     "editor.tabSize": 2,
     "editor.detectIndentation": false,
-    "editor.rulers": [127]
+    "editor.rulers": [
+      127
+    ]
   },
   "[gradle-build]": {
     "editor.tabSize": 4,
     "editor.detectIndentation": false,
-    "editor.rulers": [127]
+    "editor.rulers": [
+      127
+    ]
   },
   "[gradle]": {
     "editor.tabSize": 4,
     "editor.detectIndentation": false,
-    "editor.rulers": [127]
+    "editor.rulers": [
+      127
+    ]
   },
   "[html]": {
     "editor.tabSize": 2,
-    "editor.rulers": [127],
+    "editor.rulers": [
+      127
+    ],
     "files.trimFinalNewlines": false,
     "files.insertFinalNewline": false
   },
   "[javascript]": {
     "editor.tabSize": 2,
-    "editor.rulers": [127]
+    "editor.rulers": [
+      127
+    ]
   },
   "[yaml]": {
     "files.trimFinalNewlines": false,
     "files.insertFinalNewline": false
   },
-  "diffEditor.maxComputationTime": 0,
-  "editor.wordSegmenterLocales": null,
-  "editor.guides.bracketPairs": "active",
-  "editor.guides.bracketPairsHorizontal": "active",
   "files.insertFinalNewline": true,
   "files.trimFinalNewlines": true,
   "files.trimTrailingWhitespace": true,
+  "files.autoSave": "onFocusChange",
+  "files.autoSaveWhenNoErrors": true,
+  "diffEditor.maxComputationTime": 0,
+  "editor.wordSegmenterLocales": "",
+  "editor.guides.bracketPairs": "active",
+  "editor.guides.bracketPairsHorizontal": "active",
   "editor.indentSize": "tabSize",
   "editor.stickyScroll.enabled": false,
   "editor.minimap.enabled": false,
   "editor.formatOnSave": true,
+  "editor.insertSpaces": true,
+  "java.format.enabled": true,
+  "java.format.settings.profile": "GoogleStyle",
+  "java.format.settings.google.version": "1.25.2",
   "java.format.settings.google.mode": "jar-file",
-  "java.format.settings.google.extra": "--aosp --skip-sorting-imports"
+  "java.format.settings.google.extra": "--aosp --skip-sorting-imports --skip-javadoc-formatting",
+  // (DE) Aktiviert Kommentare im Java-Format.
+  // (EN) Enables comments in Java formatting.
+  // "java.format.comments.enabled": true,
+  // (DE) Generiert automatisch Kommentare im Code.
+  // (EN) Automatically generates comments in code.
+  // "java.codeGeneration.generateComments": true,
+  // https://github.com/redhat-developer/vscode-java/blob/master/document/_java.learnMoreAboutCleanUps.md#java-clean-ups
+  "java.saveActions.cleanup": true,
+  "java.cleanup.actions": [
+    "invertEquals", // Inverts calls to Object.equals(Object) and String.equalsIgnoreCase(String) to avoid useless null pointer exception.
+    "instanceofPatternMatch" // Replaces instanceof checks with pattern matching.
+  ],
+  // (DE) Aktiviert die Code-Vervollständigung für Java.
+  // (EN) Enables code completion for Java.
+  "java.completion.engine": "dom",
+  "java.completion.enabled": true,
+  "java.completion.importOrder": [
+    "java",
+    "javax",
+    "org",
+    "com",
+    "net",
+    "io",
+    "jakarta",
+    "lombok",
+    "me",
+    "stirling",
+  ],
+  "java.project.resourceFilters": [
+    ".devcontainer/",
+    ".git/",
+    ".github/",
+    ".gradle/",
+    ".venv/",
+    ".venv*/",
+    ".vscode/",
+    "bin/",
+    "build/",
+    "configs/",
+    "customFiles/",
+    "docs/",
+    "exampleYmlFiles",
+    "gradle/",
+    "images/",
+    "logs/",
+    "pipeline/",
+    "scripts/",
+    "testings/",
+    ".git-blame-ignore-revs",
+    ".gitattributes",
+    ".gitignore",
+    ".pre-commit-config.yaml",
+  ],
+  // Enables signature help in Java.
+  "java.signatureHelp.enabled": true,
+  // Enables detailed signature help descriptions.
+  "java.signatureHelp.description.enabled": true,
+  // Downloads sources for Maven dependencies.
+  "java.maven.downloadSources": true,
+  // Enables Gradle project import.
+  "java.import.gradle.enabled": true,
+  // Downloads sources for Eclipse projects.
+  "java.eclipse.downloadSources": true,
+  // Enables import of the Gradle wrapper.
+  "java.import.gradle.wrapper.enabled": true,
+  "spring.initializr.defaultLanguage": "Java",
+  "spring.initializr.defaultGroupId": "stirling.software.SPDF",
+  "spring.initializr.defaultArtifactId": "SPDF",
+  "cSpell.enabled": false,
 }

CONTRIBUTING.md

@@ -35,10 +35,10 @@ Documentation for Stirling-PDF is handled in a separate repository. Please see [
 
 First, make sure you've read the section [Pull Requests](#pull-requests).
 
-To build from the source, please follow this [Guide](LocalRunGuide.md).
-
 If, at any point in time, you have a question, please feel free to ask in the same issue thread or in our [Discord](https://discord.gg/FJUSXUSYec).
 
+Developers should review our [Developer Guide](DeveloperGuide.md)
+
 ## License
 
 By contributing to this project, you agree that your contributions will be licensed under the [MIT License](LICENSE).

DeveloperGuide.md

@@ -39,6 +39,16 @@ Stirling-PDF is built using:
 2. Install Docker and JDK17 if not already installed.
 
 3. Install a recommended Java IDE such as Eclipse, IntelliJ, or VSCode
+   1. Only VSCode
+      1. Open VS Code.
+      2. When prompted, install the recommended extensions.
+      3. Alternatively, open the command palette (`Ctrl + Shift + P` or `Cmd + Shift + P` on macOS) and run:
+
+        ```sh
+        Extensions: Show Recommended Extensions
+        ```
+
+      4. Install the required extensions from the list.
 
 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:

Dockerfile

@@ -1,5 +1,5 @@
 # Main stage
-FROM alpine:3.20.3
+FROM alpine:3.21.3@sha256:a8560b36e8b8210634f77d9f7f9efd7ffa463e380b75e2e74aff4511df3ef88c
 
 # Copy necessary files
 COPY scripts /scripts
@@ -25,49 +25,66 @@ LABEL org.opencontainers.image.keywords="PDF, manipulation, merge, split, conver
 # Set Environment Variables
 ENV DOCKER_ENABLE_SECURITY=false \
     VERSION_TAG=$VERSION_TAG \
-    JAVA_TOOL_OPTIONS="$JAVA_TOOL_OPTIONS -XX:MaxRAMPercentage=75" \
+    JAVA_TOOL_OPTIONS="-XX:+UnlockExperimentalVMOptions \
+    -XX:MaxRAMPercentage=75 \
+    -XX:InitiatingHeapOccupancyPercent=20 \
+    -XX:+G1PeriodicGCInvokesConcurrent \
+    -XX:G1PeriodicGCInterval=10000 \
+    -XX:+UseStringDeduplication \
+    -XX:G1PeriodicGCSystemLoadThreshold=70" \
     HOME=/home/stirlingpdfuser \
     PUID=1000 \
     PGID=1000 \
-    UMASK=022
+    UMASK=022 \
+    PYTHONPATH=/usr/lib/libreoffice/program:/opt/venv/lib/python3.12/site-packages \
+    UNO_PATH=/usr/lib/libreoffice/program \
+    URE_BOOTSTRAP=file:///usr/lib/libreoffice/program/fundamentalrc
 
 
 # JDK for app
-RUN echo "@testing https://dl-cdn.alpinelinux.org/alpine/edge/main" | tee -a /etc/apk/repositories && \
-    echo "@testing https://dl-cdn.alpinelinux.org/alpine/edge/community" | tee -a /etc/apk/repositories && \
+RUN echo "@main https://dl-cdn.alpinelinux.org/alpine/edge/main" | tee -a /etc/apk/repositories && \
+    echo "@community https://dl-cdn.alpinelinux.org/alpine/edge/community" | tee -a /etc/apk/repositories && \
     echo "@testing https://dl-cdn.alpinelinux.org/alpine/edge/testing" | tee -a /etc/apk/repositories && \
     apk upgrade --no-cache -a && \
     apk add --no-cache \
-        ca-certificates \
-        tzdata \
-        tini \
-        bash \
-        curl \
-        qpdf \
-        shadow \
-        su-exec \
-        openssl \
-        openssl-dev \
-        openjdk21-jre \
-# Doc conversion
-        libreoffice \
-# pdftohtml
-        poppler-utils \
-# OCR MY PDF (unpaper for descew and other advanced features)
-        tesseract-ocr-data-eng \
-# CV
-        py3-opencv \
-# python3/pip
-        python3 \
-        py3-pip && \
-# uno unoconv and HTML
-    pip install --break-system-packages --no-cache-dir --upgrade unoconv WeasyPrint pdf2image pillow && \
+    ca-certificates \
+    tzdata \
+    tini \
+    bash \
+    curl \
+    qpdf \
+    shadow \
+    su-exec \
+    openssl \
+    openssl-dev \
+    openjdk21-jre \
+    # Doc conversion
+    gcompat \
+    libc6-compat \
+    libreoffice \
+    # pdftohtml
+    poppler-utils \
+    # OCR MY PDF (unpaper for descew and other advanced features)
+    tesseract-ocr-data-eng \
+    # CV
+    py3-opencv \
+    python3 \
+    py3-pip \
+    py3-pillow@testing \
+    py3-pdf2image@testing && \
+    python3 -m venv /opt/venv && \
+    export PATH="/opt/venv/bin:$PATH" && \
+    pip install --upgrade pip && \
+    pip install --no-cache-dir --upgrade unoserver weasyprint && \
+    ln -s /usr/lib/libreoffice/program/uno.py /opt/venv/lib/python3.12/site-packages/ && \
+    ln -s /usr/lib/libreoffice/program/unohelper.py /opt/venv/lib/python3.12/site-packages/ && \
+    ln -s /usr/lib/libreoffice/program /opt/venv/lib/python3.12/site-packages/LibreOffice && \
     mv /usr/share/tessdata /usr/share/tessdata-original && \
     mkdir -p $HOME /configs /logs /customFiles /pipeline/watchedFolders /pipeline/finishedFolders && \
     fc-cache -f -v && \
     chmod +x /scripts/* && \
     chmod +x /scripts/init.sh && \
-# User permissions
+    # User permissions
     addgroup -S stirlingpdfgroup && adduser -S stirlingpdfuser -G stirlingpdfgroup && \
     chown -R stirlingpdfuser:stirlingpdfgroup $HOME /scripts /usr/share/fonts/opentype/noto /configs /customFiles /pipeline && \
     chown stirlingpdfuser:stirlingpdfgroup /app.jar
@@ -76,4 +93,4 @@ EXPOSE 8080/tcp
 
 # Set user and run command
 ENTRYPOINT ["tini", "--", "/scripts/init.sh"]
-CMD ["java", "-Dfile.encoding=UTF-8", "-jar", "/app.jar"]
+CMD ["sh", "-c", "java -Dfile.encoding=UTF-8 -jar /app.jar & /opt/venv/bin/unoserver --port 2003 --interface 0.0.0.0"]

Dockerfile.fat

@@ -1,5 +1,5 @@
 # Build the application
-FROM gradle:8.11-jdk17 AS build
+FROM gradle:8.12-jdk17 AS build
 
 # Set the working directory
 WORKDIR /app
@@ -9,10 +9,11 @@ COPY . .
 
 # Build the application with DOCKER_ENABLE_SECURITY=false
 RUN DOCKER_ENABLE_SECURITY=true \
-./gradlew clean build
+    STIRLING_PDF_DESKTOP_UI=false \
+    ./gradlew clean build
 
 # Main stage
-FROM alpine:3.20.3
+FROM alpine:3.21.3@sha256:a8560b36e8b8210634f77d9f7f9efd7ffa463e380b75e2e74aff4511df3ef88c
 
 # Copy necessary files
 COPY scripts /scripts
@@ -25,58 +26,75 @@ ARG VERSION_TAG
 # Set Environment Variables
 ENV DOCKER_ENABLE_SECURITY=false \
     VERSION_TAG=$VERSION_TAG \
-    JAVA_TOOL_OPTIONS="$JAVA_TOOL_OPTIONS -XX:MaxRAMPercentage=75" \
+    JAVA_TOOL_OPTIONS="-XX:+UnlockExperimentalVMOptions \
+    -XX:MaxRAMPercentage=75 \
+    -XX:InitiatingHeapOccupancyPercent=20 \
+    -XX:+G1PeriodicGCInvokesConcurrent \
+    -XX:G1PeriodicGCInterval=10000 \
+    -XX:+UseStringDeduplication \
+    -XX:G1PeriodicGCSystemLoadThreshold=70" \
     HOME=/home/stirlingpdfuser \
     PUID=1000 \
     PGID=1000 \
     UMASK=022 \
     FAT_DOCKER=true \
-    INSTALL_BOOK_AND_ADVANCED_HTML_OPS=false
+    INSTALL_BOOK_AND_ADVANCED_HTML_OPS=false \
+    PYTHONPATH=/usr/lib/libreoffice/program:/opt/venv/lib/python3.12/site-packages \
+    UNO_PATH=/usr/lib/libreoffice/program \
+    URE_BOOTSTRAP=file:///usr/lib/libreoffice/program/fundamentalrc
 
 
 # JDK for app
-RUN echo "@testing https://dl-cdn.alpinelinux.org/alpine/edge/main" | tee -a /etc/apk/repositories && \
-    echo "@testing https://dl-cdn.alpinelinux.org/alpine/edge/community" | tee -a /etc/apk/repositories && \
+RUN echo "@main https://dl-cdn.alpinelinux.org/alpine/edge/main" | tee -a /etc/apk/repositories && \
+    echo "@community https://dl-cdn.alpinelinux.org/alpine/edge/community" | tee -a /etc/apk/repositories && \
     echo "@testing https://dl-cdn.alpinelinux.org/alpine/edge/testing" | tee -a /etc/apk/repositories && \
     apk upgrade --no-cache -a && \
     apk add --no-cache \
-        ca-certificates \
-        tzdata \
-        tini \
-        bash \
-        curl \
-        shadow \
-        su-exec \
-        openssl \
-        openssl-dev \
-        openjdk21-jre \
-# Doc conversion
-        libreoffice \
-# pdftohtml
-        poppler-utils \
-# OCR MY PDF (unpaper for descew and other advanced featues)
-        qpdf \
-        tesseract-ocr-data-eng \
-        font-terminus font-dejavu font-noto font-noto-cjk font-awesome font-noto-extra \
-# CV
-        py3-opencv \
-# python3/pip
-        python3 \
-    py3-pip && \
-# uno unoconv and HTML
-    pip install --break-system-packages --no-cache-dir --upgrade unoconv WeasyPrint pdf2image pillow && \
+    ca-certificates \
+    tzdata \
+    tini \
+    bash \
+    curl \
+    shadow \
+    su-exec \
+    openssl \
+    openssl-dev \
+    openjdk21-jre \
+    # Doc conversion
+    gcompat \
+    libc6-compat \
+    libreoffice \
+    # pdftohtml
+    poppler-utils \
+    # OCR MY PDF (unpaper for descew and other advanced featues)
+    qpdf \
+    tesseract-ocr-data-eng \
+
+    font-terminus font-dejavu font-noto font-noto-cjk font-awesome font-noto-extra font-liberation font-linux-libertine \
+    # CV
+    py3-opencv \
+    python3 \
+    py3-pip \
+    py3-pillow@testing \
+    py3-pdf2image@testing && \
+    python3 -m venv /opt/venv && \
+    export PATH="/opt/venv/bin:$PATH" && \
+    pip install --upgrade pip && \
+    pip install --no-cache-dir --upgrade unoserver weasyprint && \
+    ln -s /usr/lib/libreoffice/program/uno.py /opt/venv/lib/python3.12/site-packages/ && \
+    ln -s /usr/lib/libreoffice/program/unohelper.py /opt/venv/lib/python3.12/site-packages/ && \
+    ln -s /usr/lib/libreoffice/program /opt/venv/lib/python3.12/site-packages/LibreOffice && \
     mv /usr/share/tessdata /usr/share/tessdata-original && \
     mkdir -p $HOME /configs /logs /customFiles /pipeline/watchedFolders /pipeline/finishedFolders && \
     fc-cache -f -v && \
     chmod +x /scripts/* && \
     chmod +x /scripts/init.sh && \
-# User permissions
+    # User permissions
     addgroup -S stirlingpdfgroup && adduser -S stirlingpdfuser -G stirlingpdfgroup && \
     chown -R stirlingpdfuser:stirlingpdfgroup $HOME /scripts /usr/share/fonts/opentype/noto /configs /customFiles /pipeline && \
     chown stirlingpdfuser:stirlingpdfgroup /app.jar
 
 EXPOSE 8080/tcp
-
 # Set user and run command
 ENTRYPOINT ["tini", "--", "/scripts/init.sh"]
-CMD ["java", "-Dfile.encoding=UTF-8", "-jar", "/app.jar"]
+CMD ["sh", "-c", "java -Dfile.encoding=UTF-8 -jar /app.jar & /opt/venv/bin/unoserver --port 2003 --interface 0.0.0.0"]

Dockerfile.ultra-lite

@@ -1,5 +1,5 @@
 # use alpine
-FROM alpine:3.21.0@sha256:21dc6063fd678b478f57c0e13f47560d0ea4eeba26dfc947b2a4f81f686b9f45
+FROM alpine:3.21.3@sha256:a8560b36e8b8210634f77d9f7f9efd7ffa463e380b75e2e74aff4511df3ef88c
 
 ARG VERSION_TAG
 
@@ -7,7 +7,13 @@ ARG VERSION_TAG
 ENV DOCKER_ENABLE_SECURITY=false \
     HOME=/home/stirlingpdfuser \
     VERSION_TAG=$VERSION_TAG \
-    JAVA_TOOL_OPTIONS="$JAVA_TOOL_OPTIONS -XX:MaxRAMPercentage=75" \
+    JAVA_TOOL_OPTIONS="-XX:+UnlockExperimentalVMOptions \
+    -XX:MaxRAMPercentage=75 \
+    -XX:InitiatingHeapOccupancyPercent=20 \
+    -XX:+G1PeriodicGCInvokesConcurrent \
+    -XX:G1PeriodicGCInterval=10000 \
+    -XX:+UseStringDeduplication \
+    -XX:G1PeriodicGCSystemLoadThreshold=70" \
     PUID=1000 \
     PGID=1000 \
     UMASK=022

Endpoint-groups.md

@@ -1,46 +0,0 @@
-| 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,41 +0,0 @@
-## User Guide for Local Directory Scanning and File Processing
-
-### Setting Up Watched Folders
-
-- Create a folder where you want your files to be monitored. This is your 'watched folder'.
-- The default directory for this is `./pipeline/watchedFolders/`.
-- Place any directories you want to be scanned into this folder. This folder should contain multiple folders, each for their own tasks and pipelines.
-
-### Configuring Processing with JSON Files
-
-- In each directory you want processed (e.g., `./pipeline/watchedFolders/officePrinter`), include a JSON configuration file.
-- This JSON file should specify how you want the files in the directory to be handled (e.g., what operations to perform on them). This can be made, configured, and downloaded from the Stirling-PDF Pipeline interface.
-
-### 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 according to the configuration.
-
-### Processing Steps
-
-- Files in each directory are processed according to the instructions in the JSON file.
-- This might involve file conversions, data filtering, renaming files, etc. If the output of a step is a zip, this zip will be automatically unzipped as it passes to the next process.
-
-### Results and Output
-
-- After processing, the results are saved in a specified output location. This could be a different folder or location as defined in the JSON file or the default location `./pipeline/finishedFolders/`.
-- Each processed file is named and organized according to the rules set in the JSON configuration.
-
-### Completion and Cleanup
-
-- Once processing is complete, the original files in the watched folder's directory are removed.
-- You can find the processed files in the designated output location.
-
-### Error Handling
-
-- If there's an error during processing, the system will not delete the original files, allowing you to check and retry if necessary.
-
-### User Interaction
-
-- As a user, your main tasks are to set up the watched folders, place directories with files for processing, and create the corresponding JSON configuration files.
-- The system handles the rest, including scanning, processing, and outputting results.

HowToAddNewLanguage.md

@@ -11,16 +11,12 @@ Fork Stirling-PDF and create a new branch out of `main`.
 Then add a reference to the language in the navbar by adding a new language entry to the dropdown:
 
 - 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:
 
 ```html
-<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>
+<div th:replace="~{fragments/languageEntry :: languageEntry ('pl_PL', 'Polski')}" ></div>
 ```
 
 The `data-bs-language-code` is the code used to reference the file in the next step.
@@ -60,3 +56,13 @@ ignore = [
 - 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.
+
+### Use this code to perform a local check
+
+#### Windows command
+
+```ps
+python .github/scripts/check_language_properties.py --reference-file src\main\resources\messages_en_GB.properties --branch "" --files src\main\resources\messages_pl_PL.properties
+
+python .github/scripts/check_language_properties.py --reference-file src\main\resources\messages_en_GB.properties --branch "" --check-file src\main\resources\messages_pl_PL.properties
+```

LocalRunGuide.md

@@ -1,327 +0,0 @@
-To run the application without Docker/Podman, you will need to manually install all dependencies and build the necessary components.
-
-Note that some dependencies might not be available in the standard repositories of all Linux distributions, and may require additional steps to install.
-
-The following guide assumes you have a basic understanding of using a command line interface in your operating system.
-
-It should work on most Linux distributions and MacOS. For Windows, you might need to use Windows Subsystem for Linux (WSL) for certain steps. The amount of dependencies is to actually reduce overall size, 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.
-
-### Step 1: Prerequisites
-
-Install the following software, if not already installed:
-
-- Java 17 or later (21 recommended)
-- Gradle 7.0 or later (included within the repo, so not needed on the server)
-- Git
-- Python 3.8 (with pip)
-- Make
-- GCC/G++
-- Automake
-- Autoconf
-- libtool
-- pkg-config
-- zlib1g-dev
-- libleptonica-dev
-
-For Debian-based systems, you can use the following command:
-
-```bash
-sudo apt-get update
-sudo apt-get install -y git automake autoconf libtool libleptonica-dev pkg-config zlib1g-dev make g++ openjdk-21-jdk python3 python3-pip
-```
-
-For Fedora-based systems, use this command:
-
-```bash
-sudo dnf install -y git automake autoconf libtool leptonica-devel pkg-config zlib-devel make gcc-c++ java-21-openjdk python3 python3-pip
-```
-
-For non-root users with Nix Package Manager, use the following command:
-
-```bash
-nix-channel --update
-nix-env -iA nixpkgs.jdk21 nixpkgs.git nixpkgs.python38 nixpkgs.gnumake nixpkgs.libgcc nixpkgs.automake nixpkgs.autoconf nixpkgs.libtool nixpkgs.pkg-config nixpkgs.zlib nixpkgs.leptonica
-```
-
-### Step 2: Clone and Build jbig2enc (Only required for certain OCR functionality)
-
-For Debian and Fedora, you can build it from source using the following commands:
-
-```bash
-mkdir ~/.git
-cd ~/.git && \
-git clone https://github.com/agl/jbig2enc.git && \
-cd jbig2enc && \
-./autogen.sh && \
-./configure && \
-make && \
-sudo make install
-```
-
-For Nix, you will face `Leptonica not detected`. Bypass this by installing it directly using the following command:
-
-```bash
-nix-env -iA nixpkgs.jbig2enc
-```
-
-### Step 3: Install Additional Software
-
-Next, we need to install LibreOffice for conversions, 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
-- 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 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 qpdf
-pip3 install uno opencv-python-headless unoconv pngquant WeasyPrint
-```
-
-For Nix:
-
-```bash
-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 && \
-./gradlew build
-```
-
-### Step 5: Move Jar to Desired Location
-
-After the build process, a `.jar` file will be generated in the `build/libs` directory. You can move this file to a desired location, for example, `/opt/Stirling-PDF/`. You must also move the Script folder within the Stirling-PDF repo that you have downloaded to this directory. This folder is required for the Python scripts using OpenCV.
-
-```bash
-sudo mkdir /opt/Stirling-PDF && \
-sudo mv ./build/libs/Stirling-PDF-*.jar /opt/Stirling-PDF/ && \
-sudo mv scripts /opt/Stirling-PDF/ && \
-echo "Scripts installed."
-```
-
-For non-root users, you can just keep the jar in the main directory of Stirling-PDF using the following command:
-
-```bash
-mv ./build/libs/Stirling-PDF-*.jar ./Stirling-PDF-*.jar
-```
-
-### Step 6: Other Files
-
-#### OCR
-
-If you plan to use the OCR (Optical Character Recognition) functionality, you might need to install language packs for Tesseract if running non-English scanning.
-
-##### Installing Language Packs
-
-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`
-
-**IMPORTANT:** DO NOT REMOVE EXISTING `eng.traineddata`, IT'S REQUIRED.
-
-**Debian-based systems**, install languages with this command:
-
-```bash
-sudo apt update && \
-# All languages
-# sudo apt install -y 'tesseract-ocr-*'
-
-# Find languages:
-apt search tesseract-ocr-
-
-# View installed languages:
-dpkg-query -W tesseract-ocr- | sed 's/tesseract-ocr-//g'
-```
-
-**Fedora:**
-
-```bash
-# All languages
-# sudo dnf install -y tesseract-langpack-*
-
-# Find languages:
-dnf search -C tesseract-langpack-
-
-# View installed languages:
-rpm -qa | grep tesseract-langpack | sed 's/tesseract-langpack-//g'
-```
-
-**Nix:**
-
-```bash
-nix-env -iA nixpkgs.tesseract
-```
-
-**Note:** Nix Package Manager pre-installs almost all the language packs when Tesseract is installed.
-
-### Step 7: Run Stirling-PDF
-
-Those who have pushed to the root directory, run the following commands:
-
-```bash
-./gradlew bootRun
-or
-java -jar /opt/Stirling-PDF/Stirling-PDF-*.jar
-```
-
-Since LibreOffice, soffice, and conversion tools have their dbus_tmp_dir set as `dbus_tmp_dir="/run/user/$(id -u)/libreoffice-dbus"`, you might get the following error when using their endpoints:
-
-```
-[Thread-7] INFO  s.s.SPDF.utils.ProcessExecutor - mkdir: cannot create directory ‘/run/user/1501’: Permission denied
-```
-
-To resolve this, before starting Stirling-PDF, you have to set the environment variable to a directory you have write access to by using the following commands:
-
-```bash
-mkdir temp
-export DBUS_SESSION_BUS_ADDRESS="unix:path=./temp"
-./gradlew bootRun
-or
-java -jar ./Stirling-PDF-*.jar
-```
-
-### Step 8: Adding a Desktop Icon
-
-This will add a modified app starter to your app menu.
-
-```bash
-location=$(pwd)/gradlew
-image=$(pwd)/docs/stirling-transparent.svg
-
-cat > ~/.local/share/applications/Stirling-PDF.desktop <<EOF
-[Desktop Entry]
-Name=Stirling PDF;
-GenericName=Launch StirlingPDF and open its WebGUI;
-Category=Office;
-Exec=xdg-open http://localhost:8080 && nohup $location bootRun &;
-Icon=$image;
-Keywords=pdf;
-Type=Application;
-NoDisplay=false;
-Terminal=true;
-EOF
-```
-
-Note: Currently, the app will run in the background until it is manually closed.
-
-### Optional: Changing the Host and Port of the Application
-
-To override the default configuration, you can add the following to `/.git/Stirling-PDF/configs/custom_settings.yml` file:
-
-```yaml
-server:
-  host: 0.0.0.0 # Not working - use instead address
-  address: 0.0.0.0
-  port: 3000
-```
-
-`-Djava.net.preferIPv4Stack=true` --> To force IPv4 only in the Java starting command
-
-**Note:** This file is created after the first application launch. To have it before that, you can create the directory and add the file yourself.
-
-### Optional: Run Stirling-PDF as a Service (requires root)
-
-First, create a `.env` file, where you can store environment variables:
-
-```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 the nano editor:
-
-```bash
-nano /etc/systemd/system/stirlingpdf.service
-```
-
-Paste this content, and 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
-
-[Service]
-SuccessExitStatus=143
-
-User=root
-Group=root
-
-Type=simple
-
-EnvironmentFile=/opt/Stirling-PDF/.env
-WorkingDirectory=/opt/Stirling-PDF
-ExecStart=/usr/bin/java -jar Stirling-PDF-0.17.2.jar
-ExecStop=/bin/kill -15 $MAINPID
-
-[Install]
-WantedBy=multi-user.target
-```
-
-Notify systemd that it has to rebuild its internal service database (you have to run this command every time you make a change in the service file):
-
-```bash
-sudo systemctl daemon-reload
-```
-
-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
-```
-
----
-
-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 the Java `-jar` command:
-
-```bash
-export APP_HOME_NAME="Stirling PDF"
-or
--DAPP_HOME_NAME="Stirling PDF"

PipelineFeature.md

@@ -1,42 +0,0 @@
-# Pipeline Configuration and Usage Tutorial
-
-- Configure the pipeline config file and input files to run files against it.
-- For reuse, download the config file and re-upload it when needed, or place it in `/pipeline/defaultWebUIConfigs/` to auto-load in the web UI for all users.
-
-## Steps to Configure and Use Your Pipeline
-
-1. **Access Configuration**
-   - Upon entering the screen, click on the **Configure** button.
-
-2. **Enter Pipeline Name**
-   - Provide a name for your pipeline in the designated field.
-
-3. **Select Operations**
-   - Choose the operations for your pipeline (e.g., **Split Pages**), then click **Add Operation**.
-
-4. **Configure Operation Settings**
-   - Input the necessary settings for each added operation. Settings are highlighted in yellow if customization is needed.
-
-5. **Add More Operations**
-   - You can add and adjust the order of multiple operations. Ensure each operation's settings are customized.
-
-6. **Save Settings**
-   - Click **Save Operation Settings** after customizing settings for each operation.
-
-7. **Validate Pipeline**
-   - Use the **Validation** button to check your pipeline. A green indicator signifies correct setup; a pop-out error indicates issues.
-
-8. **Download Pipeline Configuration**
-   - To use the configuration for folder scanning (or save it for future use and 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**.
-
-10. **Note on Web UI Limitations**
-    - The current web UI version does not support operations that require multiple different types of inputs, such as adding a separate image to a PDF.
-
-### Current Limitations
-
-- Cannot have more than one of the same operation.
-- Cannot input additional files via UI.
-- All files and operations run in serial mode.

README.md

@@ -3,7 +3,7 @@
 
 [![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/HYmhKj45pU)
-[![Docker Image Version (tag latest semver)](https://img.shields.io/docker/v/frooodle/s-pdf/latest)](https://github.com/Stirling-Tools/Stirling-PDF/)
+[![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/Stirling-Tools/Stirling-PDF/badge)](https://scorecard.dev/viewer/?uri=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)
 
 <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>
@@ -13,18 +13,23 @@
 
 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.
 
+Homepage: [https://stirlingpdf.com](https://stirlingpdf.com)
+
+All documentation available at [https://docs.stirlingpdf.com/](https://docs.stirlingpdf.com/)
+
 ![stirling-home](images/stirling-home.jpg)
 
 ## Features
 
-- Enterprise features like SSO Check [here](https://docs.stirlingpdf.com/Enterprise%20Edition)
+- 50+ PDF Operations
+- Parallel file processing and downloads
 - Dark mode support
 - Custom download options
-- Parallel file processing and downloads
-- Custom 'Pipelines' to run multiple features in a queue
+- Custom 'Pipelines' to run multiple features in a automated 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)
+- Optional Login and Authentication support (see [here](https://docs.stirlingpdf.com/Advanced%20Configuration/System%20and%20Security) for documentation)
+- Database Backup and Import (see [here](https://docs.stirlingpdf.com/Advanced%20Configuration/DATABASE) for documentation)
+- Enterprise features like SSO see [here](https://docs.stirlingpdf.com/Enterprise%20Edition)
 
 ## PDF Features
 
@@ -90,334 +95,80 @@ All files and PDFs exist either exclusively on the client side, reside in server
 - Get all information on a PDF to view or export as JSON
 - Show/detect embedded JavaScript
 
-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).
 
-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
-- [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)
+# 📖 Get Started
 
-## How to Use
+Visit our comprehensive documentation at [docs.stirlingpdf.com](https://docs.stirlingpdf.com) for:
 
-### Windows
+- Installation guides for all platforms
+- Configuration options
+- Feature documentation
+- API reference
+- Security setup
+- Enterprise features
 
-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 the [LocalRunGuide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/LocalRunGuide.md).
-
-### Docker / Podman
-
-> [!NOTE]
-> <https://hub.docker.com/r/stirlingtools/stirling-pdf>
-
-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 who don't mind space optimization, just use the latest tag.
-
-![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
-
-```bash
-docker run -d \
-  -p 8080:8080 \
-  -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 \
-  stirlingtools/stirling-pdf:latest
-```
-
-### Docker Compose
-
-```yaml
-version: '3.3'
-services:
-  stirling-pdf:
-    image: stirlingtools/stirling-pdf:latest
-    ports:
-      - '8080:8080'
-    volumes:
-      - ./trainingData:/usr/share/tessdata # Required for extra OCR languages
-      - ./extraConfigs:/configs
-#      - ./customFiles:/customFiles/
-#      - ./logs:/logs/
-    environment:
-      - DOCKER_ENABLE_SECURITY=false
-      - INSTALL_BOOK_AND_ADVANCED_HTML_OPS=false
-      - LANGS=en_GB
-```
-
-Note: Podman is CLI-compatible with Docker, so simply replace "docker" with "podman".
-
-### Kubernetes
-
-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 here will be accessible 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 languages!
+Stirling-PDF currently supports 39 languages!
 
 | Language                                     | Progress                               |
 | -------------------------------------------- | -------------------------------------- |
-| Arabic (العربية) (ar_AR)                        | ![94%](https://geps.dev/progress/94)   |
-| Azerbaijani (Azərbaycan Dili) (az_AZ)        | ![92%](https://geps.dev/progress/92)   |
-| Basque (Euskara) (eu_ES)                     | ![53%](https://geps.dev/progress/53)   |
-| Bulgarian (Български) (bg_BG)                | ![89%](https://geps.dev/progress/89)   |
-| Catalan (Català) (ca_CA)                     | ![84%](https://geps.dev/progress/84)   |
-| Croatian (Hrvatski) (hr_HR)                  | ![91%](https://geps.dev/progress/91)   |
-| Czech (Česky) (cs_CZ)                        | ![90%](https://geps.dev/progress/90)   |
-| Danish (Dansk) (da_DK)                       | ![89%](https://geps.dev/progress/89)   |
-| Dutch (Nederlands) (nl_NL)                   | ![89%](https://geps.dev/progress/89)   |
+| Arabic (العربية) (ar_AR)                        | ![89%](https://geps.dev/progress/89)   |
+| Azerbaijani (Azərbaycan Dili) (az_AZ)        | ![88%](https://geps.dev/progress/88)   |
+| Basque (Euskara) (eu_ES)                     | ![51%](https://geps.dev/progress/51)   |
+| Bulgarian (Български) (bg_BG)                | ![99%](https://geps.dev/progress/99)   |
+| Catalan (Català) (ca_CA)                     | ![80%](https://geps.dev/progress/80)   |
+| Croatian (Hrvatski) (hr_HR)                  | ![86%](https://geps.dev/progress/86)   |
+| Czech (Česky) (cs_CZ)                        | ![97%](https://geps.dev/progress/97)   |
+| Danish (Dansk) (da_DK)                       | ![85%](https://geps.dev/progress/85)   |
+| Dutch (Nederlands) (nl_NL)                   | ![85%](https://geps.dev/progress/85)   |
 | 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)                    | ![92%](https://geps.dev/progress/92)   |
-| German (Deutsch) (de_DE)                     | ![100%](https://geps.dev/progress/100)   |
-| Greek (Ελληνικά) (el_GR)                     | ![90%](https://geps.dev/progress/90)   |
-| Hindi (हिंदी) (hi_IN)                          | ![88%](https://geps.dev/progress/88)   |
-| Hungarian (Magyar) (hu_HU)                   | ![91%](https://geps.dev/progress/91)   |
-| Indonesian (Bahasa Indonesia) (id_ID)        | ![90%](https://geps.dev/progress/90)   |
-| Irish (Gaeilge) (ga_IE)                      | ![82%](https://geps.dev/progress/82)   |
+| French (Français) (fr_FR)                    | ![96%](https://geps.dev/progress/96)   |
+| German (Deutsch) (de_DE)                     | ![99%](https://geps.dev/progress/99)   |
+| Greek (Ελληνικά) (el_GR)                     | ![97%](https://geps.dev/progress/97)   |
+| Hindi (हिंदी) (hi_IN)                          | ![98%](https://geps.dev/progress/98)   |
+| Hungarian (Magyar) (hu_HU)                   | ![95%](https://geps.dev/progress/95)   |
+| Indonesian (Bahasa Indonesia) (id_ID)        | ![86%](https://geps.dev/progress/86)   |
+| Irish (Gaeilge) (ga_IE)                      | ![98%](https://geps.dev/progress/98)   |
 | Italian (Italiano) (it_IT)                   | ![99%](https://geps.dev/progress/99)   |
-| Japanese (日本語) (ja_JP)                    | ![93%](https://geps.dev/progress/93)   |
-| Korean (한국어) (ko_KR)                      | ![89%](https://geps.dev/progress/89)   |
-| Norwegian (Norsk) (no_NB)                    | ![82%](https://geps.dev/progress/82)   |
-| Persian (فارسی) (fa_IR)                      | ![99%](https://geps.dev/progress/99)   |
-| Polish (Polski) (pl_PL)                      | ![90%](https://geps.dev/progress/90)   |
-| Portuguese (Português) (pt_PT)               | ![90%](https://geps.dev/progress/90)   |
+| Japanese (日本語) (ja_JP)                    | ![92%](https://geps.dev/progress/92)   |
+| Korean (한국어) (ko_KR)                      | ![98%](https://geps.dev/progress/98)   |
+| Norwegian (Norsk) (no_NB)                    | ![78%](https://geps.dev/progress/78)   |
+| Persian (فارسی) (fa_IR)                      | ![94%](https://geps.dev/progress/94)   |
+| Polish (Polski) (pl_PL)                      | ![85%](https://geps.dev/progress/85)   |
+| Portuguese (Português) (pt_PT)               | ![97%](https://geps.dev/progress/97)   |
 | Portuguese Brazilian (Português) (pt_BR)     | ![98%](https://geps.dev/progress/98)   |
-| Romanian (Română) (ro_RO)                    | ![84%](https://geps.dev/progress/84)   |
-| Russian (Русский) (ru_RU)                    | ![90%](https://geps.dev/progress/90)   |
-| Serbian Latin alphabet (Srpski) (sr_LATN_RS) | ![67%](https://geps.dev/progress/67)   |
-| Simplified Chinese (简体中文) (zh_CN)         | ![93%](https://geps.dev/progress/93)   |
-| Slovakian (Slovensky) (sk_SK)                | ![78%](https://geps.dev/progress/78)   |
-| Spanish (Español) (es_ES)                    | ![91%](https://geps.dev/progress/91)   |
-| Swedish (Svenska) (sv_SE)                    | ![90%](https://geps.dev/progress/90)   |
-| Thai (ไทย) (th_TH)                           | ![90%](https://geps.dev/progress/90)   |
+| Romanian (Română) (ro_RO)                    | ![80%](https://geps.dev/progress/80)   |
+| Russian (Русский) (ru_RU)                    | ![97%](https://geps.dev/progress/97)   |
+| Serbian Latin alphabet (Srpski) (sr_LATN_RS) | ![63%](https://geps.dev/progress/63)   |
+| Simplified Chinese (简体中文) (zh_CN)         | ![99%](https://geps.dev/progress/99)   |
+| Slovakian (Slovensky) (sk_SK)                | ![74%](https://geps.dev/progress/74)   |
+| Slovenian (Slovenščina) (sl_SI)              | ![96%](https://geps.dev/progress/96)   |
+| Spanish (Español) (es_ES)                    | ![98%](https://geps.dev/progress/98)   |
+| Swedish (Svenska) (sv_SE)                    | ![92%](https://geps.dev/progress/92)   |
+| Thai (ไทย) (th_TH)                           | ![85%](https://geps.dev/progress/85)   |
+| Tibetan (བོད་ཡིག་) (zh_BO)                     | ![94%](https://geps.dev/progress/94) |
 | Traditional Chinese (繁體中文) (zh_TW)        | ![99%](https://geps.dev/progress/99)   |
-| Turkish (Türkçe) (tr_TR)                     | ![86%](https://geps.dev/progress/86)   |
-| Ukrainian (Українська) (uk_UA)               | ![76%](https://geps.dev/progress/76)   |
-| Vietnamese (Tiếng Việt) (vi_VN)              | ![83%](https://geps.dev/progress/83)   |
+| Turkish (Türkçe) (tr_TR)                     | ![82%](https://geps.dev/progress/82)   |
+| Ukrainian (Українська) (uk_UA)               | ![72%](https://geps.dev/progress/72)   |
+| Vietnamese (Tiếng Việt) (vi_VN)              | ![79%](https://geps.dev/progress/79)   |
 
-## Contributing (Creating Issues, Translations, Fixing Bugs, etc.)
-
-Please see our [Contributing Guide](CONTRIBUTING.md).
 
 ## Stirling PDF Enterprise
 
-Stirling PDF offers an Enterprise edition of its software. This is the same great software but with added features and comforts.
+Stirling PDF offers an Enterprise edition of its software. This is the same great software but with added features, support and comforts.
+Check out our [Enterprise docs](https://docs.stirlingpdf.com/Enterprise%20Edition)
 
-### What's included
 
-- Prioritized 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 the 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
+## 🤝 Looking to contribute?
 
-Check out our [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)
-
-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.
-
-For example, in `settings.yml`, you might have:
-
-```yaml
-security:
-  enableLogin: 'true'
-```
-
-To have this via an environment variable, you would use `SECURITY_ENABLELOGIN`.
-
-The current list of settings is:
-
-```yaml
-security:
-  enableLogin: false # set to 'true' to enable login
-  csrfDisabled: true # set to 'true' to disable CSRF protection (not recommended for production)
-  loginAttemptCount: 5 # lock user account after 5 tries; when using e.g. Fail2Ban you can deactivate the function with -1
-  loginResetTimeMinutes: 120 # lock account for 2 hours after x attempts
-  loginMethod: all # 'all' (Login Username/Password and OAuth2[must be enabled and configured]), 'normal'(only Login with Username/Password) or 'oauth2'(only Login with OAuth2)
-  initialLogin:
-    username: '' # initial username for the first login
-    password: '' # initial password for the first login
-  oauth2:
-    enabled: false # set to 'true' to enable login (Note: enableLogin must also be 'true' for this to work)
-    client:
-      keycloak:
-        issuer: '' # URL of the Keycloak realm's OpenID Connect Discovery endpoint
-        clientId: '' # client ID for Keycloak OAuth2
-        clientSecret: '' # client secret for Keycloak OAuth2
-        scopes: openid, profile, email # scopes for Keycloak OAuth2
-        useAsUsername: preferred_username # field to use as the username for Keycloak OAuth2
-      google:
-        clientId: '' # client ID for Google OAuth2
-        clientSecret: '' # client secret for Google OAuth2
-        scopes: https://www.googleapis.com/auth/userinfo.email, https://www.googleapis.com/auth/userinfo.profile # scopes for Google OAuth2
-        useAsUsername: email # field to use as the username for Google OAuth2
-      github:
-        clientId: '' # client ID for GitHub OAuth2
-        clientSecret: '' # client secret for GitHub OAuth2
-        scopes: read:user # scope for GitHub OAuth2
-        useAsUsername: login # field to use as the username for GitHub OAuth2
-    issuer: '' # set to any provider that supports OpenID Connect Discovery (/.well-known/openid-configuration) 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'
-  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)
-  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: 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 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'])
-
-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` 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_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-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
-
-![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 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.
-
-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 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 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.
-
-## 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)
-- 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? Why am I getting HTTP error 413?
-
-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?
-
-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;`.
+Join our community:
+- [Contribution Guidelines](CONTRIBUTING.md)
+- [Translation Guide (How to add custom languages)](HowToAddNewLanguage.md)
+- [Issue Tracker](https://github.com/Stirling-Tools/Stirling-PDF/issues)
+- [Discord Community](https://discord.gg/HYmhKj45pU)
+- [Developer Guide](DeveloperGuide.md)

USERS.md

@@ -0,0 +1,45 @@
+# Who is using Stirling-PDF?
+
+Understanding the diverse applications of Stirling-PDF can be an invaluable resource for collaboration and learning. This page provides a directory of users and use cases. If you are using Stirling-PDF, consider sharing your experiences to help others and foster a community of best practices.
+
+## Adding Yourself as a User
+
+If you're using Stirling-PDF or have integrated it into your platform or workflow, please consider contributing to this list by describing your use case. You can do this by opening a pull request to this file and adding your details in the format below:
+
+- **N**: Name of the organization or individual.
+- **D**: A brief description of your usage.
+- **U**: Specific features or capabilities utilized.
+- **L**: Optional link for further information (e.g., website, blog post).
+- **Q**: Contact information for sharing insights (optional).
+
+Example entry:
+
+```
+* N: Example Corp
+  D: Using Stirling-PDF for automated document processing in our SaaS platform focusing on compression.
+  U: OCR, merging PDFs, metadata editing, encryption, compression.
+  L: https://example.com/stirling-pdf
+  Q: @example-user on Discord/email
+```
+
+---
+
+## Requirements for Listing
+
+- You must represent the entity you're listing and ensure the details are accurate.
+- Trial deployments are welcome if they represent a realistic evaluation of Stirling-PDF in action.
+- Community contributions, including home-lab setups or non-commercial uses, are encouraged.
+
+---
+
+## Users (Alphabetically)
+
+    * N: 
+      D: 
+      U: 
+      L: 
+
+    * N: 
+      D: 
+      U: 
+      L: 

Version-groups.md

@@ -1,68 +0,0 @@
-All versions in a Docker environment can download Calibre as a optional extra at runtime to support `book-to-pdf` and `pdf-to-book` using parameter ``INSTALL_BOOK_AND_ADVANCED_HTML_OPS``.
-The 'Fat' container contains all those found in 'Full' with security jar along with this Calibre install.
-
-| Technology | Ultra-Lite | Full  |
-| ---------- | :--------: | :---: |
-| Java       | ✔️          |   ✔️   |
-| JavaScript | ✔️          |   ✔️   |
-| Libre      |            |   ✔️   |
-| Python     |            |   ✔️   |
-| OpenCV     |            |   ✔️   |
-| qpdf       |            |   ✔️   |
-
-| Operation              | Ultra-Lite | Full |
-| ---------------------- | ---------- | ---- |
-| add-page-numbers       | ✔️          | ✔️    |
-| add-password           | ✔️          | ✔️    |
-| add-image              | ✔️          | ✔️    |
-| add-watermark          | ✔️          | ✔️    |
-| adjust-contrast        | ✔️          | ✔️    |
-| auto-split-pdf         | ✔️          | ✔️    |
-| auto-redact            | ✔️          | ✔️    |
-| auto-rename            | ✔️          | ✔️    |
-| cert-sign              | ✔️          | ✔️    |
-| remove-cert-sign       | ✔️          | ✔️    |
-| crop                   | ✔️          | ✔️    |
-| change-metadata        | ✔️          | ✔️    |
-| change-permissions     | ✔️          | ✔️    |
-| compare                | ✔️          | ✔️    |
-| extract-page           | ✔️          | ✔️    |
-| extract-images         | ✔️          | ✔️    |
-| flatten                | ✔️          | ✔️    |
-| get-info-on-pdf        | ✔️          | ✔️    |
-| img-to-pdf             | ✔️          | ✔️    |
-| markdown-to-pdf        | ✔️          | ✔️    |
-| merge-pdfs             | ✔️          | ✔️    |
-| multi-page-layout      | ✔️          | ✔️    |
-| overlay-pdf            | ✔️          | ✔️    |
-| pdf-organizer          | ✔️          | ✔️    |
-| pdf-to-csv             | ✔️          | ✔️    |
-| pdf-to-img             | ✔️          | ✔️    |
-| pdf-to-single-page     | ✔️          | ✔️    |
-| remove-pages           | ✔️          | ✔️    |
-| remove-password        | ✔️          | ✔️    |
-| rotate-pdf             | ✔️          | ✔️    |
-| sanitize-pdf           | ✔️          | ✔️    |
-| scale-pages            | ✔️          | ✔️    |
-| sign                   | ✔️          | ✔️    |
-| show-javascript        | ✔️          | ✔️    |
-| split-by-size-or-count | ✔️          | ✔️    |
-| split-pdf-by-sections  | ✔️          | ✔️    |
-| split-pdfs             | ✔️          | ✔️    |
-| compress-pdf           |            | ✔️    |
-| extract-image-scans    |            | ✔️    |
-| ocr-pdf                |            | ✔️    |
-| pdf-to-pdfa            |            | ✔️    |
-| remove-blanks          |            | ✔️    |
-| 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                 |            | ✔️    |

allowed-licenses.json

@@ -0,0 +1,164 @@
+{
+  "allowedLicenses": [
+    {
+      "moduleName": ".*",
+      "moduleLicense": "BSD License"
+    },
+    {
+      "moduleName": ".*",
+      "moduleLicense": "The BSD License"
+    },
+    {
+      "moduleName": ".*",
+      "moduleLicense": "BSD-2-Clause"
+    },
+    {
+      "moduleName": ".*",
+      "moduleLicense": "BSD 2-Clause License"
+    },
+    {
+      "moduleName": ".*",
+      "moduleLicense": "The 2-Clause BSD License"
+    },
+    {
+      "moduleName": ".*",
+      "moduleLicense": "BSD-3-Clause"
+    },
+    {
+      "moduleName": ".*",
+      "moduleLicense": "The BSD 3-Clause License (BSD3)"
+    },
+    {
+      "moduleName": ".*",
+      "moduleLicense": "BSD-4 License"
+    },
+    {
+      "moduleName": ".*",
+      "moduleLicense": "MIT"
+    },
+    {
+      "moduleName": ".*",
+      "moduleLicense": "MIT License"
+    },
+    {
+      "moduleName": ".*",
+      "moduleLicense": "The MIT License"
+    },
+    {
+      "moduleName": "com.github.jai-imageio:jai-imageio-core",
+      "moduleLicense": "LICENSE.txt"
+    },
+    {
+      "moduleName": "com.github.jai-imageio:jai-imageio-jpeg2000",
+      "moduleLicense": "LICENSE-JJ2000.txt, LICENSE-Sun.txt"
+    },
+    {
+      "moduleName": ".*",
+      "moduleLicense": "Apache 2"
+    },
+    {
+      "moduleName": ".*",
+      "moduleLicense": "Apache 2.0"
+    },
+    {
+      "moduleName": ".*",
+      "moduleLicense": "Apache-2.0"
+    },
+    {
+      "moduleName": ".*",
+      "moduleLicense": "Apache-2.0 License"
+    },
+    {
+      "moduleName": ".*",
+      "moduleLicense": "Apache License 2.0"
+    },
+    {
+      "moduleName": ".*",
+      "moduleLicense": "Apache License Version 2.0"
+    },
+    {
+      "moduleName": ".*",
+      "moduleLicense": "Apache License, Version 2.0"
+    },
+    {
+      "moduleName": ".*",
+      "moduleLicense": "The Apache License, Version 2.0"
+    },
+    {
+      "moduleName": ".*",
+      "moduleLicense": "The Apache Software License, Version 2.0"
+    },
+    {
+      "moduleName": "com.nimbusds:oauth2-oidc-sdk",
+      "moduleLicense": "\"Apache License, version 2.0\";link=\"https://www.apache.org/licenses/LICENSE-2.0.html\""
+    },
+    {
+      "moduleName": ".*",
+      "moduleLicense": "MPL 2.0"
+    },
+    {
+      "moduleName": ".*",
+      "moduleLicense": "UnboundID SCIM2 SDK Free Use License"
+    },
+    {
+      "moduleName": ".*",
+      "moduleLicense": "GPL2 w/ CPE"
+    },
+    {
+      "moduleName": ".*",
+      "moduleLicense": "GPLv2+CE"
+    },
+    {
+      "moduleName": ".*",
+      "moduleLicense": "GNU GENERAL PUBLIC LICENSE, Version 2 + Classpath Exception"
+    },
+    {
+      "moduleName": "com.martiansoftware:jsap",
+      "moduleLicense": "LGPL"
+    },
+    {
+      "moduleName": "org.hibernate.orm:hibernate-core",
+      "moduleLicense": "GNU Library General Public License v2.1 or later"
+    },
+    {
+      "moduleName": ".*",
+      "moduleLicense": "COMMON DEVELOPMENT AND DISTRIBUTION LICENSE (CDDL) Version 1.0"
+    },
+    {
+      "moduleName": ".*",
+      "moduleLicense": "Eclipse Public License - v 1.0"
+    },
+    {
+      "moduleName": ".*",
+      "moduleLicense": "Eclipse Public License v. 2.0"
+    },
+    {
+      "moduleName": ".*",
+      "moduleLicense": "Eclipse Public License - v 2.0"
+    },
+    {
+      "moduleName": ".*",
+      "moduleLicense": "Eclipse Public License - Version 2.0"
+    },
+    {
+      "moduleName": ".*",
+      "moduleLicense": "Eclipse Public License, Version 2.0"
+    },
+    {
+      "moduleName": ".*",
+      "moduleLicense": "Ubuntu Font Licence 1.0"
+    },
+    {
+      "moduleName": ".*",
+      "moduleLicense": "Bouncy Castle Licence"
+    },
+    {
+      "moduleName": ".*",
+      "moduleLicense": "Public Domain, per Creative Commons CC0"
+    },
+    {
+      "moduleName": ".*",
+      "moduleLicense": "The W3C License"
+    }
+  ]
+}

build.gradle

@@ -1,34 +1,31 @@
 plugins {
     id "java"
-    id "org.springframework.boot" version "3.4.1"
+    id "org.springframework.boot" version "3.4.3"
     id "io.spring.dependency-management" version "1.1.7"
     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.diffplug.spotless" version "7.0.2"
     id "com.github.jk1.dependency-license-report" version "2.9"
-	//id "nebula.lint" version "19.0.3"
-	id("org.panteleyev.jpackageplugin") version "1.6.0"
+    //id "nebula.lint" version "19.0.3"
+    id("org.panteleyev.jpackageplugin") version "1.6.1"
+    id "org.sonarqube" version "6.0.1.5171"
 }
 
-
-
 import com.github.jk1.license.render.*
 
 ext {
-    springBootVersion = "3.4.1"
-    pdfboxVersion = "3.0.3"
-    logbackVersion = "1.5.7"
+    springBootVersion = "3.4.3"
+    pdfboxVersion = "3.0.4"
     imageioVersion = "3.12.0"
     lombokVersion = "1.18.36"
-    bouncycastleVersion = "1.79"
-    springSecuritySamlVersion = "6.4.2"
+    bouncycastleVersion = "1.80"
+    springSecuritySamlVersion = "6.4.3"
     openSamlVersion = "4.3.2"
 }
 
 group = "stirling.software"
-version = "0.36.5"
-
+version = "0.43.1"
 
 java {
     // 17 is lowest but we support and recommend 21
@@ -37,14 +34,13 @@ java {
 
 repositories {
     mavenCentral()
-    maven { url "https://jitpack.io" }
-    maven { url "https://build.shibboleth.net/maven/releases" }
-    maven { url "https://maven.pkg.github.com/jcefmaven/jcefmaven" }
-
+    maven { url = "https://build.shibboleth.net/maven/releases" }
+    maven { url = "https://maven.pkg.github.com/jcefmaven/jcefmaven" }
 }
 
 licenseReport {
     renderers = [new JsonReportRenderer()]
+    allowedLicensesFile = new File("$projectDir/allowed-licenses.json")
 }
 
 sourceSets {
@@ -52,13 +48,15 @@ sourceSets {
         java {
             if (System.getenv("DOCKER_ENABLE_SECURITY") == "false") {
                 exclude "stirling/software/SPDF/config/security/**"
-                exclude "stirling/software/SPDF/controller/api/UserController.java"
                 exclude "stirling/software/SPDF/controller/api/DatabaseController.java"
+                exclude "stirling/software/SPDF/controller/api/UserController.java"
+                exclude "stirling/software/SPDF/controller/api/H2SQLCondition.java"
                 exclude "stirling/software/SPDF/controller/web/AccountWebController.java"
                 exclude "stirling/software/SPDF/controller/web/DatabaseWebController.java"
                 exclude "stirling/software/SPDF/model/ApiKeyAuthenticationToken.java"
                 exclude "stirling/software/SPDF/model/AttemptCounter.java"
                 exclude "stirling/software/SPDF/model/Authority.java"
+                exclude "stirling/software/SPDF/model/BackupNotFoundException.java"
                 exclude "stirling/software/SPDF/model/PersistentLogin.java"
                 exclude "stirling/software/SPDF/model/SessionEntity.java"
                 exclude "stirling/software/SPDF/model/User.java"
@@ -66,10 +64,32 @@ sourceSets {
             }
 
             if (System.getenv("STIRLING_PDF_DESKTOP_UI") == "false") {
-            	exclude "stirling/software/SPDF/UI/impl/**"
+                exclude "stirling/software/SPDF/UI/impl/**"
             }
 
+        }
+    }
 
+    test {
+        java {
+            if (System.getenv("DOCKER_ENABLE_SECURITY") == "false") {
+                exclude "stirling/software/SPDF/config/security/**"
+                exclude "stirling/software/SPDF/controller/api/UserControllerTest.java"
+                exclude "stirling/software/SPDF/controller/api/DatabaseControllerTest.java"
+                exclude "stirling/software/SPDF/controller/web/AccountWebControllerTest.java"
+                exclude "stirling/software/SPDF/controller/web/DatabaseWebControllerTest.java"
+                exclude "stirling/software/SPDF/model/ApiKeyAuthenticationTokenTest.java"
+                exclude "stirling/software/SPDF/model/AttemptCounterTest.java"
+                exclude "stirling/software/SPDF/model/AuthorityTest.java"
+                exclude "stirling/software/SPDF/model/PersistentLoginTest.java"
+                exclude "stirling/software/SPDF/model/SessionEntityTest.java"
+                exclude "stirling/software/SPDF/model/UserTest.java"
+                exclude "stirling/software/SPDF/repository/**"
+            }
+
+            if (System.getenv("STIRLING_PDF_DESKTOP_UI") == "false") {
+                exclude "stirling/software/SPDF/UI/impl/**"
+            }
         }
     }
 }
@@ -89,18 +109,15 @@ def getMacVersion(String version) {
 
 jpackage {
     input = "build/libs"
-
+    destination = "${projectDir}/build/jpackage"
+    mainJar = "Stirling-PDF-${project.version}.jar"
     appName = "Stirling-PDF"
     appVersion = project.version
     vendor = "Stirling-Software"
-	appDescription = "Stirling PDF - Your Local PDF Editor"
-
-    mainJar = "Stirling-PDF-${project.version}.jar"
-    mainClass = "org.springframework.boot.loader.launch.JarLauncher"
-
+    appDescription = "Stirling PDF - Your Local PDF Editor"
     icon = "src/main/resources/static/favicon.ico"
-
-
+    verbose = true
+//    mainClass = "org.springframework.boot.loader.launch.JarLauncher"
 
     // JVM Options
     javaOptions = [
@@ -108,26 +125,26 @@ jpackage {
         "-DSTIRLING_PDF_DESKTOP_UI=true",
         "-Djava.awt.headless=false",
         "-Dapple.awt.UIElement=true",
-        "--add-opens", "java.base/java.lang=ALL-UNNAMED",
-        "--add-opens", "java.desktop/java.awt.event=ALL-UNNAMED",
-        "--add-opens", "java.desktop/sun.awt=ALL-UNNAMED"
-
+        "--add-opens=java.base/java.lang=ALL-UNNAMED",
+        "--add-opens=java.desktop/java.awt.event=ALL-UNNAMED",
+        "--add-opens=java.desktop/sun.awt=ALL-UNNAMED",
+        "--add-opens=java.desktop/sun.awt.X11=ALL-UNNAMED",
+        "--add-opens=java.desktop/sun.awt.windows=ALL-UNNAMED",
+        "--add-opens=java.desktop/sun.lwawt=ALL-UNNAMED",
+        "--add-opens=java.desktop/sun.lwawt.macosx=ALL-UNNAMED",
     ]
 
-
-    verbose = true
-
-    destination = "${projectDir}/build/jpackage"
-
     // Windows-specific configuration
     windows {
-    	launcherAsService = false
-    	appVersion = project.version
+        launcherAsService = false
+        appVersion = project.version
+
         winConsole = false
-        winDirChooser = true
-        winMenu = true
-        winShortcut = true
-        winPerUserInstall = true
+        winMenu = true  // Creates start menu entry
+        winShortcut = true  // Creates desktop shortcut
+        winShortcutPrompt = true  // Lets user choose whether to create shortcuts
+        winDirChooser = true  // Allows users to choose installation directory
+        winPerUserInstall = false
         winMenuGroup = "Stirling Software"
         winUpgradeUuid = "2a43ed0c-b8c2-40cf-89e1-751129b87641" // Unique identifier for updates
         winHelpUrl = "https://github.com/Stirling-Tools/Stirling-PDF"
@@ -138,7 +155,7 @@ jpackage {
 
     // macOS-specific configuration
     mac {
-    	appVersion = getMacVersion(project.version.toString())
+        appVersion = getMacVersion(project.version.toString())
         icon = "src/main/resources/static/favicon.icns"
         type = "dmg"
         macPackageIdentifier = "com.stirling.software.pdf"
@@ -162,7 +179,7 @@ jpackage {
 
     // Linux-specific configuration
     linux {
-    	appVersion = project.version
+        appVersion = project.version
         icon = "src/main/resources/static/favicon.png"
         type = "deb" // Can also use "rpm" for Red Hat-based systems
 
@@ -210,9 +227,9 @@ launch4j {
     outfile="Stirling-PDF.exe"
 
     if(System.getenv("STIRLING_PDF_DESKTOP_UI") == 'true') {
-    	headerType = "gui"
+        headerType = "gui"
     } else {
-    	headerType = "console"
+        headerType = "console"
     }
     jarTask = tasks.bootJar
 
@@ -220,13 +237,11 @@ launch4j {
     downloadUrl="https://download.oracle.com/java/21/latest/jdk-21_windows-x64_bin.exe"
 
     if(System.getenv("STIRLING_PDF_DESKTOP_UI") == 'true') {
-    	variables=["BROWSER_OPEN=true", "STIRLING_PDF_DESKTOP_UI=true"]
+        variables=["BROWSER_OPEN=true", "STIRLING_PDF_DESKTOP_UI=true"]
     } else {
-    	variables=["BROWSER_OPEN=true"]
+        variables=["BROWSER_OPEN=true"]
     }
 
-
-
     jreMinVersion="17"
 
     mutexName="Stirling-PDF"
@@ -245,19 +260,30 @@ spotless {
 
         googleJavaFormat("1.25.2").aosp().reorderImports(false)
 
-        importOrder("java", "javax", "org", "com", "net", "io")
+        importOrder("java", "javax", "org", "com", "net", "io", "jakarta", "lombok", "me", "stirling")
         toggleOffOn()
         trimTrailingWhitespace()
-        indentWithSpaces()
+        leadingTabsToSpaces()
         endWithNewline()
     }
 }
 
+sonar {
+    properties {
+        property "sonar.projectKey", "Stirling-Tools_Stirling-PDF"
+        property "sonar.organization", "stirling-tools"
+
+        property "sonar.exclusions", "**/build-wrapper-dump.json, src/main/java/org/apache/**, src/main/resources/static/pdfjs/**, src/main/resources/static/pdfjs-legacy/**, src/main/resources/static/js/thirdParty/**"
+        property "sonar.coverage.exclusions", "src/main/java/org/apache/**, src/main/resources/static/pdfjs/**, src/main/resources/static/pdfjs-legacy/**, src/main/resources/static/js/thirdParty/**"
+        property "sonar.cpd.exclusions", "src/main/java/org/apache/**, src/main/resources/static/pdfjs/**, src/main/resources/static/pdfjs-legacy/**, src/main/resources/static/js/thirdParty/**"
+    }
+}
+
 //gradleLint {
 //        rules=['unused-dependency']
 //    }
 tasks.wrapper {
-    gradleVersion = "8.7"
+    gradleVersion = "8.12"
 }
 //tasks.withType(JavaCompile) {
 //    options.compilerArgs << "-Xlint:deprecation"
@@ -267,26 +293,35 @@ configurations.all {
 }
 dependencies {
 
-	if (System.getenv("STIRLING_PDF_DESKTOP_UI") != "false") {
-		implementation "me.friwi:jcefmaven:127.3.1"
-	    implementation "org.openjfx:javafx-controls:21"
-	    implementation "org.openjfx:javafx-swing:21"
+    //tmp for security bumps
+	implementation 'ch.qos.logback:logback-core:1.5.17'
+    implementation 'ch.qos.logback:logback-classic:1.5.17'
+
+
+    // Exclude vulnerable BouncyCastle version used in tableau
+    configurations.all {
+        exclude group: 'org.bouncycastle', module: 'bcpkix-jdk15on'
+        exclude group: 'org.bouncycastle', module: 'bcutil-jdk15on'
+        exclude group: 'org.bouncycastle', module: 'bcmail-jdk15on'
+    }
+
+    if (System.getenv("STIRLING_PDF_DESKTOP_UI") != "false") {
+        implementation "me.friwi:jcefmaven:132.3.1"
+        implementation "org.openjfx:javafx-controls:21"
+        implementation "org.openjfx:javafx-swing:21"
     }
 
     //security updates
-    implementation "org.springframework:spring-webmvc:6.2.1"
+    implementation "org.springframework:spring-webmvc:6.2.3"
 
     implementation("io.github.pixee:java-security-toolkit:1.2.1")
 
-    // implementation "org.yaml:snakeyaml:2.2"
-    implementation 'com.github.Carleslc.Simple-YAML:Simple-Yaml:1.8.4'
-
     // Exclude Tomcat and include Jetty
     implementation("org.springframework.boot:spring-boot-starter-web:$springBootVersion")
     implementation "org.springframework.boot:spring-boot-starter-jetty:$springBootVersion"
 
     implementation "org.springframework.boot:spring-boot-starter-thymeleaf:$springBootVersion"
-    implementation 'com.posthog.java:posthog:1.1.1'
+    implementation 'com.posthog.java:posthog:1.2.0'
     implementation 'com.googlecode.owasp-java-html-sanitizer:owasp-java-html-sanitizer:20240325.1'
 
 
@@ -296,22 +331,24 @@ dependencies {
         implementation "org.springframework.boot:spring-boot-starter-data-jpa:$springBootVersion"
         implementation "org.springframework.boot:spring-boot-starter-oauth2-client:$springBootVersion"
 
-		implementation "org.springframework.session:spring-session-core:$springBootVersion"
+        implementation "org.springframework.session:spring-session-core:3.4.2"
+        implementation "org.springframework:spring-jdbc:6.2.3"
 
-	    implementation 'com.unboundid.product.scim2:scim2-sdk-client:2.3.5'
+        implementation 'com.unboundid.product.scim2:scim2-sdk-client:2.3.5'
         // Don't upgrade h2database
         runtimeOnly "com.h2database:h2:2.3.232"
+        runtimeOnly "org.postgresql:postgresql:42.7.5"
         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 'org.springframework.security:spring-security-core:$springSecuritySamlVersion'
         implementation 'com.coveo:saml-client:5.0.0'
 
-
     }
+    implementation 'org.snakeyaml:snakeyaml-engine:2.9'
 
     testImplementation "org.springframework.boot:spring-boot-starter-test:$springBootVersion"
 
@@ -344,13 +381,15 @@ dependencies {
     //general PDF
 
     // https://mvnrepository.com/artifact/com.opencsv/opencsv
-    implementation ("com.opencsv:opencsv:5.9") {
+    implementation ("com.opencsv:opencsv:5.10") {
         exclude group: "commons-logging", module: "commons-logging"
     }
 
     implementation ("org.apache.pdfbox:pdfbox:$pdfboxVersion") {
         exclude group: "commons-logging", module: "commons-logging"
     }
+    implementation "org.apache.pdfbox:preflight:$pdfboxVersion"
+
 
     implementation ("org.apache.pdfbox:xmpbox:$pdfboxVersion") {
         exclude group: "commons-logging", module: "commons-logging"
@@ -368,7 +407,7 @@ dependencies {
     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.14.2"
+    implementation "io.micrometer:micrometer-core:1.14.4"
     implementation group: "com.google.zxing", name: "core", version: "3.5.3"
     // https://mvnrepository.com/artifact/org.commonmark/commonmark
     implementation "org.commonmark:commonmark:0.24.0"
@@ -377,6 +416,8 @@ dependencies {
     implementation "com.bucket4j:bucket4j_jdk17-core:8.14.0"
     implementation "com.fathzer:javaluator:3.0.5"
 
+    implementation 'com.vladsch.flexmark:flexmark-html2md-converter:0.64.8'
+
     developmentOnly("org.springframework.boot:spring-boot-devtools:$springBootVersion")
     compileOnly "org.projectlombok:lombok:$lombokVersion"
     annotationProcessor "org.projectlombok:lombok:$lombokVersion"
@@ -400,13 +441,13 @@ task writeVersion {
 }
 
 swaggerhubUpload {
-    //dependsOn generateOpenApiDocs  // Depends on your task generating Swagger docs
-    api "Stirling-PDF"  // The name of your API on SwaggerHub
-    owner "Frooodle"  // Your SwaggerHub username (or organization name)
-    version project.version  // The version of your API
-    inputFile "./SwaggerDoc.json"  // The path to your Swagger docs
-    token  "${System.getenv("SWAGGERHUB_API_KEY")}"  // Your SwaggerHub API key, passed as an environment variable
-    oas "3.0.0"  // The version of the OpenAPI Specification you"re using
+    // dependsOn = generateOpenApiDocs  // Depends on your task generating Swagger docs
+    api = "Stirling-PDF"  // The name of your API on SwaggerHub
+    owner = "Frooodle"  // Your SwaggerHub username (or organization name)
+    version = project.version  // The version of your API
+    inputFile = "./SwaggerDoc.json"  // The path to your Swagger docs
+    token = "${System.getenv("SWAGGERHUB_API_KEY")}"  // Your SwaggerHub API key, passed as an environment variable
+    oas = "3.0.0"  // The version of the OpenAPI Specification you"re using
 }
 
 jar {

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

@@ -0,0 +1,63 @@
+services:
+  stirling-pdf:
+    container_name: Stirling-PDF-Security-Fat-Postgres
+    image: stirlingtools/stirling-pdf:latest-fat-postgres
+    deploy:
+      resources:
+        limits:
+          memory: 4G
+    depends_on:
+      - db
+    healthcheck:
+      test: [ "CMD-SHELL", "curl -f http://localhost:8080/api/v1/info/status | grep -q 'UP'" ]
+      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: "false"
+      PUID: 1002
+      PGID: 1002
+      UMASK: "022"
+      SYSTEM_DEFAULTLOCALE: en-US
+      UI_APPNAME: Stirling-PDF
+      UI_HOMEDESCRIPTION: Demo site for Stirling-PDF Latest-fat with Security and PostgreSQL
+      UI_APPNAMENAVBAR: Stirling-PDF Latest-fat-PostgreSQL
+      SYSTEM_MAXFILESIZE: "100"
+      METRICS_ENABLED: "true"
+      SYSTEM_GOOGLEVISIBILITY: "true"
+      SYSTEM_DATASOURCE_ENABLECUSTOMDATABASE: "true"
+      SYSTEM_DATASOURCE_CUSTOMDATABASEURL: "jdbc:postgresql://db:5432/stirling_pdf"
+      SYSTEM_DATASOURCE_USERNAME: "admin"
+      SYSTEM_DATASOURCE_PASSWORD: "stirling"
+    restart: on-failure:5
+
+  db:
+    image: 'postgres:17.2-alpine'
+    restart: on-failure:5
+    container_name: db
+    ports:
+      - "5432:5432"
+    environment:
+      POSTGRES_DB: "stirling_pdf"
+      POSTGRES_USER: "admin"
+      POSTGRES_PASSWORD: "stirling"
+    shm_size: "512mb"
+    deploy:
+      resources:
+        limits:
+          memory: 512m
+          cpus: "0.5"
+    healthcheck:
+      test: [ "CMD-SHELL", "pg_isready -U admin stirling_pdf" ]
+      interval: 1s
+      timeout: 5s
+      retries: 10
+    volumes:
+      - ./stirling/latest/data:/pgdata

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

@@ -14,9 +14,9 @@ services:
     ports:
       - 8080:8080
     volumes:
-      - /stirling/latest/data:/usr/share/tessdata:rw
-      - /stirling/latest/config:/configs:rw
-      - /stirling/latest/logs:/logs:rw
+      - ./stirling/latest/data:/usr/share/tessdata:rw
+      - ./stirling/latest/config:/configs:rw
+      - ./stirling/latest/logs:/logs:rw
     environment:
       DOCKER_ENABLE_SECURITY: "true"
       SECURITY_ENABLELOGIN: "false"

exampleYmlFiles/docker-compose-latest-security.yml

@@ -14,9 +14,9 @@ services:
     ports:
       - "8080:8080"
     volumes:
-      - /stirling/latest/data:/usr/share/tessdata:rw
-      - /stirling/latest/config:/configs:rw
-      - /stirling/latest/logs:/logs:rw
+      - ./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"

exampleYmlFiles/test_cicd.yml

@@ -1,6 +1,6 @@
 services:
   stirling-pdf:
-    container_name: Stirling-PDF-Security-Fat
+    container_name: Stirling-PDF-Security-Fat-with-login
     image: stirlingtools/stirling-pdf:latest-fat
     deploy:
       resources:

gradle.properties

@@ -0,0 +1,7 @@
+# Enables parallel execution of tasks, allowing multiple tasks to run simultaneously
+org.gradle.parallel=true
+
+# Enables build caching to reuse outputs from previous builds for faster execution
+# org.gradle.caching=true
+
+org.gradle.build-scan=true

gradle/wrapper/gradle-wrapper.properties

@@ -1,5 +1,7 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.12-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.12-all.zip
+networkTimeout=10000
+validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

gradlew

@@ -15,6 +15,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
+# SPDX-License-Identifier: Apache-2.0
+#
 
 ##############################################################################
 #
@@ -55,7 +57,7 @@
 #       Darwin, MinGW, and NonStop.
 #
 #   (3) This script is generated from the Groovy template
-#       https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
+#       https://github.com/gradle/gradle/blob/HEAD/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
 #       within the Gradle project.
 #
 #       You can find Gradle at https://github.com/gradle/gradle/.
@@ -80,13 +82,11 @@ do
     esac
 done
 
-APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
-
-APP_NAME="Gradle"
+# This is normally unused
+# shellcheck disable=SC2034
 APP_BASE_NAME=${0##*/}
-
-# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
-DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
+# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
+APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s\n' "$PWD" ) || exit
 
 # Use the maximum available, or set MAX_FD != -1 to use that value.
 MAX_FD=maximum
@@ -133,22 +133,29 @@ location of your Java installation."
     fi
 else
     JAVACMD=java
-    which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+    if ! command -v java >/dev/null 2>&1
+    then
+        die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
 
 Please set the JAVA_HOME variable in your environment to match the
 location of your Java installation."
+    fi
 fi
 
 # Increase the maximum file descriptors if we can.
 if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
     case $MAX_FD in #(
       max*)
+        # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
+        # shellcheck disable=SC2039,SC3045
         MAX_FD=$( ulimit -H -n ) ||
             warn "Could not query maximum file descriptor limit"
     esac
     case $MAX_FD in  #(
       '' | soft) :;; #(
       *)
+        # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
+        # shellcheck disable=SC2039,SC3045
         ulimit -n "$MAX_FD" ||
             warn "Could not set maximum file descriptor limit to $MAX_FD"
     esac
@@ -193,11 +200,15 @@ if "$cygwin" || "$msys" ; then
     done
 fi
 
-# Collect all arguments for the java command;
-#   * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of
-#     shell script including quotes and variable substitutions, so put them in
-#     double quotes to make sure that they get re-expanded; and
-#   * put everything else in single quotes, so that it's not re-expanded.
+
+# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
+
+# Collect all arguments for the java command:
+#   * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments,
+#     and any embedded shellness will be escaped.
+#   * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be
+#     treated as '${Hostname}' itself on the command line.
 
 set -- \
         "-Dorg.gradle.appname=$APP_BASE_NAME" \

gradlew.bat

@@ -13,6 +13,8 @@
 @rem See the License for the specific language governing permissions and
 @rem limitations under the License.
 @rem
+@rem SPDX-License-Identifier: Apache-2.0
+@rem
 
 @if "%DEBUG%"=="" @echo off
 @rem ##########################################################################
@@ -26,6 +28,7 @@ if "%OS%"=="Windows_NT" setlocal
 
 set DIRNAME=%~dp0
 if "%DIRNAME%"=="" set DIRNAME=.
+@rem This is normally unused
 set APP_BASE_NAME=%~n0
 set APP_HOME=%DIRNAME%
 
@@ -42,11 +45,11 @@ set JAVA_EXE=java.exe
 %JAVA_EXE% -version >NUL 2>&1
 if %ERRORLEVEL% equ 0 goto execute
 
-echo.
-echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
-echo.
-echo Please set the JAVA_HOME variable in your environment to match the
-echo location of your Java installation.
+echo. 1>&2
+echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2
+echo. 1>&2
+echo Please set the JAVA_HOME variable in your environment to match the 1>&2
+echo location of your Java installation. 1>&2
 
 goto fail
 
@@ -56,11 +59,11 @@ set JAVA_EXE=%JAVA_HOME%/bin/java.exe
 
 if exist "%JAVA_EXE%" goto execute
 
-echo.
-echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
-echo.
-echo Please set the JAVA_HOME variable in your environment to match the
-echo location of your Java installation.
+echo. 1>&2
+echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2
+echo. 1>&2
+echo Please set the JAVA_HOME variable in your environment to match the 1>&2
+echo location of your Java installation. 1>&2
 
 goto fail
 

scripts/counter_translation.py

@@ -75,7 +75,7 @@ def write_readme(progress_list: list[tuple[str, int]]) -> None:
                         f"![{value}%](https://geps.dev/progress/{value})",
                     )
 
-    with open("README.md", "w", encoding="utf-8") as file:
+    with open("README.md", "w", encoding="utf-8", newline="\n") as file:
         file.writelines(content)
 
 
@@ -135,9 +135,10 @@ def compare_files(
         # elif "language.direction" in sort_ignore_translation[language]["missing"]:
         #     sort_ignore_translation[language]["missing"].remove("language.direction")
 
-        with open(default_file_path, encoding="utf-8") as default_file, open(
-            file_path, encoding="utf-8"
-        ) as file:
+        with (
+            open(default_file_path, encoding="utf-8") as default_file,
+            open(file_path, encoding="utf-8") as file,
+        ):
             for _ in range(5):
                 next(default_file)
                 try:
@@ -195,7 +196,7 @@ def compare_files(
             )
         )
     ignore_translation = convert_to_multiline(sort_ignore_translation)
-    with open(ignore_translation_file, "w", encoding="utf-8") as file:
+    with open(ignore_translation_file, "w", encoding="utf-8", newline="\n") as file:
         file.write(tomlkit.dumps(ignore_translation))
 
     unique_data = list(set(result_list))

scripts/ignore_translation.toml

@@ -24,7 +24,6 @@ ignore = [
 [cs_CZ]
 ignore = [
     'language.direction',
-    'pipeline.header',
     'text',
 ]
 
@@ -50,6 +49,7 @@ ignore = [
     'pipeline.title',
     'pipelineOptions.pipelineHeader',
     'pro',
+    'redact.zoom',
     'sponsor',
     'text',
     'validateSignature.cert.bits',
@@ -210,6 +210,11 @@ ignore = [
     'watermark.type.1',
 ]
 
+[sl_SI]
+ignore = [
+    'language.direction',
+]
+
 [sr_LATN_RS]
 ignore = [
     'language.direction',
@@ -247,6 +252,11 @@ ignore = [
     'showJS.tags',
 ]
 
+[zh_BO]
+ignore = [
+    'language.direction',
+]
+
 [zh_CN]
 ignore = [
     'language.direction',

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

@@ -6,6 +6,7 @@ import org.springframework.core.Ordered;
 import org.springframework.core.annotation.Order;
 
 import lombok.extern.slf4j.Slf4j;
+
 import stirling.software.SPDF.model.ApplicationProperties;
 
 @Configuration
@@ -27,4 +28,9 @@ public class EEAppConfig {
     public boolean runningEnterpriseEdition() {
         return licenseKeyChecker.getEnterpriseEnabledResult();
     }
+
+    @Bean(name = "SSOAutoLogin")
+    public boolean ssoAutoLogin() {
+        return applicationProperties.getEnterpriseEdition().isSsoAutoLogin();
+    }
 }

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

@@ -13,12 +13,14 @@ 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 {
+    // todo: place in config files?
     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();
@@ -67,7 +69,7 @@ public class KeygenLicenseVerifier {
 
             return false;
         } catch (Exception e) {
-            log.error("Error verifying license: " + e.getMessage());
+            log.error("Error verifying license: {}", e.getMessage());
             return false;
         }
     }
@@ -94,10 +96,9 @@ public class KeygenLicenseVerifier {
                         .build();
 
         HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
-        log.info(" validateLicenseResponse body: " + response.body());
+        log.debug("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();
 
@@ -119,7 +120,7 @@ public class KeygenLicenseVerifier {
             log.info(applicationProperties.toString());
 
         } else {
-            log.error("Error validating license. Status code: " + response.statusCode());
+            log.error("Error validating license. Status code: {}", response.statusCode());
         }
         return jsonResponse;
     }

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

@@ -7,6 +7,7 @@ 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;
 
@@ -18,7 +19,7 @@ public class LicenseKeyChecker {
 
     private final ApplicationProperties applicationProperties;
 
-    private boolean enterpriseEnbaledResult = false;
+    private boolean enterpriseEnabledResult = false;
 
     @Autowired
     public LicenseKeyChecker(
@@ -35,12 +36,12 @@ public class LicenseKeyChecker {
 
     private void checkLicense() {
         if (!applicationProperties.getEnterpriseEdition().isEnabled()) {
-            enterpriseEnbaledResult = false;
+            enterpriseEnabledResult = false;
         } else {
-            enterpriseEnbaledResult =
+            enterpriseEnabledResult =
                     licenseService.verifyLicense(
                             applicationProperties.getEnterpriseEdition().getKey());
-            if (enterpriseEnbaledResult) {
+            if (enterpriseEnabledResult) {
                 log.info("License key is valid.");
             } else {
                 log.info("License key is invalid.");
@@ -50,11 +51,11 @@ public class LicenseKeyChecker {
 
     public void updateLicenseKey(String newKey) throws IOException {
         applicationProperties.getEnterpriseEdition().setKey(newKey);
-        GeneralUtils.saveKeyToConfig("EnterpriseEdition.key", newKey, false);
+        GeneralUtils.saveKeyToSettings("EnterpriseEdition.key", newKey);
         checkLicense();
     }
 
     public boolean getEnterpriseEnabledResult() {
-        return enterpriseEnbaledResult;
+        return enterpriseEnabledResult;
     }
 }

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

@@ -1,7 +1,7 @@
 package stirling.software.SPDF;
 
 import java.io.IOException;
-import java.net.ServerSocket;
+import java.net.URISyntaxException;
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.Paths;
@@ -21,18 +21,23 @@ import io.github.pixee.security.SystemCommand;
 
 import jakarta.annotation.PostConstruct;
 import jakarta.annotation.PreDestroy;
+
 import lombok.extern.slf4j.Slf4j;
+
 import stirling.software.SPDF.UI.WebBrowser;
 import stirling.software.SPDF.config.ConfigInitializer;
+import stirling.software.SPDF.config.InstallationPathConfig;
 import stirling.software.SPDF.model.ApplicationProperties;
+import stirling.software.SPDF.utils.UrlUtils;
 
-@SpringBootApplication
-@EnableScheduling
 @Slf4j
-public class SPdfApplication {
+@EnableScheduling
+@SpringBootApplication
+public class SPDFApplication {
 
-    private static String baseUrlStatic;
     private static String serverPortStatic;
+    private static String baseUrlStatic;
+
     private final Environment env;
     private final ApplicationProperties applicationProperties;
     private final WebBrowser webBrowser;
@@ -40,7 +45,7 @@ public class SPdfApplication {
     @Value("${baseUrl:http://localhost}")
     private String baseUrl;
 
-    public SPdfApplication(
+    public SPDFApplication(
             Environment env,
             ApplicationProperties applicationProperties,
             @Autowired(required = false) WebBrowser webBrowser) {
@@ -49,42 +54,47 @@ public class SPdfApplication {
         this.webBrowser = webBrowser;
     }
 
-    // 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;
-        }
-    }
-
     public static void main(String[] args) throws IOException, InterruptedException {
-        SpringApplication app = new SpringApplication(SPdfApplication.class);
+        SpringApplication app = new SpringApplication(SPDFApplication.class);
+
         Properties props = new Properties();
+
         if (Boolean.parseBoolean(System.getProperty("STIRLING_PDF_DESKTOP_UI", "false"))) {
             System.setProperty("java.awt.headless", "false");
             app.setHeadless(false);
             props.put("java.awt.headless", "false");
             props.put("spring.main.web-application-type", "servlet");
+
+            int desiredPort = 8080;
+            String port = UrlUtils.findAvailablePort(desiredPort);
+            props.put("server.port", port);
+            System.setProperty("server.port", port);
+            log.info("Desktop UI mode: Using port {}", port);
+        }
+
+        app.setAdditionalProfiles(getActiveProfile(args));
+
+        ConfigInitializer initializer = new ConfigInitializer();
+        try {
+            initializer.ensureConfigExists();
+        } catch (IOException | URISyntaxException e) {
+            log.error("Error initialising configuration", e);
         }
-        app.setAdditionalProfiles("default");
-        app.addInitializers(new ConfigInitializer());
         Map<String, String> propertyFiles = new HashMap<>();
+
         // External config files
-        if (Files.exists(Paths.get("configs/settings.yml"))) {
-            propertyFiles.put("spring.config.additional-location", "file:configs/settings.yml");
+        Path settingsPath = Paths.get(InstallationPathConfig.getSettingsPath());
+        log.info("Settings file: {}", settingsPath.toString());
+        if (Files.exists(settingsPath)) {
+            propertyFiles.put(
+                    "spring.config.additional-location", "file:" + settingsPath.toString());
         } else {
-            log.warn("External configuration file 'configs/settings.yml' does not exist.");
+            log.warn("External configuration file '{}' does not exist.", settingsPath.toString());
         }
-        if (Files.exists(Paths.get("configs/custom_settings.yml"))) {
+
+        Path customSettingsPath = Paths.get(InstallationPathConfig.getCustomSettingsPath());
+        log.info("Custom settings file: {}", customSettingsPath.toString());
+        if (Files.exists(customSettingsPath)) {
             String existingLocation =
                     propertyFiles.getOrDefault("spring.config.additional-location", "");
             if (!existingLocation.isEmpty()) {
@@ -92,57 +102,39 @@ public class SPdfApplication {
             }
             propertyFiles.put(
                     "spring.config.additional-location",
-                    existingLocation + "file:configs/custom_settings.yml");
+                    existingLocation + "file:" + customSettingsPath.toString());
         } else {
-            log.warn("Custom configuration file 'configs/custom_settings.yml' does not exist.");
+            log.warn(
+                    "Custom configuration file '{}' does not exist.",
+                    customSettingsPath.toString());
         }
         Properties finalProps = new Properties();
+
         if (!propertyFiles.isEmpty()) {
             finalProps.putAll(
                     Collections.singletonMap(
                             "spring.config.additional-location",
                             propertyFiles.get("spring.config.additional-location")));
         }
+
         if (!props.isEmpty()) {
             finalProps.putAll(props);
         }
         app.setDefaultProperties(finalProps);
+
         app.run(args);
+
         // Ensure directories are created
         try {
-            Files.createDirectories(Path.of("customFiles/static/"));
-            Files.createDirectories(Path.of("customFiles/templates/"));
-        } catch (Exception e) {
+            Files.createDirectories(Path.of(InstallationPathConfig.getTemplatesPath()));
+            Files.createDirectories(Path.of(InstallationPathConfig.getStaticPath()));
+        } catch (IOException e) {
             log.error("Error creating directories: {}", e.getMessage());
         }
+
         printStartupLogs();
     }
 
-    private static void printStartupLogs() {
-        log.info("Stirling-PDF Started.");
-        String url = baseUrlStatic + ":" + getStaticPort();
-        log.info("Navigate to {}", url);
-    }
-
-    public static String getStaticBaseUrl() {
-        return baseUrlStatic;
-    }
-
-    public static String getStaticPort() {
-        return serverPortStatic;
-    }
-
-    @Value("${server.port:8080}")
-    public void setServerPortStatic(String port) {
-        if ("auto".equalsIgnoreCase(port)) {
-            // Use Spring Boot's automatic port assignment (server.port=0)
-            SPdfApplication.serverPortStatic = // This will let Spring Boot assign an available port
-                    "0";
-        } else {
-            SPdfApplication.serverPortStatic = port;
-        }
-    }
-
     @PostConstruct
     public void init() {
         baseUrlStatic = this.baseUrl;
@@ -165,7 +157,7 @@ public class SPdfApplication {
                     } else if (os.contains("nix") || os.contains("nux")) {
                         SystemCommand.runCommand(rt, "xdg-open " + url);
                     }
-                } catch (Exception e) {
+                } catch (IOException e) {
                     log.error("Error opening browser: {}", e.getMessage());
                 }
             }
@@ -173,6 +165,27 @@ public class SPdfApplication {
         log.info("Running configs {}", applicationProperties.toString());
     }
 
+    @Value("${server.port:8080}")
+    public void setServerPort(String 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;
+        }
+    }
+
+    public static void setServerPortStatic(String 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;
+        }
+    }
+
     @PreDestroy
     public void cleanup() {
         if (webBrowser != null) {
@@ -180,11 +193,31 @@ public class SPdfApplication {
         }
     }
 
-    public String getNonStaticBaseUrl() {
+    private static void printStartupLogs() {
+        log.info("Stirling-PDF Started.");
+        String url = baseUrlStatic + ":" + getStaticPort();
+        log.info("Navigate to {}", url);
+    }
+
+    private static String[] getActiveProfile(String[] args) {
+        if (args == null) {
+            return new String[] {"default"};
+        }
+
+        for (String arg : args) {
+            if (arg.contains("spring.profiles.active")) {
+                return arg.substring(args[0].indexOf('=') + 1).split(", ");
+            }
+        }
+
+        return new String[] {"default"};
+    }
+
+    public static String getStaticBaseUrl() {
         return baseUrlStatic;
     }
 
-    public String getNonStaticPort() {
+    public static String getStaticPort() {
         return serverPortStatic;
     }
 }

src/main/java/stirling/software/SPDF/UI/impl/DesktopBrowser.java

@@ -34,12 +34,17 @@ import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
 import org.springframework.stereotype.Component;
 
 import jakarta.annotation.PreDestroy;
+
 import lombok.extern.slf4j.Slf4j;
+
 import me.friwi.jcefmaven.CefAppBuilder;
 import me.friwi.jcefmaven.EnumProgress;
 import me.friwi.jcefmaven.MavenCefAppHandlerAdapter;
 import me.friwi.jcefmaven.impl.progress.ConsoleProgressHandler;
+
 import stirling.software.SPDF.UI.WebBrowser;
+import stirling.software.SPDF.config.InstallationPathConfig;
+import stirling.software.SPDF.utils.UIScaling;
 
 @Component
 @Slf4j
@@ -72,7 +77,8 @@ public class DesktopBrowser implements WebBrowser {
                         CefAppBuilder builder = new CefAppBuilder();
                         configureCefSettings(builder);
                         builder.setProgressHandler(createProgressHandler());
-
+                        builder.setInstallDir(
+                                new File(InstallationPathConfig.getClientWebUIPath()));
                         // Build and initialize CEF
                         cefApp = builder.build();
                         client = cefApp.createClient();
@@ -99,8 +105,16 @@ public class DesktopBrowser implements WebBrowser {
 
     private void configureCefSettings(CefAppBuilder builder) {
         CefSettings settings = builder.getCefSettings();
-        settings.cache_path = new File("jcef-bundle").getAbsolutePath();
-        settings.root_cache_path = new File("jcef-bundle").getAbsolutePath();
+        String basePath = InstallationPathConfig.getClientWebUIPath();
+        log.info("basePath " + basePath);
+        settings.cache_path = new File(basePath + "cache").getAbsolutePath();
+        settings.root_cache_path = new File(basePath + "root_cache").getAbsolutePath();
+        //        settings.browser_subprocess_path = new File(basePath +
+        // "subprocess").getAbsolutePath();
+        //        settings.resources_dir_path = new File(basePath + "resources").getAbsolutePath();
+        //        settings.locales_dir_path = new File(basePath + "locales").getAbsolutePath();
+        settings.log_file = new File(basePath, "debug.log").getAbsolutePath();
+
         settings.persist_session_cookies = true;
         settings.windowless_rendering_enabled = false;
         settings.log_severity = CefSettings.LogSeverity.LOGSEVERITY_INFO;
@@ -205,13 +219,16 @@ public class DesktopBrowser implements WebBrowser {
                     }
                 });
 
-        frame.setSize(1280, 768);
+        frame.setSize(UIScaling.scaleWidth(1280), UIScaling.scaleHeight(800));
         frame.setLocationRelativeTo(null);
 
         loadIcon();
     }
 
     private void setupLoadHandler() {
+        final long initStartTime = System.currentTimeMillis();
+        log.info("Setting up load handler at: {}", initStartTime);
+
         client.addLoadHandler(
                 new CefLoadHandlerAdapter() {
                     @Override
@@ -220,32 +237,79 @@ public class DesktopBrowser implements WebBrowser {
                             boolean isLoading,
                             boolean canGoBack,
                             boolean canGoForward) {
+                        log.debug(
+                                "Loading state change - isLoading: {}, canGoBack: {}, canGoForward: {}, "
+                                        + "browserInitialized: {}, Time elapsed: {}ms",
+                                isLoading,
+                                canGoBack,
+                                canGoForward,
+                                browserInitialized,
+                                System.currentTimeMillis() - initStartTime);
+
                         if (!isLoading && !browserInitialized) {
+                            log.info(
+                                    "Browser finished loading, preparing to initialize UI components");
                             browserInitialized = true;
                             SwingUtilities.invokeLater(
                                     () -> {
-                                        if (loadingWindow != null) {
-                                            Timer timer =
-                                                    new Timer(
-                                                            500,
-                                                            e -> {
-                                                                loadingWindow.dispose();
-                                                                loadingWindow = null;
+                                        try {
+                                            if (loadingWindow != null) {
+                                                log.info("Starting UI initialization sequence");
 
-                                                                frame.dispose();
-                                                                frame.setOpacity(1.0f);
-                                                                frame.setUndecorated(false);
-                                                                frame.pack();
-                                                                frame.setSize(1280, 800);
-                                                                frame.setLocationRelativeTo(null);
-                                                                frame.setVisible(true);
-                                                                frame.requestFocus();
-                                                                frame.toFront();
-                                                                browser.getUIComponent()
-                                                                        .requestFocus();
-                                                            });
-                                            timer.setRepeats(false);
-                                            timer.start();
+                                                // Close loading window first
+                                                loadingWindow.setVisible(false);
+                                                loadingWindow.dispose();
+                                                loadingWindow = null;
+                                                log.info("Loading window disposed");
+
+                                                // Then setup the main frame
+                                                frame.setVisible(false);
+                                                frame.dispose();
+                                                frame.setOpacity(1.0f);
+                                                frame.setUndecorated(false);
+                                                frame.pack();
+                                                frame.setSize(
+                                                        UIScaling.scaleWidth(1280),
+                                                        UIScaling.scaleHeight(800));
+                                                frame.setLocationRelativeTo(null);
+                                                log.debug("Frame reconfigured");
+
+                                                // Show the main frame
+                                                frame.setVisible(true);
+                                                frame.requestFocus();
+                                                frame.toFront();
+                                                log.info("Main frame displayed and focused");
+
+                                                // Focus the browser component
+                                                Timer focusTimer =
+                                                        new Timer(
+                                                                100,
+                                                                e -> {
+                                                                    try {
+                                                                        browser.getUIComponent()
+                                                                                .requestFocus();
+                                                                        log.info(
+                                                                                "Browser component focused");
+                                                                    } catch (Exception ex) {
+                                                                        log.error(
+                                                                                "Error focusing browser",
+                                                                                ex);
+                                                                    }
+                                                                });
+                                                focusTimer.setRepeats(false);
+                                                focusTimer.start();
+                                            }
+                                        } catch (Exception e) {
+                                            log.error("Error during UI initialization", e);
+                                            // Attempt cleanup on error
+                                            if (loadingWindow != null) {
+                                                loadingWindow.dispose();
+                                                loadingWindow = null;
+                                            }
+                                            if (frame != null) {
+                                                frame.setVisible(true);
+                                                frame.requestFocus();
+                                            }
                                         }
                                     });
                         }

src/main/java/stirling/software/SPDF/UI/impl/LoadingWindow.java

@@ -1,22 +1,41 @@
 package stirling.software.SPDF.UI.impl;
 
 import java.awt.*;
+import java.io.BufferedReader;
 import java.io.InputStream;
+import java.io.InputStreamReader;
+import java.util.HashSet;
+import java.util.Set;
+import java.util.concurrent.TimeUnit;
 
 import javax.imageio.ImageIO;
 import javax.swing.*;
 
+import io.github.pixee.security.BoundedLineReader;
+
 import lombok.extern.slf4j.Slf4j;
 
+import stirling.software.SPDF.utils.UIScaling;
+
 @Slf4j
 public class LoadingWindow extends JDialog {
     private final JProgressBar progressBar;
     private final JLabel statusLabel;
     private final JPanel mainPanel;
     private final JLabel brandLabel;
+    private long startTime;
+
+    private Timer stuckTimer;
+    private long stuckThreshold = 4000;
+    private long timeAt90Percent = -1;
+    private volatile Process explorerProcess;
+    private static final boolean IS_WINDOWS =
+            System.getProperty("os.name").toLowerCase().contains("win");
 
     public LoadingWindow(Frame parent, String initialUrl) {
         super(parent, "Initializing Stirling-PDF", true);
+        startTime = System.currentTimeMillis();
+        log.info("Creating LoadingWindow - initialization started at: {}", startTime);
 
         // Initialize components
         mainPanel = new JPanel();
@@ -29,8 +48,8 @@ public class LoadingWindow extends JDialog {
         gbc.gridwidth = GridBagConstraints.REMAINDER;
         gbc.fill = GridBagConstraints.HORIZONTAL;
         gbc.insets = new Insets(5, 5, 5, 5);
-        gbc.weightx = 1.0; // Add horizontal weight
-        gbc.weighty = 0.0; // Add vertical weight
+        gbc.weightx = 1.0;
+        gbc.weighty = 0.0;
 
         // Add icon
         try {
@@ -38,17 +57,19 @@ public class LoadingWindow extends JDialog {
                 if (is != null) {
                     Image img = ImageIO.read(is);
                     if (img != null) {
-                        Image scaledImg = img.getScaledInstance(48, 48, Image.SCALE_SMOOTH);
+                        Image scaledImg = UIScaling.scaleIcon(img, 48, 48);
                         JLabel iconLabel = new JLabel(new ImageIcon(scaledImg));
                         iconLabel.setHorizontalAlignment(SwingConstants.CENTER);
                         gbc.gridy = 0;
                         mainPanel.add(iconLabel, gbc);
+                        log.info("Icon loaded and scaled successfully");
                     }
                 }
             }
         } catch (Exception e) {
             log.error("Failed to load icon", e);
         }
+
         // URL Label with explicit size
         brandLabel = new JLabel(initialUrl);
         brandLabel.setHorizontalAlignment(SwingConstants.CENTER);
@@ -63,6 +84,7 @@ public class LoadingWindow extends JDialog {
         statusLabel.setPreferredSize(new Dimension(300, 25));
         gbc.gridy = 2;
         mainPanel.add(statusLabel, gbc);
+
         // Progress bar with explicit size
         progressBar = new JProgressBar(0, 100);
         progressBar.setStringPainted(true);
@@ -77,38 +99,253 @@ public class LoadingWindow extends JDialog {
         setUndecorated(false);
 
         // Set size and position
-        setSize(400, 200);
+        setSize(UIScaling.scaleWidth(400), UIScaling.scaleHeight(200));
+
         setLocationRelativeTo(parent);
         setAlwaysOnTop(true);
         setProgress(0);
         setStatus("Starting...");
+
+        log.info(
+                "LoadingWindow initialization completed in {}ms",
+                System.currentTimeMillis() - startTime);
+    }
+
+    private void checkAndRefreshExplorer() {
+        if (!IS_WINDOWS) {
+            return;
+        }
+        if (timeAt90Percent == -1) {
+            timeAt90Percent = System.currentTimeMillis();
+            stuckTimer =
+                    new Timer(
+                            1000,
+                            e -> {
+                                long currentTime = System.currentTimeMillis();
+                                if (currentTime - timeAt90Percent > stuckThreshold) {
+                                    try {
+                                        log.debug(
+                                                "Attempting Windows explorer refresh due to 90% stuck state");
+                                        String currentDir = System.getProperty("user.dir");
+
+                                        // Store current explorer PIDs before we start new one
+                                        Set<String> existingPids = new HashSet<>();
+                                        ProcessBuilder listExplorer =
+                                                new ProcessBuilder(
+                                                        "cmd",
+                                                        "/c",
+                                                        "wmic",
+                                                        "process",
+                                                        "where",
+                                                        "name='explorer.exe'",
+                                                        "get",
+                                                        "ProcessId",
+                                                        "/format:csv");
+                                        Process process = listExplorer.start();
+                                        BufferedReader reader =
+                                                new BufferedReader(
+                                                        new InputStreamReader(
+                                                                process.getInputStream()));
+                                        String line;
+                                        while ((line =
+                                                        BoundedLineReader.readLine(
+                                                                reader, 5_000_000))
+                                                != null) {
+                                            if (line.matches(".*\\d+.*")) { // Contains numbers
+                                                String[] parts = line.trim().split(",");
+                                                if (parts.length >= 2) {
+                                                    existingPids.add(
+                                                            parts[parts.length - 1].trim());
+                                                }
+                                            }
+                                        }
+                                        process.waitFor(2, TimeUnit.SECONDS);
+
+                                        // Start new explorer
+                                        ProcessBuilder pb =
+                                                new ProcessBuilder(
+                                                        "cmd",
+                                                        "/c",
+                                                        "start",
+                                                        "/min",
+                                                        "/b",
+                                                        "explorer.exe",
+                                                        currentDir);
+                                        pb.redirectErrorStream(true);
+                                        explorerProcess = pb.start();
+
+                                        // Schedule cleanup
+                                        Timer cleanupTimer =
+                                                new Timer(
+                                                        2000,
+                                                        cleanup -> {
+                                                            try {
+                                                                // Find new explorer processes
+                                                                ProcessBuilder findNewExplorer =
+                                                                        new ProcessBuilder(
+                                                                                "cmd",
+                                                                                "/c",
+                                                                                "wmic",
+                                                                                "process",
+                                                                                "where",
+                                                                                "name='explorer.exe'",
+                                                                                "get",
+                                                                                "ProcessId",
+                                                                                "/format:csv");
+                                                                Process newProcess =
+                                                                        findNewExplorer.start();
+                                                                BufferedReader newReader =
+                                                                        new BufferedReader(
+                                                                                new InputStreamReader(
+                                                                                        newProcess
+                                                                                                .getInputStream()));
+                                                                String newLine;
+                                                                while ((newLine =
+                                                                                BoundedLineReader
+                                                                                        .readLine(
+                                                                                                newReader,
+                                                                                                5_000_000))
+                                                                        != null) {
+                                                                    if (newLine.matches(
+                                                                            ".*\\d+.*")) {
+                                                                        String[] parts =
+                                                                                newLine.trim()
+                                                                                        .split(",");
+                                                                        if (parts.length >= 2) {
+                                                                            String pid =
+                                                                                    parts[
+                                                                                            parts.length
+                                                                                                    - 1]
+                                                                                            .trim();
+                                                                            if (!existingPids
+                                                                                    .contains(
+                                                                                            pid)) {
+                                                                                log.debug(
+                                                                                        "Found new explorer.exe with PID: "
+                                                                                                + pid);
+                                                                                ProcessBuilder
+                                                                                        killProcess =
+                                                                                                new ProcessBuilder(
+                                                                                                        "taskkill",
+                                                                                                        "/PID",
+                                                                                                        pid,
+                                                                                                        "/F");
+                                                                                killProcess
+                                                                                        .redirectErrorStream(
+                                                                                                true);
+                                                                                Process killResult =
+                                                                                        killProcess
+                                                                                                .start();
+                                                                                killResult.waitFor(
+                                                                                        2,
+                                                                                        TimeUnit
+                                                                                                .SECONDS);
+                                                                                log.debug(
+                                                                                        "Explorer process terminated: "
+                                                                                                + pid);
+                                                                            }
+                                                                        }
+                                                                    }
+                                                                }
+                                                                newProcess.waitFor(
+                                                                        2, TimeUnit.SECONDS);
+                                                            } catch (Exception ex) {
+                                                                log.error(
+                                                                        "Error cleaning up Windows explorer process",
+                                                                        ex);
+                                                            }
+                                                        });
+                                        cleanupTimer.setRepeats(false);
+                                        cleanupTimer.start();
+                                        stuckTimer.stop();
+                                    } catch (Exception ex) {
+                                        log.error("Error refreshing Windows explorer", ex);
+                                    }
+                                }
+                            });
+            stuckTimer.setRepeats(true);
+            stuckTimer.start();
+        }
     }
 
     public void setProgress(final int progress) {
         SwingUtilities.invokeLater(
                 () -> {
                     try {
-                        progressBar.setValue(Math.min(Math.max(progress, 0), 100));
-                        progressBar.setString(progress + "%");
+                        int validProgress = Math.min(Math.max(progress, 0), 100);
+                        log.info(
+                                "Setting progress to {}% at {}ms since start",
+                                validProgress, System.currentTimeMillis() - startTime);
+
+                        // Log additional details when near 90%
+                        if (validProgress >= 85 && validProgress <= 95) {
+                            log.info(
+                                    "Near 90% progress - Current status: {}, Window visible: {}, "
+                                            + "Progress bar responding: {}, Memory usage: {}MB",
+                                    statusLabel.getText(),
+                                    isVisible(),
+                                    progressBar.isEnabled(),
+                                    Runtime.getRuntime().totalMemory() / (1024 * 1024));
+
+                            // Add thread state logging
+                            Thread currentThread = Thread.currentThread();
+                            log.info(
+                                    "Current thread state - Name: {}, State: {}, Priority: {}",
+                                    currentThread.getName(),
+                                    currentThread.getState(),
+                                    currentThread.getPriority());
+
+                            if (validProgress >= 90 && validProgress < 95) {
+                                checkAndRefreshExplorer();
+                            } else {
+                                // Reset the timer if we move past 95%
+                                if (validProgress >= 95) {
+                                    if (stuckTimer != null) {
+                                        stuckTimer.stop();
+                                    }
+                                    timeAt90Percent = -1;
+                                }
+                            }
+                        }
+
+                        progressBar.setValue(validProgress);
+                        progressBar.setString(validProgress + "%");
                         mainPanel.revalidate();
                         mainPanel.repaint();
                     } catch (Exception e) {
-                        log.error("Error updating progress", e);
+                        log.error("Error updating progress to " + progress, e);
                     }
                 });
     }
 
     public void setStatus(final String status) {
-        log.info(status);
+        log.info(
+                "Status update at {}ms - Setting status to: {}",
+                System.currentTimeMillis() - startTime,
+                status);
+
         SwingUtilities.invokeLater(
                 () -> {
                     try {
-                        statusLabel.setText(status != null ? status : "");
+                        String validStatus = status != null ? status : "";
+                        statusLabel.setText(validStatus);
+
+                        // Log UI state when status changes
+                        log.info(
+                                "UI State - Window visible: {}, Progress: {}%, Status: {}",
+                                isVisible(), progressBar.getValue(), validStatus);
+
                         mainPanel.revalidate();
                         mainPanel.repaint();
                     } catch (Exception e) {
-                        log.error("Error updating status", e);
+                        log.error("Error updating status to: " + status, e);
                     }
                 });
     }
+
+    @Override
+    public void dispose() {
+        log.info("LoadingWindow disposing after {}ms", System.currentTimeMillis() - startTime);
+        super.dispose();
+    }
 }

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

@@ -4,6 +4,7 @@ import java.io.IOException;
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.Paths;
+import java.util.List;
 import java.util.Properties;
 import java.util.function.Predicate;
 
@@ -19,6 +20,7 @@ import org.springframework.core.io.ResourceLoader;
 import org.thymeleaf.spring6.SpringTemplateEngine;
 
 import lombok.extern.slf4j.Slf4j;
+
 import stirling.software.SPDF.model.ApplicationProperties;
 
 @Configuration
@@ -33,10 +35,7 @@ public class AppConfig {
     }
 
     @Bean
-    @ConditionalOnProperty(
-            name = "system.customHTMLFiles",
-            havingValue = "true",
-            matchIfMissing = false)
+    @ConditionalOnProperty(name = "system.customHTMLFiles", havingValue = "true")
     public SpringTemplateEngine templateEngine(ResourceLoader resourceLoader) {
         SpringTemplateEngine templateEngine = new SpringTemplateEngine();
         templateEngine.addTemplateResolver(new FileFallbackTemplateResolver(resourceLoader));
@@ -74,6 +73,11 @@ public class AppConfig {
                 : "null";
     }
 
+    @Bean(name = "languages")
+    public List<String> languages() {
+        return applicationProperties.getUi().getLanguages();
+    }
+
     @Bean(name = "navBarText")
     public String navBarText() {
         String defaultNavBar =
@@ -92,9 +96,9 @@ public class AppConfig {
 
     @Bean(name = "rateLimit")
     public boolean rateLimit() {
-        String appName = System.getProperty("rateLimit");
-        if (appName == null) appName = System.getenv("rateLimit");
-        return (appName != null) ? Boolean.valueOf(appName) : false;
+        String rateLimit = System.getProperty("rateLimit");
+        if (rateLimit == null) rateLimit = System.getenv("rateLimit");
+        return (rateLimit != null) ? Boolean.valueOf(rateLimit) : false;
     }
 
     @Bean(name = "RunningInDocker")
@@ -121,31 +125,12 @@ public class AppConfig {
         }
     }
 
-    @Bean(name = "bookAndHtmlFormatsInstalled")
-    public boolean bookAndHtmlFormatsInstalled() {
-        String installOps = System.getProperty("INSTALL_BOOK_AND_ADVANCED_HTML_OPS");
-        if (installOps == null) {
-            installOps = System.getenv("INSTALL_BOOK_AND_ADVANCED_HTML_OPS");
-        }
-        return "true".equalsIgnoreCase(installOps);
-    }
-
     @ConditionalOnMissingClass("stirling.software.SPDF.config.security.SecurityConfiguration")
-    @Bean(name = "activSecurity")
-    public boolean missingActivSecurity() {
+    @Bean(name = "activeSecurity")
+    public boolean missingActiveSecurity() {
         return false;
     }
 
-    @Bean(name = "watchedFoldersDir")
-    public String watchedFoldersDir() {
-        return "./pipeline/watchedFolders/";
-    }
-
-    @Bean(name = "finishedFoldersDir")
-    public String finishedFoldersDir() {
-        return "./pipeline/finishedFolders/";
-    }
-
     @Bean(name = "directoryFilter")
     public Predicate<Path> processOnlyFiles() {
         return path -> {
@@ -185,16 +170,14 @@ public class AppConfig {
     @Bean(name = "analyticsPrompt")
     @Scope("request")
     public boolean analyticsPrompt() {
-        return applicationProperties.getSystem().getEnableAnalytics() == null
-                || "undefined".equals(applicationProperties.getSystem().getEnableAnalytics());
+        return applicationProperties.getSystem().getEnableAnalytics() == null;
     }
 
     @Bean(name = "analyticsEnabled")
     @Scope("request")
     public boolean analyticsEnabled() {
         if (applicationProperties.getEnterpriseEdition().isEnabled()) return true;
-        return applicationProperties.getSystem().getEnableAnalytics() != null
-                && Boolean.parseBoolean(applicationProperties.getSystem().getEnableAnalytics());
+        return applicationProperties.getSystem().isAnalyticsEnabled();
     }
 
     @Bean(name = "StirlingPDFLabel")

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

@@ -2,13 +2,13 @@ package stirling.software.SPDF.config;
 
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.Scope;
-import org.springframework.stereotype.Service;
 
 import stirling.software.SPDF.config.interfaces.ShowAdminInterface;
 import stirling.software.SPDF.model.ApplicationProperties;
 
-@Service
+@Configuration
 class AppUpdateService {
 
     private final ApplicationProperties applicationProperties;

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

@@ -20,7 +20,7 @@ public class CleanUrlInterceptor implements HandlerInterceptor {
                     "endpoints",
                     "logout",
                     "error",
-                    "erroroauth",
+                    "errorOAuth",
                     "file",
                     "messageType",
                     "infoMessage");

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

@@ -9,146 +9,71 @@ import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.Paths;
 import java.nio.file.StandardCopyOption;
-import java.util.Arrays;
-import java.util.List;
-
-import org.simpleyaml.configuration.comments.CommentType;
-import org.simpleyaml.configuration.file.YamlFile;
-import org.simpleyaml.configuration.implementation.SimpleYamlImplementation;
-import org.simpleyaml.configuration.implementation.snakeyaml.lib.DumperOptions;
-import org.springframework.context.ApplicationContextInitializer;
-import org.springframework.context.ConfigurableApplicationContext;
 
 import lombok.extern.slf4j.Slf4j;
 
+/**
+ * A naive, line-based approach to merging "settings.yml" with "settings.yml.template" while
+ * preserving exact whitespace, blank lines, and inline comments -- but we only rewrite the file if
+ * the merged content actually differs.
+ */
 @Slf4j
-public class ConfigInitializer
-        implements ApplicationContextInitializer<ConfigurableApplicationContext> {
-
-    @Override
-    public void initialize(ConfigurableApplicationContext applicationContext) {
-        try {
-            ensureConfigExists();
-        } catch (Exception e) {
-            throw new RuntimeException("Failed to initialize application configuration", e);
-        }
-    }
+public class ConfigInitializer {
 
     public void ensureConfigExists() throws IOException, URISyntaxException {
-        // Define the path to the external config directory
-        Path destPath = Paths.get("configs", "settings.yml");
-
-        // Check if the file already exists
+        // 1) If settings file doesn't exist, create from template
+        Path destPath = Paths.get(InstallationPathConfig.getSettingsPath());
         if (Files.notExists(destPath)) {
-            // Ensure the destination directory exists
             Files.createDirectories(destPath.getParent());
-
-            // Copy the resource from classpath to the external directory
             try (InputStream in =
                     getClass().getClassLoader().getResourceAsStream("settings.yml.template")) {
-                if (in != null) {
-                    Files.copy(in, destPath);
-                } else {
+                if (in == null) {
                     throw new FileNotFoundException(
                             "Resource file not found: settings.yml.template");
                 }
+                Files.copy(in, destPath);
             }
+            log.info("Created settings file from template");
         } else {
-
-            // Define the path to the config settings file
-            Path settingsPath = Paths.get("configs", "settings.yml");
-            // Load the template resource
-            URL settingsTemplateResource =
-                    getClass().getClassLoader().getResource("settings.yml.template");
-            if (settingsTemplateResource == null) {
+            // 2) Merge existing file with the template
+            URL templateResource = getClass().getClassLoader().getResource("settings.yml.template");
+            if (templateResource == null) {
                 throw new IOException("Resource not found: settings.yml.template");
             }
 
-            // Create a temporary file to copy the resource content
+            // Copy template to a temp location so we can read lines
             Path tempTemplatePath = Files.createTempFile("settings.yml", ".template");
-
-            try (InputStream in = settingsTemplateResource.openStream()) {
+            try (InputStream in = templateResource.openStream()) {
                 Files.copy(in, tempTemplatePath, StandardCopyOption.REPLACE_EXISTING);
             }
 
-            final YamlFile settingsTemplateFile = new YamlFile(tempTemplatePath.toFile());
-            DumperOptions yamlOptionsSettingsTemplateFile =
-                    ((SimpleYamlImplementation) settingsTemplateFile.getImplementation())
-                            .getDumperOptions();
-            yamlOptionsSettingsTemplateFile.setSplitLines(false);
-            settingsTemplateFile.loadWithComments();
-
-            final YamlFile settingsFile = new YamlFile(settingsPath.toFile());
-            DumperOptions yamlOptionsSettingsFile =
-                    ((SimpleYamlImplementation) settingsFile.getImplementation())
-                            .getDumperOptions();
-            yamlOptionsSettingsFile.setSplitLines(false);
-            settingsFile.loadWithComments();
-
-            // Load headers and comments
-            String header = settingsTemplateFile.getHeader();
-
-            // Create a new file for temporary settings
-            final YamlFile tempSettingFile = new YamlFile(settingsPath.toFile());
-            DumperOptions yamlOptionsTempSettingFile =
-                    ((SimpleYamlImplementation) tempSettingFile.getImplementation())
-                            .getDumperOptions();
-            yamlOptionsTempSettingFile.setSplitLines(false);
-            tempSettingFile.createNewFile(true);
-            tempSettingFile.setHeader(header);
-
-            // Get all keys from the template
-            List<String> keys =
-                    Arrays.asList(settingsTemplateFile.getKeys(true).toArray(new String[0]));
-
-            for (String key : keys) {
-                if (!key.contains(".")) {
-                    // Add blank lines and comments to specific sections
-                    tempSettingFile
-                            .path(key)
-                            .comment(settingsTemplateFile.getComment(key))
-                            .blankLine();
-                    continue;
-                }
-                // Copy settings from the template to the settings.yml file
-                changeConfigItemFromCommentToKeyValue(
-                        settingsTemplateFile, settingsFile, tempSettingFile, key);
+            // Copy setting.yaml to a temp location so we can read lines
+            Path settingTempPath = Files.createTempFile("settings", ".yaml");
+            try (InputStream in = Files.newInputStream(destPath)) {
+                Files.copy(in, settingTempPath, StandardCopyOption.REPLACE_EXISTING);
             }
 
-            // Save the settings.yml file
-            tempSettingFile.save();
+            YamlHelper settingsTemplateFile = new YamlHelper(tempTemplatePath);
+            YamlHelper settingsFile = new YamlHelper(settingTempPath);
+
+            boolean changesMade =
+                    settingsTemplateFile.updateValuesFromYaml(settingsFile, settingsTemplateFile);
+            if (changesMade) {
+                settingsTemplateFile.save(destPath);
+                log.info("Settings file updated based on template changes.");
+            } else {
+                log.info("No changes detected; settings file left as-is.");
+            }
+
+            Files.deleteIfExists(tempTemplatePath);
+            Files.deleteIfExists(settingTempPath);
         }
 
-        // Create custom settings file if it doesn't exist
-        Path customSettingsPath = Paths.get("configs", "custom_settings.yml");
-        if (!Files.exists(customSettingsPath)) {
+        // 3) Ensure custom settings file exists
+        Path customSettingsPath = Paths.get(InstallationPathConfig.getCustomSettingsPath());
+        if (Files.notExists(customSettingsPath)) {
             Files.createFile(customSettingsPath);
-        }
-    }
-
-    private void changeConfigItemFromCommentToKeyValue(
-            final YamlFile settingsTemplateFile,
-            final YamlFile settingsFile,
-            final YamlFile tempSettingFile,
-            String path) {
-        if (settingsFile.get(path) == null && settingsTemplateFile.get(path) != null) {
-            // If the key is only in the template, add it to the temporary settings with comments
-            tempSettingFile
-                    .path(path)
-                    .set(settingsTemplateFile.get(path))
-                    .comment(settingsTemplateFile.getComment(path, CommentType.BLOCK))
-                    .commentSide(settingsTemplateFile.getComment(path, CommentType.SIDE));
-        } else if (settingsFile.get(path) != null && settingsTemplateFile.get(path) != null) {
-            // If the key is in both, update the temporary settings with the main settings' value
-            // and comments
-            tempSettingFile
-                    .path(path)
-                    .set(settingsFile.get(path))
-                    .comment(settingsTemplateFile.getComment(path, CommentType.BLOCK))
-                    .commentSide(settingsTemplateFile.getComment(path, CommentType.SIDE));
-        } else {
-            // Log if the key is not found in both YAML files
-            log.info("Key not found in both YAML files: " + path);
+            log.info("Created custom_settings file: {}", customSettingsPath.toString());
         }
     }
 }

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

@@ -8,30 +8,24 @@ import java.util.concurrent.ConcurrentHashMap;
 import java.util.stream.Collectors;
 
 import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.beans.factory.annotation.Qualifier;
-import org.springframework.context.annotation.DependsOn;
 import org.springframework.stereotype.Service;
 
 import lombok.extern.slf4j.Slf4j;
+
 import stirling.software.SPDF.model.ApplicationProperties;
 
 @Service
 @Slf4j
-@DependsOn({"bookAndHtmlFormatsInstalled"})
 public class EndpointConfiguration {
 
     private static final String REMOVE_BLANKS = "remove-blanks";
     private final ApplicationProperties applicationProperties;
     private Map<String, Boolean> endpointStatuses = new ConcurrentHashMap<>();
     private Map<String, Set<String>> endpointGroups = new ConcurrentHashMap<>();
-    private boolean bookAndHtmlFormatsInstalled;
 
     @Autowired
-    public EndpointConfiguration(
-            ApplicationProperties applicationProperties,
-            @Qualifier("bookAndHtmlFormatsInstalled") boolean bookAndHtmlFormatsInstalled) {
+    public EndpointConfiguration(ApplicationProperties applicationProperties) {
         this.applicationProperties = applicationProperties;
-        this.bookAndHtmlFormatsInstalled = bookAndHtmlFormatsInstalled;
         init();
         processEnvironmentConfigs();
     }
@@ -125,6 +119,7 @@ public class EndpointConfiguration {
         addEndpointToGroup("Convert", "url-to-pdf");
         addEndpointToGroup("Convert", "markdown-to-pdf");
         addEndpointToGroup("Convert", "pdf-to-csv");
+        addEndpointToGroup("Convert", "pdf-to-markdown");
 
         // Adding endpoints to "Security" group
         addEndpointToGroup("Security", "add-password");
@@ -135,6 +130,7 @@ public class EndpointConfiguration {
         addEndpointToGroup("Security", "remove-cert-sign");
         addEndpointToGroup("Security", "sanitize-pdf");
         addEndpointToGroup("Security", "auto-redact");
+        addEndpointToGroup("Security", "redact");
 
         // Adding endpoints to "Other" group
         addEndpointToGroup("Other", "ocr-pdf");
@@ -180,7 +176,6 @@ public class EndpointConfiguration {
         addEndpointToGroup("Python", "extract-image-scans");
         addEndpointToGroup("Python", "html-to-pdf");
         addEndpointToGroup("Python", "url-to-pdf");
-        addEndpointToGroup("Python", "pdf-to-img");
         addEndpointToGroup("Python", "file-to-pdf");
 
         // openCV
@@ -195,8 +190,8 @@ public class EndpointConfiguration {
         addEndpointToGroup("LibreOffice", "pdf-to-html");
         addEndpointToGroup("LibreOffice", "pdf-to-xml");
 
-        // Unoconv
-        addEndpointToGroup("Unoconv", "file-to-pdf");
+        // Unoconvert
+        addEndpointToGroup("Unoconvert", "file-to-pdf");
 
         // qpdf
         addEndpointToGroup("qpdf", "compress-pdf");
@@ -234,6 +229,7 @@ public class EndpointConfiguration {
         addEndpointToGroup("Java", "markdown-to-pdf");
         addEndpointToGroup("Java", "show-javascript");
         addEndpointToGroup("Java", "auto-redact");
+        addEndpointToGroup("Java", "redact");
         addEndpointToGroup("Java", "pdf-to-csv");
         addEndpointToGroup("Java", "split-by-size-or-count");
         addEndpointToGroup("Java", "overlay-pdf");
@@ -241,6 +237,7 @@ public class EndpointConfiguration {
         addEndpointToGroup("Java", REMOVE_BLANKS);
         addEndpointToGroup("Java", "pdf-to-text");
         addEndpointToGroup("Java", "remove-image-pdf");
+        addEndpointToGroup("Java", "pdf-to-markdown");
 
         // Javascript
         addEndpointToGroup("Javascript", "pdf-organizer");
@@ -256,29 +253,28 @@ public class EndpointConfiguration {
         // Weasyprint dependent endpoints
         addEndpointToGroup("Weasyprint", "html-to-pdf");
         addEndpointToGroup("Weasyprint", "url-to-pdf");
+        addEndpointToGroup("Weasyprint", "markdown-to-pdf");
 
         // Pdftohtml dependent endpoints
         addEndpointToGroup("Pdftohtml", "pdf-to-html");
-
-        // disabled for now while we resolve issues
-        disableEndpoint("pdf-to-pdfa");
+        addEndpointToGroup("Pdftohtml", "pdf-to-markdown");
     }
 
     private void processEnvironmentConfigs() {
-        List<String> endpointsToRemove = applicationProperties.getEndpoints().getToRemove();
-        List<String> groupsToRemove = applicationProperties.getEndpoints().getGroupsToRemove();
-        if (!bookAndHtmlFormatsInstalled) {
-            groupsToRemove.add("Calibre");
-        }
-        if (endpointsToRemove != null) {
-            for (String endpoint : endpointsToRemove) {
-                disableEndpoint(endpoint.trim());
-            }
-        }
+        if (applicationProperties != null && applicationProperties.getEndpoints() != null) {
+            List<String> endpointsToRemove = applicationProperties.getEndpoints().getToRemove();
+            List<String> groupsToRemove = applicationProperties.getEndpoints().getGroupsToRemove();
 
-        if (groupsToRemove != null) {
-            for (String group : groupsToRemove) {
-                disableGroup(group.trim());
+            if (endpointsToRemove != null) {
+                for (String endpoint : endpointsToRemove) {
+                    disableEndpoint(endpoint.trim());
+                }
+            }
+
+            if (groupsToRemove != null) {
+                for (String group : groupsToRemove) {
+                    disableGroup(group.trim());
+                }
             }
         }
     }

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

@@ -9,6 +9,7 @@ import java.util.stream.Collectors;
 import org.springframework.context.annotation.Configuration;
 
 import jakarta.annotation.PostConstruct;
+
 import lombok.extern.slf4j.Slf4j;
 
 @Configuration
@@ -16,21 +17,29 @@ import lombok.extern.slf4j.Slf4j;
 public class ExternalAppDepConfig {
 
     private final EndpointConfiguration endpointConfiguration;
-    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 final String weasyprintPath;
+    private final String unoconvPath;
+    private final Map<String, List<String>> commandToGroupMapping;
 
-    public ExternalAppDepConfig(EndpointConfiguration endpointConfiguration) {
+    public ExternalAppDepConfig(
+            EndpointConfiguration endpointConfiguration, RuntimePathConfig runtimePathConfig) {
         this.endpointConfiguration = endpointConfiguration;
+        weasyprintPath = runtimePathConfig.getWeasyPrintPath();
+        unoconvPath = runtimePathConfig.getUnoConvertPath();
+
+        commandToGroupMapping =
+                new HashMap<>() {
+
+                    {
+                        put("soffice", List.of("LibreOffice"));
+                        put(weasyprintPath, List.of("Weasyprint"));
+                        put("pdftohtml", List.of("Pdftohtml"));
+                        put(unoconvPath, List.of("Unoconvert"));
+                        put("qpdf", List.of("qpdf"));
+                        put("tesseract", List.of("tesseract"));
+                    }
+                };
     }
 
     private boolean isCommandAvailable(String command) {
@@ -101,9 +110,9 @@ public class ExternalAppDepConfig {
         checkDependencyAndDisableGroup("tesseract");
         checkDependencyAndDisableGroup("soffice");
         checkDependencyAndDisableGroup("qpdf");
-        checkDependencyAndDisableGroup("weasyprint");
+        checkDependencyAndDisableGroup(weasyprintPath);
         checkDependencyAndDisableGroup("pdftohtml");
-        checkDependencyAndDisableGroup("unoconv");
+        checkDependencyAndDisableGroup(unoconvPath);
         // Special handling for Python/OpenCV dependencies
         boolean pythonAvailable = isCommandAvailable("python3") || isCommandAvailable("python");
         if (!pythonAvailable) {

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

@@ -33,7 +33,8 @@ public class FileFallbackTemplateResolver extends AbstractConfigurableTemplateRe
             String characterEncoding,
             Map<String, Object> templateResolutionAttributes) {
         Resource resource =
-                resourceLoader.getResource("file:./customFiles/templates/" + resourceName);
+                resourceLoader.getResource(
+                        "file:" + InstallationPathConfig.getTemplatesPath() + resourceName);
         try {
             if (resource.exists() && resource.isReadable()) {
                 return new FileTemplateResource(resource.getFile().getPath(), characterEncoding);

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

@@ -13,7 +13,9 @@ 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;
 
@@ -42,7 +44,7 @@ public class InitialSetup {
         if (!GeneralUtils.isValidUUID(uuid)) {
             // Generating a random UUID as the secret key
             uuid = UUID.randomUUID().toString();
-            GeneralUtils.saveKeyToConfig("AutomaticallyGenerated.UUID", uuid);
+            GeneralUtils.saveKeyToSettings("AutomaticallyGenerated.UUID", uuid);
             applicationProperties.getAutomaticallyGenerated().setUUID(uuid);
         }
     }
@@ -52,7 +54,7 @@ public class InitialSetup {
         if (!GeneralUtils.isValidUUID(secretKey)) {
             // Generating a random UUID as the secret key
             secretKey = UUID.randomUUID().toString();
-            GeneralUtils.saveKeyToConfig("AutomaticallyGenerated.key", secretKey);
+            GeneralUtils.saveKeyToSettings("AutomaticallyGenerated.key", secretKey);
             applicationProperties.getAutomaticallyGenerated().setKey(secretKey);
         }
     }
@@ -62,8 +64,8 @@ public class InitialSetup {
                 "0.36.0", applicationProperties.getAutomaticallyGenerated().getAppVersion())) {
             Boolean csrf = applicationProperties.getSecurity().getCsrfDisabled();
             if (!csrf) {
-                GeneralUtils.saveKeyToConfig("security.csrfDisabled", false, false);
-                GeneralUtils.saveKeyToConfig("system.enableAnalytics", "true", false);
+                GeneralUtils.saveKeyToSettings("security.csrfDisabled", false);
+                GeneralUtils.saveKeyToSettings("system.enableAnalytics", true);
                 applicationProperties.getSecurity().setCsrfDisabled(false);
             }
         }
@@ -74,14 +76,14 @@ public class InitialSetup {
         String termsUrl = applicationProperties.getLegal().getTermsAndConditions();
         if (StringUtils.isEmpty(termsUrl)) {
             String defaultTermsUrl = "https://www.stirlingpdf.com/terms-and-conditions";
-            GeneralUtils.saveKeyToConfig("legal.termsAndConditions", defaultTermsUrl, false);
+            GeneralUtils.saveKeyToSettings("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, false);
+            GeneralUtils.saveKeyToSettings("legal.privacyPolicy", defaultPrivacyUrl);
             applicationProperties.getLegal().setPrivacyPolicy(defaultPrivacyUrl);
         }
     }
@@ -95,7 +97,7 @@ public class InitialSetup {
             appVersion = props.getProperty("version");
         } catch (Exception e) {
         }
+        GeneralUtils.saveKeyToSettings("AutomaticallyGenerated.appVersion", appVersion);
         applicationProperties.getAutomaticallyGenerated().setAppVersion(appVersion);
-        GeneralUtils.saveKeyToConfig("AutomaticallyGenerated.appVersion", appVersion, false);
     }
 }

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

@@ -0,0 +1,114 @@
+package stirling.software.SPDF.config;
+
+import java.io.File;
+import java.nio.file.Paths;
+
+import lombok.extern.slf4j.Slf4j;
+
+@Slf4j
+public class InstallationPathConfig {
+    private static final String BASE_PATH;
+
+    // Root paths
+    private static final String LOG_PATH;
+    private static final String CONFIG_PATH;
+    private static final String CUSTOM_FILES_PATH;
+    private static final String CLIENT_WEBUI_PATH;
+
+    // Config paths
+    private static final String SETTINGS_PATH;
+    private static final String CUSTOM_SETTINGS_PATH;
+
+    // Custom file paths
+    private static final String STATIC_PATH;
+    private static final String TEMPLATES_PATH;
+    private static final String SIGNATURES_PATH;
+
+    static {
+        BASE_PATH = initializeBasePath();
+
+        // Initialize root paths
+        LOG_PATH = BASE_PATH + "logs" + File.separator;
+        CONFIG_PATH = BASE_PATH + "configs" + File.separator;
+        CUSTOM_FILES_PATH = BASE_PATH + "customFiles" + File.separator;
+        CLIENT_WEBUI_PATH = BASE_PATH + "clientWebUI" + File.separator;
+
+        // Initialize config paths
+        SETTINGS_PATH = CONFIG_PATH + "settings.yml";
+        CUSTOM_SETTINGS_PATH = CONFIG_PATH + "custom_settings.yml";
+
+        // Initialize custom file paths
+        STATIC_PATH = CUSTOM_FILES_PATH + "static" + File.separator;
+        TEMPLATES_PATH = CUSTOM_FILES_PATH + "templates" + File.separator;
+        SIGNATURES_PATH = CUSTOM_FILES_PATH + "signatures" + File.separator;
+    }
+
+    private static String initializeBasePath() {
+        if (Boolean.parseBoolean(System.getProperty("STIRLING_PDF_DESKTOP_UI", "false"))) {
+            String os = System.getProperty("os.name").toLowerCase();
+            if (os.contains("win")) {
+                return Paths.get(
+                                        System.getenv("APPDATA"), // parent path
+                                        "Stirling-PDF")
+                                .toString()
+                        + File.separator;
+            } else if (os.contains("mac")) {
+                return Paths.get(
+                                        System.getProperty("user.home"),
+                                        "Library",
+                                        "Application Support",
+                                        "Stirling-PDF")
+                                .toString()
+                        + File.separator;
+            } else {
+                return Paths.get(
+                                        System.getProperty("user.home"), // parent path
+                                        ".config",
+                                        "Stirling-PDF")
+                                .toString()
+                        + File.separator;
+            }
+        }
+        return "." + File.separator;
+    }
+
+    public static String getPath() {
+        return BASE_PATH;
+    }
+
+    public static String getLogPath() {
+        return LOG_PATH;
+    }
+
+    public static String getConfigPath() {
+        return CONFIG_PATH;
+    }
+
+    public static String getCustomFilesPath() {
+        return CUSTOM_FILES_PATH;
+    }
+
+    public static String getClientWebUIPath() {
+        return CLIENT_WEBUI_PATH;
+    }
+
+    public static String getSettingsPath() {
+        return SETTINGS_PATH;
+    }
+
+    public static String getCustomSettingsPath() {
+        return CUSTOM_SETTINGS_PATH;
+    }
+
+    public static String getStaticPath() {
+        return STATIC_PATH;
+    }
+
+    public static String getTemplatesPath() {
+        return TEMPLATES_PATH;
+    }
+
+    public static String getSignaturesPath() {
+        return SIGNATURES_PATH;
+    }
+}

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

@@ -0,0 +1,10 @@
+package stirling.software.SPDF.config;
+
+import ch.qos.logback.core.PropertyDefinerBase;
+
+public class LogbackPropertyLoader extends PropertyDefinerBase {
+    @Override
+    public String getPropertyValue() {
+        return InstallationPathConfig.getLogPath();
+    }
+}

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

@@ -14,6 +14,7 @@ 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

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

@@ -8,7 +8,10 @@ import com.posthog.java.PostHog;
 
 import jakarta.annotation.PreDestroy;
 
+import lombok.extern.slf4j.Slf4j;
+
 @Configuration
+@Slf4j
 public class PostHogConfig {
 
     @Value("${posthog.api.key}")
@@ -21,7 +24,11 @@ public class PostHogConfig {
 
     @Bean
     public PostHog postHogClient() {
-        postHogClient = new PostHog.Builder(posthogApiKey).host(posthogHost).build();
+        postHogClient =
+                new PostHog.Builder(posthogApiKey)
+                        .host(posthogHost)
+                        .logger(new PostHogLoggerImpl())
+                        .build();
         return postHogClient;
     }
 

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

@@ -0,0 +1,42 @@
+package stirling.software.SPDF.config;
+
+import org.springframework.stereotype.Component;
+
+import com.posthog.java.PostHogLogger;
+
+import lombok.extern.slf4j.Slf4j;
+
+@Slf4j
+@Component
+public class PostHogLoggerImpl implements PostHogLogger {
+
+    @Override
+    public void debug(String message) {
+        log.debug(message);
+    }
+
+    @Override
+    public void info(String message) {
+        log.info(message);
+    }
+
+    @Override
+    public void warn(String message) {
+        log.warn(message);
+    }
+
+    @Override
+    public void error(String message) {
+        log.error(message);
+    }
+
+    @Override
+    public void error(String message, Throwable throwable) {
+        if (message.contains("Error sending events to PostHog")) {
+            log.warn(
+                    "Error sending metrics, Likely caused by no internet connection. Non Blocking");
+        } else {
+            log.error(message, throwable);
+        }
+    }
+}

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

@@ -0,0 +1,79 @@
+package stirling.software.SPDF.config;
+
+import java.nio.file.Files;
+import java.nio.file.Path;
+
+import org.apache.commons.lang3.StringUtils;
+import org.springframework.context.annotation.Configuration;
+
+import lombok.Getter;
+import lombok.extern.slf4j.Slf4j;
+
+import stirling.software.SPDF.model.ApplicationProperties;
+import stirling.software.SPDF.model.ApplicationProperties.CustomPaths.Operations;
+import stirling.software.SPDF.model.ApplicationProperties.CustomPaths.Pipeline;
+
+@Slf4j
+@Configuration
+@Getter
+public class RuntimePathConfig {
+    private final ApplicationProperties properties;
+    private final String basePath;
+    private final String weasyPrintPath;
+    private final String unoConvertPath;
+
+    // Pipeline paths
+    private final String pipelineWatchedFoldersPath;
+    private final String pipelineFinishedFoldersPath;
+    private final String pipelineDefaultWebUiConfigs;
+    private final String pipelinePath;
+
+    public RuntimePathConfig(ApplicationProperties properties) {
+        this.properties = properties;
+        this.basePath = InstallationPathConfig.getPath();
+
+        this.pipelinePath = Path.of(basePath, "pipeline").toString();
+        String defaultWatchedFolders = Path.of(this.pipelinePath, "watchedFolders").toString();
+        String defaultFinishedFolders = Path.of(this.pipelinePath, "finishedFolders").toString();
+        String defaultWebUIConfigs = Path.of(this.pipelinePath, "defaultWebUIConfigs").toString();
+
+        Pipeline pipeline = properties.getSystem().getCustomPaths().getPipeline();
+
+        this.pipelineWatchedFoldersPath =
+                resolvePath(
+                        defaultWatchedFolders,
+                        pipeline != null ? pipeline.getWatchedFoldersDir() : null);
+        this.pipelineFinishedFoldersPath =
+                resolvePath(
+                        defaultFinishedFolders,
+                        pipeline != null ? pipeline.getFinishedFoldersDir() : null);
+        this.pipelineDefaultWebUiConfigs =
+                resolvePath(
+                        defaultWebUIConfigs,
+                        pipeline != null ? pipeline.getWebUIConfigsDir() : null);
+
+        boolean isDocker = isRunningInDocker();
+
+        // Initialize Operation paths
+        String defaultWeasyPrintPath = isDocker ? "/opt/venv/bin/weasyprint" : "weasyprint";
+        String defaultUnoConvertPath = isDocker ? "/opt/venv/bin/unoconvert" : "unoconvert";
+
+        Operations operations = properties.getSystem().getCustomPaths().getOperations();
+        this.weasyPrintPath =
+                resolvePath(
+                        defaultWeasyPrintPath,
+                        operations != null ? operations.getWeasyprint() : null);
+        this.unoConvertPath =
+                resolvePath(
+                        defaultUnoConvertPath,
+                        operations != null ? operations.getUnoconvert() : null);
+    }
+
+    private String resolvePath(String defaultPath, String customPath) {
+        return StringUtils.isNotBlank(customPath) ? customPath : defaultPath;
+    }
+
+    private boolean isRunningInDocker() {
+        return Files.exists(Path.of("/.dockerenv"));
+    }
+}

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

@@ -23,7 +23,8 @@ public class WebMvcConfig implements WebMvcConfigurer {
     public void addResourceHandlers(ResourceHandlerRegistry registry) {
         // Handler for external static resources
         registry.addResourceHandler("/**")
-                .addResourceLocations("file:customFiles/static/", "classpath:/static/");
+                .addResourceLocations(
+                        "file:" + InstallationPathConfig.getStaticPath(), "classpath:/static/");
         // .setCachePeriod(0); // Optional: disable caching
     }
 }

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

@@ -0,0 +1,479 @@
+package stirling.software.SPDF.config;
+
+import java.io.IOException;
+import java.io.StringWriter;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.util.ArrayDeque;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Deque;
+import java.util.LinkedHashSet;
+import java.util.List;
+import java.util.Optional;
+import java.util.Set;
+import java.util.function.Function;
+
+import org.snakeyaml.engine.v2.api.Dump;
+import org.snakeyaml.engine.v2.api.DumpSettings;
+import org.snakeyaml.engine.v2.api.LoadSettings;
+import org.snakeyaml.engine.v2.api.StreamDataWriter;
+import org.snakeyaml.engine.v2.common.FlowStyle;
+import org.snakeyaml.engine.v2.common.ScalarStyle;
+import org.snakeyaml.engine.v2.composer.Composer;
+import org.snakeyaml.engine.v2.nodes.MappingNode;
+import org.snakeyaml.engine.v2.nodes.Node;
+import org.snakeyaml.engine.v2.nodes.NodeTuple;
+import org.snakeyaml.engine.v2.nodes.ScalarNode;
+import org.snakeyaml.engine.v2.nodes.SequenceNode;
+import org.snakeyaml.engine.v2.nodes.Tag;
+import org.snakeyaml.engine.v2.parser.ParserImpl;
+import org.snakeyaml.engine.v2.scanner.StreamReader;
+
+import lombok.extern.slf4j.Slf4j;
+
+@Slf4j
+public class YamlHelper {
+
+    // YAML dump settings with comment support and block flow style
+    private static final DumpSettings DUMP_SETTINGS =
+            DumpSettings.builder()
+                    .setDumpComments(true)
+                    .setWidth(Integer.MAX_VALUE)
+                    .setDefaultFlowStyle(FlowStyle.BLOCK)
+                    .build();
+
+    private final String yamlContent; // Stores the entire YAML content as a string
+
+    private LoadSettings loadSettings =
+            LoadSettings.builder()
+                    .setUseMarks(true)
+                    .setMaxAliasesForCollections(Integer.MAX_VALUE)
+                    .setAllowRecursiveKeys(true)
+                    .setParseComments(true)
+                    .build();
+
+    private Path originalFilePath;
+    private Node updatedRootNode;
+
+    // Constructor with custom LoadSettings and YAML string
+    public YamlHelper(LoadSettings loadSettings, String yamlContent) {
+        this.loadSettings = loadSettings;
+        this.yamlContent = yamlContent;
+    }
+
+    // Constructor that reads YAML from a file path
+    public YamlHelper(Path originalFilePath) throws IOException {
+        this.yamlContent = Files.readString(originalFilePath);
+        this.originalFilePath = originalFilePath;
+    }
+
+    /**
+     * Updates values in the target YAML based on values from the source YAML. It ensures that only
+     * existing keys in the target YAML are updated.
+     *
+     * @return true if at least one key was updated, false otherwise.
+     */
+    public boolean updateValuesFromYaml(YamlHelper sourceYaml, YamlHelper targetYaml) {
+        boolean updated = false;
+        Set<String> sourceKeys = sourceYaml.getAllKeys();
+        Set<String> targetKeys = targetYaml.getAllKeys();
+
+        for (String key : sourceKeys) {
+            String[] keyArray = key.split("\\.");
+
+            Object newValue = sourceYaml.getValueByExactKeyPath(keyArray);
+            Object currentValue = targetYaml.getValueByExactKeyPath(keyArray);
+            if (newValue != null
+                    && (!newValue.equals(currentValue) || !sourceKeys.equals(targetKeys))) {
+                boolean updatedKey = targetYaml.updateValue(Arrays.asList(keyArray), newValue);
+                if (updatedKey) updated = true;
+            }
+        }
+
+        return updated;
+    }
+
+    /**
+     * Updates a value in the YAML structure.
+     *
+     * @param keys The hierarchical keys leading to the value.
+     * @param newValue The new value to set.
+     * @return true if the value was updated, false otherwise.
+     */
+    public boolean updateValue(List<String> keys, Object newValue) {
+        return updateValue(getRootNode(), keys, newValue);
+    }
+
+    private boolean updateValue(Node node, List<String> keys, Object newValue) {
+        if (!(node instanceof MappingNode mappingNode)) return false;
+
+        List<NodeTuple> updatedTuples = new ArrayList<>();
+        boolean updated = false;
+
+        for (NodeTuple tuple : mappingNode.getValue()) {
+            ScalarNode keyNode = (tuple.getKeyNode() instanceof ScalarNode sk) ? sk : null;
+            if (keyNode == null || !keyNode.getValue().equals(keys.get(0))) {
+                updatedTuples.add(tuple);
+                continue;
+            }
+
+            Node valueNode = tuple.getValueNode();
+
+            if (keys.size() == 1) {
+                Tag tag = valueNode.getTag();
+                Node newValueNode = null;
+
+                if (isAnyInteger(newValue)) {
+                    newValueNode =
+                            new ScalarNode(Tag.INT, String.valueOf(newValue), ScalarStyle.PLAIN);
+                } else if (isFloat(newValue)) {
+                    Object floatValue = Float.valueOf(String.valueOf(newValue));
+                    newValueNode =
+                            new ScalarNode(
+                                    Tag.FLOAT, String.valueOf(floatValue), ScalarStyle.PLAIN);
+                } else if ("true".equals(newValue) || "false".equals(newValue)) {
+                    newValueNode =
+                            new ScalarNode(Tag.BOOL, String.valueOf(newValue), ScalarStyle.PLAIN);
+                } else if (newValue instanceof List<?> list) {
+                    List<Node> sequenceNodes = new ArrayList<>();
+                    for (Object item : list) {
+                        Object obj = String.valueOf(item);
+                        if (isAnyInteger(item)) {
+                            tag = Tag.INT;
+                        } else if (isFloat(item)) {
+                            obj = Float.valueOf(String.valueOf(item));
+                            tag = Tag.FLOAT;
+                        } else if ("true".equals(item) || "false".equals(item)) {
+                            tag = Tag.BOOL;
+                        } else if (item == null || "null".equals(item)) {
+                            tag = Tag.NULL;
+                        } else {
+                            tag = Tag.STR;
+                        }
+                        sequenceNodes.add(
+                                new ScalarNode(tag, String.valueOf(obj), ScalarStyle.PLAIN));
+                    }
+                    newValueNode = new SequenceNode(Tag.SEQ, sequenceNodes, FlowStyle.FLOW);
+                } else if (tag == Tag.NULL) {
+                    if ("true".equals(newValue)
+                            || "false".equals(newValue)
+                            || newValue instanceof Boolean) {
+                        tag = Tag.BOOL;
+                    }
+                    newValueNode = new ScalarNode(tag, String.valueOf(newValue), ScalarStyle.PLAIN);
+                } else {
+                    newValueNode = new ScalarNode(tag, String.valueOf(newValue), ScalarStyle.PLAIN);
+                }
+                copyComments(valueNode, newValueNode);
+
+                updatedTuples.add(new NodeTuple(keyNode, newValueNode));
+                updated = true;
+            } else if (valueNode instanceof MappingNode) {
+                updated = updateValue(valueNode, keys.subList(1, keys.size()), newValue);
+                updatedTuples.add(tuple);
+            }
+        }
+
+        if (updated) {
+            mappingNode.getValue().clear();
+            mappingNode.getValue().addAll(updatedTuples);
+        }
+        setNewNode(node);
+
+        return updated;
+    }
+
+    /**
+     * Fetches a value based on an exact key path.
+     *
+     * @param keys The key hierarchy leading to the value.
+     * @return The value if found, otherwise null.
+     */
+    public Object getValueByExactKeyPath(String... keys) {
+        return getValueByExactKeyPath(getRootNode(), new ArrayDeque<>(List.of(keys)));
+    }
+
+    private Object getValueByExactKeyPath(Node node, Deque<String> keyQueue) {
+        if (!(node instanceof MappingNode mappingNode)) return null;
+
+        String currentKey = keyQueue.poll();
+        if (currentKey == null) return null;
+
+        for (NodeTuple tuple : mappingNode.getValue()) {
+            if (tuple.getKeyNode() instanceof ScalarNode keyNode
+                    && keyNode.getValue().equals(currentKey)) {
+                if (keyQueue.isEmpty()) {
+                    Node valueNode = tuple.getValueNode();
+
+                    if (valueNode instanceof ScalarNode scalarValueNode) {
+                        return scalarValueNode.getValue();
+                    } else if (valueNode instanceof MappingNode subMapping) {
+                        return getValueByExactKeyPath(subMapping, keyQueue);
+                    } else if (valueNode instanceof SequenceNode sequenceNode) {
+                        List<Object> valuesList = new ArrayList<>();
+                        for (Node o : sequenceNode.getValue()) {
+                            if (o instanceof ScalarNode scalarValue) {
+                                valuesList.add(scalarValue.getValue());
+                            }
+                        }
+                        return valuesList;
+                    } else {
+                        return null;
+                    }
+                }
+                return getValueByExactKeyPath(tuple.getValueNode(), keyQueue);
+            }
+        }
+        return null;
+    }
+
+    private Set<String> cachedKeys;
+
+    /**
+     * Retrieves the set of all keys present in the YAML structure. Keys are returned as
+     * dot-separated paths for nested keys.
+     *
+     * @return A set containing all keys in dot notation.
+     */
+    public Set<String> getAllKeys() {
+        if (cachedKeys == null) {
+            cachedKeys = getAllKeys(getRootNode());
+        }
+        return cachedKeys;
+    }
+
+    /**
+     * Collects all keys from the YAML node recursively.
+     *
+     * @param node The current YAML node.
+     * @param currentPath The accumulated path of keys.
+     * @param allKeys The set storing all collected keys.
+     */
+    private Set<String> getAllKeys(Node node) {
+        Set<String> allKeys = new LinkedHashSet<>();
+        collectKeys(node, "", allKeys);
+        return allKeys;
+    }
+
+    /**
+     * Recursively traverses the YAML structure to collect all keys.
+     *
+     * @param node The current node in the YAML structure.
+     * @param currentPath The accumulated key path.
+     * @param allKeys The set storing collected keys.
+     */
+    private void collectKeys(Node node, String currentPath, Set<String> allKeys) {
+        if (node instanceof MappingNode mappingNode) {
+            for (NodeTuple tuple : mappingNode.getValue()) {
+                if (tuple.getKeyNode() instanceof ScalarNode keyNode) {
+                    String newPath =
+                            currentPath.isEmpty()
+                                    ? keyNode.getValue()
+                                    : currentPath + "." + keyNode.getValue();
+                    allKeys.add(newPath);
+                    collectKeys(tuple.getValueNode(), newPath, allKeys);
+                }
+            }
+        }
+    }
+
+    /**
+     * Retrieves the root node of the YAML document. If a new node was previously set, it is
+     * returned instead.
+     *
+     * @return The root node of the YAML structure.
+     */
+    private Node getRootNode() {
+        if (this.updatedRootNode != null) {
+            return this.updatedRootNode;
+        }
+        Composer composer = new Composer(loadSettings, getParserImpl());
+        Optional<Node> rootNodeOpt = composer.getSingleNode();
+        if (rootNodeOpt.isPresent()) {
+            return rootNodeOpt.get();
+        }
+        return null;
+    }
+
+    /**
+     * Sets a new root node, allowing modifications to be tracked.
+     *
+     * @param newRootNode The modified root node.
+     */
+    public void setNewNode(Node newRootNode) {
+        this.updatedRootNode = newRootNode;
+    }
+
+    /**
+     * Retrieves the current root node (either the original or the updated one).
+     *
+     * @return The root node.
+     */
+    public Node getUpdatedRootNode() {
+        if (this.updatedRootNode == null) {
+            this.updatedRootNode = getRootNode();
+        }
+        return this.updatedRootNode;
+    }
+
+    /**
+     * Initializes the YAML parser.
+     *
+     * @return The configured parser.
+     */
+    private ParserImpl getParserImpl() {
+        return new ParserImpl(loadSettings, getStreamReader());
+    }
+
+    /**
+     * Creates a stream reader for the YAML content.
+     *
+     * @return The configured stream reader.
+     */
+    private StreamReader getStreamReader() {
+        return new StreamReader(loadSettings, yamlContent);
+    }
+
+    public MappingNode save(Path saveFilePath) throws IOException {
+        if (!saveFilePath.equals(originalFilePath)) {
+            Files.writeString(saveFilePath, convertNodeToYaml(getUpdatedRootNode()));
+        }
+        return (MappingNode) getUpdatedRootNode();
+    }
+
+    public void saveOverride(Path saveFilePath) throws IOException {
+        Files.writeString(saveFilePath, convertNodeToYaml(getUpdatedRootNode()));
+    }
+
+    /**
+     * Converts a YAML node back to a YAML-formatted string.
+     *
+     * @param rootNode The root node to be converted.
+     * @return A YAML-formatted string.
+     */
+    public String convertNodeToYaml(Node rootNode) {
+        StringWriter writer = new StringWriter();
+        StreamDataWriter streamDataWriter =
+                new StreamDataWriter() {
+                    @Override
+                    public void write(String str) {
+                        writer.write(str);
+                    }
+
+                    @Override
+                    public void write(String str, int off, int len) {
+                        writer.write(str, off, len);
+                    }
+                };
+
+        new Dump(DUMP_SETTINGS).dumpNode(rootNode, streamDataWriter);
+        return writer.toString();
+    }
+
+    private static boolean isParsable(String value, Function<String, ?> parser) {
+        try {
+            parser.apply(value);
+            return true;
+        } catch (NumberFormatException e) {
+            return false;
+        }
+    }
+
+    /**
+     * Checks if a given object is an integer.
+     *
+     * @param object The object to check.
+     * @return True if the object represents an integer, false otherwise.
+     */
+    @SuppressWarnings("UnnecessaryTemporaryOnConversionFromString")
+    public static boolean isInteger(Object object) {
+        if (object instanceof Integer
+                || object instanceof Short
+                || object instanceof Byte
+                || object instanceof Long) {
+            return true;
+        }
+        if (object instanceof String str) {
+            return isParsable(str, Integer::parseInt);
+        }
+        return false;
+    }
+
+    /**
+     * Checks if a given object is a floating-point number.
+     *
+     * @param object The object to check.
+     * @return True if the object represents a float, false otherwise.
+     */
+    @SuppressWarnings("UnnecessaryTemporaryOnConversionFromString")
+    public static boolean isFloat(Object object) {
+        return (object instanceof Float || object instanceof Double)
+                || (object instanceof String str && isParsable(str, Float::parseFloat));
+    }
+
+    /**
+     * Checks if a given object is a short integer.
+     *
+     * @param object The object to check.
+     * @return True if the object represents a short integer, false otherwise.
+     */
+    @SuppressWarnings("UnnecessaryTemporaryOnConversionFromString")
+    public static boolean isShort(Object object) {
+        return (object instanceof Long)
+                || (object instanceof String str && isParsable(str, Short::parseShort));
+    }
+
+    /**
+     * Checks if a given object is a byte.
+     *
+     * @param object The object to check.
+     * @return True if the object represents a byte, false otherwise.
+     */
+    @SuppressWarnings("UnnecessaryTemporaryOnConversionFromString")
+    public static boolean isByte(Object object) {
+        return (object instanceof Long)
+                || (object instanceof String str && isParsable(str, Byte::parseByte));
+    }
+
+    /**
+     * Checks if a given object is a long integer.
+     *
+     * @param object The object to check.
+     * @return True if the object represents a long integer, false otherwise.
+     */
+    @SuppressWarnings("UnnecessaryTemporaryOnConversionFromString")
+    public static boolean isLong(Object object) {
+        return (object instanceof Long)
+                || (object instanceof String str && isParsable(str, Long::parseLong));
+    }
+
+    /**
+     * Determines if an object is any type of integer (short, byte, long, or int).
+     *
+     * @param object The object to check.
+     * @return True if the object represents an integer type, false otherwise.
+     */
+    public static boolean isAnyInteger(Object object) {
+        return isInteger(object) || isShort(object) || isByte(object) || isLong(object);
+    }
+
+    /**
+     * Copies comments from an old node to a new one.
+     *
+     * @param oldNode The original node with comments.
+     * @param newValueNode The new node to which comments should be copied.
+     */
+    private void copyComments(Node oldNode, Node newValueNode) {
+        if (oldNode == null || newValueNode == null) return;
+        if (oldNode.getBlockComments() != null) {
+            newValueNode.setBlockComments(oldNode.getBlockComments());
+        }
+        if (oldNode.getInLineComments() != null) {
+            newValueNode.setInLineComments(oldNode.getInLineComments());
+        }
+        if (oldNode.getEndComments() != null) {
+            newValueNode.setEndComments(oldNode.getEndComments());
+        }
+    }
+}

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

@@ -16,7 +16,6 @@ public class YamlPropertySourceFactory implements PropertySourceFactory {
             throws IOException {
         YamlPropertiesFactoryBean factory = new YamlPropertiesFactoryBean();
         factory.setResources(encodedResource.getResource());
-
         Properties properties = factory.getObject();
 
         return new PropertiesPropertySource(

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

@@ -1,17 +0,0 @@
-package stirling.software.SPDF.config.interfaces;
-
-import java.io.IOException;
-import java.util.List;
-
-import stirling.software.SPDF.utils.FileInfo;
-
-public interface DatabaseBackupInterface {
-
-    void exportDatabase() throws IOException;
-
-    boolean importDatabase();
-
-    boolean hasBackup();
-
-    List<FileInfo> getBackupList();
-}

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

@@ -0,0 +1,17 @@
+package stirling.software.SPDF.config.interfaces;
+
+import java.sql.SQLException;
+import java.util.List;
+
+import stirling.software.SPDF.model.exception.UnsupportedProviderException;
+import stirling.software.SPDF.utils.FileInfo;
+
+public interface DatabaseInterface {
+    void exportDatabase() throws SQLException, UnsupportedProviderException;
+
+    void importDatabase();
+
+    boolean hasBackup();
+
+    List<FileInfo> getBackupList();
+}

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

@@ -14,7 +14,9 @@ import org.springframework.security.web.authentication.SimpleUrlAuthenticationFa
 import jakarta.servlet.ServletException;
 import jakarta.servlet.http.HttpServletRequest;
 import jakarta.servlet.http.HttpServletResponse;
+
 import lombok.extern.slf4j.Slf4j;
+
 import stirling.software.SPDF.model.User;
 
 @Slf4j
@@ -67,7 +69,7 @@ public class CustomAuthenticationFailureHandler extends SimpleUrlAuthenticationF
         }
         if (exception instanceof BadCredentialsException
                 || exception instanceof UsernameNotFoundException) {
-            getRedirectStrategy().sendRedirect(request, response, "/login?error=badcredentials");
+            getRedirectStrategy().sendRedirect(request, response, "/login?error=badCredentials");
             return;
         }
         if (exception instanceof InternalAuthenticationServiceException

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

@@ -10,7 +10,9 @@ 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;
 
 @Slf4j

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

@@ -14,91 +14,75 @@ import org.springframework.security.saml2.provider.service.authentication.Saml2A
 import org.springframework.security.web.authentication.logout.SimpleUrlLogoutSuccessHandler;
 
 import com.coveo.saml.SamlClient;
+import com.coveo.saml.SamlException;
 
-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.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.model.provider.KeycloakProvider;
 import stirling.software.SPDF.utils.UrlUtils;
 
 @Slf4j
 @AllArgsConstructor
 public class CustomLogoutSuccessHandler extends SimpleUrlLogoutSuccessHandler {
 
+    public static final String LOGOUT_PATH = "/login?logout=true";
+
     private final ApplicationProperties applicationProperties;
 
     @Override
     public void onLogoutSuccess(
             HttpServletRequest request, HttpServletResponse response, Authentication authentication)
-            throws IOException, ServletException {
-
+            throws IOException {
         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 {
+                if (authentication instanceof Saml2Authentication samlAuthentication) {
+                    // Handle SAML2 logout redirection
+                    getRedirect_saml2(request, response, samlAuthentication);
+                } else if (authentication instanceof OAuth2AuthenticationToken oAuthToken) {
+                    // Handle OAuth2 logout redirection
+                    getRedirect_oauth2(request, response, oAuthToken);
+                } else if (authentication instanceof UsernamePasswordAuthenticationToken) {
+                    // Handle Username/Password logout
+                    getRedirectStrategy().sendRedirect(request, response, LOGOUT_PATH);
+                } else {
+                    // Handle unknown authentication types
                     log.error(
-                            "authentication class unknown: "
-                                    + authentication.getClass().getSimpleName());
-                    getRedirectStrategy().sendRedirect(request, response, "/login?logout=true");
-                    return;
+                            "Authentication class unknown: {}",
+                            authentication.getClass().getSimpleName());
+                    getRedirectStrategy().sendRedirect(request, response, LOGOUT_PATH);
                 }
             } else {
                 // Redirect to login page after logout
-                getRedirectStrategy().sendRedirect(request, response, "/login?logout=true");
-                return;
+                String path = checkForErrors(request);
+                getRedirectStrategy().sendRedirect(request, response, path);
             }
         }
     }
 
     // Redirect for SAML2 authentication logout
     private void getRedirect_saml2(
-            HttpServletRequest request, HttpServletResponse response, Authentication authentication)
+            HttpServletRequest request,
+            HttpServletResponse response,
+            Saml2Authentication samlAuthentication)
             throws IOException {
 
         SAML2 samlConf = applicationProperties.getSecurity().getSaml2();
         String registrationId = samlConf.getRegistrationId();
 
-        Saml2Authentication samlAuthentication = (Saml2Authentication) authentication;
         CustomSaml2AuthenticatedPrincipal principal =
                 (CustomSaml2AuthenticatedPrincipal) samlAuthentication.getPrincipal();
 
-        String nameIdValue = principal.getName();
+        String nameIdValue = principal.name();
 
         try {
             // Read certificate from the resource
@@ -109,27 +93,7 @@ public class CustomLogoutSuccessHandler extends SimpleUrlLogoutSuccessHandler {
             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);
+            SamlClient samlClient = getSamlClient(registrationId, samlConf, certificates);
 
             // Read private key for service provider
             Resource privateKeyResource = samlConf.getPrivateKey();
@@ -141,96 +105,134 @@ public class CustomLogoutSuccessHandler extends SimpleUrlLogoutSuccessHandler {
             // 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");
+            log.error(
+                    "Error retrieving logout URL from Provider {} for user {}",
+                    samlConf.getProvider(),
+                    nameIdValue,
+                    e);
+            getRedirectStrategy().sendRedirect(request, response, LOGOUT_PATH);
         }
     }
 
     // Redirect for OAuth2 authentication logout
     private void getRedirect_oauth2(
-            HttpServletRequest request, HttpServletResponse response, Authentication authentication)
+            HttpServletRequest request,
+            HttpServletResponse response,
+            OAuth2AuthenticationToken oAuthToken)
             throws IOException {
-        String param = "logout=true";
-        String registrationId = null;
-        String issuer = null;
-        String clientId = null;
+        String registrationId;
         OAUTH2 oauth = applicationProperties.getSecurity().getOauth2();
+        String path = checkForErrors(request);
 
-        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";
-        }
-
-        String redirect_url = UrlUtils.getOrigin(request) + "/login?" + param;
+        String redirectUrl = UrlUtils.getOrigin(request) + "/login?" + path;
+        registrationId = oAuthToken.getAuthorizedClientRegistrationId();
 
         // 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);
+            case "keycloak" -> {
+                KeycloakProvider keycloak = oauth.getClient().getKeycloak();
+
+                boolean isKeycloak = !keycloak.getIssuer().isBlank();
+                boolean isCustomOAuth = !oauth.getIssuer().isBlank();
+
+                String logoutUrl = redirectUrl;
+
+                if (isKeycloak) {
+                    logoutUrl = keycloak.getIssuer();
+                } else if (isCustomOAuth) {
+                    logoutUrl = oauth.getIssuer();
+                }
+                if (isKeycloak || isCustomOAuth) {
+                    logoutUrl +=
+                            "/protocol/openid-connect/logout"
+                                    + "?client_id="
+                                    + oauth.getClientId()
+                                    + "&post_logout_redirect_uri="
+                                    + response.encodeRedirectURL(redirectUrl);
+                    log.info("Redirecting to Keycloak logout URL: {}", logoutUrl);
+                } else {
+                    log.info(
+                            "No redirect URL for {} available. Redirecting to default logout URL: {}",
+                            registrationId,
+                            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;
+            }
+            case "github", "google" -> {
+                log.info(
+                        "No redirect URL for {} available. Redirecting to default logout URL: {}",
+                        registrationId,
+                        redirectUrl);
+                response.sendRedirect(redirectUrl);
+            }
+            default -> {
+                log.info("Redirecting to default logout URL: {}", redirectUrl);
+                response.sendRedirect(redirectUrl);
+            }
         }
     }
 
-    // Sanitize input to avoid potential security vulnerabilities
+    private static SamlClient getSamlClient(
+            String registrationId, SAML2 samlConf, List<X509Certificate> certificates)
+            throws SamlException {
+        String serverUrl =
+                SPDFApplication.getStaticBaseUrl() + ":" + SPDFApplication.getStaticPort();
+
+        String relyingPartyIdentifier =
+                serverUrl + "/saml2/service-provider-metadata/" + registrationId;
+
+        String assertionConsumerServiceUrl = serverUrl + "/login/saml2/sso/" + registrationId;
+
+        String idpSLOUrl = samlConf.getIdpSingleLogoutUrl();
+
+        String idpIssuer = samlConf.getIdpIssuer();
+
+        // Create SamlClient instance for SAML logout
+        return new SamlClient(
+                relyingPartyIdentifier,
+                assertionConsumerServiceUrl,
+                idpSLOUrl,
+                idpIssuer,
+                certificates,
+                SamlClient.SamlIdpBinding.POST);
+    }
+
+    /**
+     * Handles different error scenarios during logout. Will return a <code>String</code> containing
+     * the error request parameter.
+     *
+     * @param request the user's <code>HttpServletRequest</code> request.
+     * @return a <code>String</code> containing the error request parameter.
+     */
+    private String checkForErrors(HttpServletRequest request) {
+        String errorMessage;
+        String path = "logout=true";
+
+        if (request.getParameter("oAuth2AuthenticationErrorWeb") != null) {
+            path = "errorOAuth=userAlreadyExistsWeb";
+        } else if ((errorMessage = request.getParameter("errorOAuth")) != null) {
+            path = "errorOAuth=" + sanitizeInput(errorMessage);
+        } else if (request.getParameter("oAuth2AutoCreateDisabled") != null) {
+            path = "errorOAuth=oAuth2AutoCreateDisabled";
+        } else if (request.getParameter("oAuth2AdminBlockedUser") != null) {
+            path = "errorOAuth=oAuth2AdminBlockedUser";
+        } else if (request.getParameter("userIsDisabled") != null) {
+            path = "errorOAuth=userIsDisabled";
+        } else if ((errorMessage = request.getParameter("error")) != null) {
+            path = "errorOAuth=" + sanitizeInput(errorMessage);
+        } else if (request.getParameter("badCredentials") != null) {
+            path = "errorOAuth=badCredentials";
+        }
+
+        return path;
+    }
+
+    /**
+     * Sanitize input to avoid potential security vulnerabilities. Will return a sanitised <code>
+     * String</code>.
+     *
+     * @return a sanitised <code>String</code>
+     */
     private String sanitizeInput(String input) {
         return input.replaceAll("[^a-zA-Z0-9 ]", "");
     }

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

@@ -16,7 +16,9 @@ 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;
 

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

@@ -6,6 +6,7 @@ import java.util.concurrent.atomic.AtomicInteger;
 
 import jakarta.servlet.*;
 import jakarta.servlet.http.HttpServletRequest;
+
 import stirling.software.SPDF.utils.RequestUriUtils;
 
 public class IPRateLimitingFilter implements Filter {
@@ -24,8 +25,8 @@ public class IPRateLimitingFilter implements Filter {
     @Override
     public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
             throws IOException, ServletException {
-        if (request instanceof HttpServletRequest) {
-            HttpServletRequest httpRequest = (HttpServletRequest) request;
+        if (request instanceof HttpServletRequest httpServletRequest) {
+            HttpServletRequest httpRequest = httpServletRequest;
             String method = httpRequest.getMethod();
             String requestURI = httpRequest.getRequestURI();
             // Check if the request is for static resources

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

@@ -1,49 +1,59 @@
 package stirling.software.SPDF.config.security;
 
-import java.io.IOException;
+import java.sql.SQLException;
 import java.util.UUID;
 
 import org.springframework.stereotype.Component;
 
 import jakarta.annotation.PostConstruct;
+
 import lombok.extern.slf4j.Slf4j;
-import stirling.software.SPDF.config.interfaces.DatabaseBackupInterface;
+
+import stirling.software.SPDF.config.interfaces.DatabaseInterface;
 import stirling.software.SPDF.model.ApplicationProperties;
 import stirling.software.SPDF.model.Role;
+import stirling.software.SPDF.model.exception.UnsupportedProviderException;
 
-@Component
 @Slf4j
+@Component
 public class InitialSecuritySetup {
 
     private final UserService userService;
 
     private final ApplicationProperties applicationProperties;
 
-    private final DatabaseBackupInterface databaseBackupHelper;
+    private final DatabaseInterface databaseService;
 
     public InitialSecuritySetup(
             UserService userService,
             ApplicationProperties applicationProperties,
-            DatabaseBackupInterface databaseBackupHelper) {
+            DatabaseInterface databaseService) {
         this.userService = userService;
         this.applicationProperties = applicationProperties;
-        this.databaseBackupHelper = databaseBackupHelper;
+        this.databaseService = databaseService;
     }
 
     @PostConstruct
-    public void init() throws IllegalArgumentException, IOException {
-        if (databaseBackupHelper.hasBackup() && !userService.hasUsers()) {
-            databaseBackupHelper.importDatabase();
-        } else if (!userService.hasUsers()) {
-            initializeAdminUser();
-        } else {
-            databaseBackupHelper.exportDatabase();
+    public void init() {
+        try {
+
+            if (!userService.hasUsers()) {
+                if (databaseService.hasBackup()) {
+                    databaseService.importDatabase();
+                } else {
+                    initializeAdminUser();
+                }
+            }
+
             userService.migrateOauth2ToSSO();
+            initializeInternalApiUser();
+        } catch (IllegalArgumentException | SQLException | UnsupportedProviderException e) {
+            log.error("Failed to initialize security setup.", e);
+            System.exit(1);
         }
-        initializeInternalApiUser();
     }
 
-    private void initializeAdminUser() throws IOException {
+    private void initializeAdminUser() throws SQLException, UnsupportedProviderException {
         String initialUsername =
                 applicationProperties.getSecurity().getInitialLogin().getUsername();
         String initialPassword =
@@ -52,36 +62,34 @@ public class InitialSecuritySetup {
                 && !initialUsername.isEmpty()
                 && initialPassword != null
                 && !initialPassword.isEmpty()
-                && !userService.findByUsernameIgnoreCase(initialUsername).isPresent()) {
-            try {
-                userService.saveUser(initialUsername, initialPassword, Role.ADMIN.getRoleId());
-                log.info("Admin user created: " + initialUsername);
-            } catch (IllegalArgumentException e) {
-                log.error("Failed to initialize security setup", e);
-                System.exit(1);
-            }
+                && userService.findByUsernameIgnoreCase(initialUsername).isEmpty()) {
+
+            userService.saveUser(initialUsername, initialPassword, Role.ADMIN.getRoleId());
+            log.info("Admin user created: {}", initialUsername);
         } else {
             createDefaultAdminUser();
         }
     }
 
-    private void createDefaultAdminUser() throws IllegalArgumentException, IOException {
+    private void createDefaultAdminUser() throws SQLException, UnsupportedProviderException {
         String defaultUsername = "admin";
         String defaultPassword = "stirling";
-        if (!userService.findByUsernameIgnoreCase(defaultUsername).isPresent()) {
+
+        if (userService.findByUsernameIgnoreCase(defaultUsername).isEmpty()) {
             userService.saveUser(defaultUsername, defaultPassword, Role.ADMIN.getRoleId(), true);
-            log.info("Default admin user created: " + defaultUsername);
+            log.info("Default admin user created: {}", defaultUsername);
         }
     }
 
-    private void initializeInternalApiUser() throws IllegalArgumentException, IOException {
+    private void initializeInternalApiUser()
+            throws IllegalArgumentException, SQLException, UnsupportedProviderException {
         if (!userService.usernameExistsIgnoreCase(Role.INTERNAL_API_USER.getRoleId())) {
             userService.saveUser(
                     Role.INTERNAL_API_USER.getRoleId(),
                     UUID.randomUUID().toString(),
                     Role.INTERNAL_API_USER.getRoleId());
             userService.addApiKeyToUser(Role.INTERNAL_API_USER.getRoleId());
-            log.info("Internal API user created: " + Role.INTERNAL_API_USER.getRoleId());
+            log.info("Internal API user created: {}", Role.INTERNAL_API_USER.getRoleId());
         }
         userService.syncCustomApiUser(applicationProperties.getSecurity().getCustomGlobalAPIKey());
     }

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

@@ -6,7 +6,9 @@ import java.util.concurrent.TimeUnit;
 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;
 

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

@@ -1,39 +1,24 @@
 package stirling.software.SPDF.config.security;
 
-import java.security.cert.X509Certificate;
-import java.util.*;
+import java.util.Optional;
 
-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;
 import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
 import org.springframework.security.config.http.SessionCreationPolicy;
-import org.springframework.security.core.GrantedAuthority;
-import org.springframework.security.core.authority.SimpleGrantedAuthority;
 import org.springframework.security.core.authority.mapping.GrantedAuthoritiesMapper;
 import org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder;
 import org.springframework.security.crypto.password.PasswordEncoder;
-import org.springframework.security.oauth2.client.registration.ClientRegistration;
-import org.springframework.security.oauth2.client.registration.ClientRegistrationRepository;
-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;
@@ -43,24 +28,17 @@ 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.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;
-import stirling.software.SPDF.model.provider.KeycloakProvider;
 import stirling.software.SPDF.repository.JPATokenRepositoryImpl;
 import stirling.software.SPDF.repository.PersistentLoginRepository;
 
@@ -72,12 +50,8 @@ import stirling.software.SPDF.repository.PersistentLoginRepository;
 public class SecurityConfiguration {
 
     private final CustomUserDetailsService userDetailsService;
-    @Lazy private final UserService userService;
-
-    @Qualifier("loginEnabled")
+    private final UserService userService;
     private final boolean loginEnabledValue;
-
-    @Qualifier("runningEE")
     private final boolean runningEE;
 
     private final ApplicationProperties applicationProperties;
@@ -86,16 +60,10 @@ public class SecurityConfiguration {
     private final FirstLoginFilter firstLoginFilter;
     private final SessionPersistentRegistry sessionRegistry;
     private final PersistentLoginRepository persistentLoginRepository;
+    private final GrantedAuthoritiesMapper oAuth2userAuthoritiesMapper;
+    private final RelyingPartyRegistrationRepository saml2RelyingPartyRegistrations;
+    private final OpenSaml4AuthenticationRequestResolver saml2AuthenticationRequestResolver;
 
-    //    // Only Dev test
-    //    @Bean
-    //    public WebSecurityCustomizer webSecurityCustomizer() {
-    //        return (web) ->
-    //                web.ignoring()
-    //                        .requestMatchers(
-    //                                "/css/**", "/images/**", "/js/**", "/**.svg",
-    // "/pdfjs-legacy/**");
-    //    }
     public SecurityConfiguration(
             PersistentLoginRepository persistentLoginRepository,
             CustomUserDetailsService userDetailsService,
@@ -106,7 +74,12 @@ public class SecurityConfiguration {
             UserAuthenticationFilter userAuthenticationFilter,
             LoginAttemptService loginAttemptService,
             FirstLoginFilter firstLoginFilter,
-            SessionPersistentRegistry sessionRegistry) {
+            SessionPersistentRegistry sessionRegistry,
+            @Autowired(required = false) GrantedAuthoritiesMapper oAuth2userAuthoritiesMapper,
+            @Autowired(required = false)
+                    RelyingPartyRegistrationRepository saml2RelyingPartyRegistrations,
+            @Autowired(required = false)
+                    OpenSaml4AuthenticationRequestResolver saml2AuthenticationRequestResolver) {
         this.userDetailsService = userDetailsService;
         this.userService = userService;
         this.loginEnabledValue = loginEnabledValue;
@@ -117,6 +90,9 @@ public class SecurityConfiguration {
         this.firstLoginFilter = firstLoginFilter;
         this.sessionRegistry = sessionRegistry;
         this.persistentLoginRepository = persistentLoginRepository;
+        this.oAuth2userAuthoritiesMapper = oAuth2userAuthoritiesMapper;
+        this.saml2RelyingPartyRegistrations = saml2RelyingPartyRegistrations;
+        this.saml2AuthenticationRequestResolver = saml2AuthenticationRequestResolver;
     }
 
     @Bean
@@ -129,6 +105,7 @@ public class SecurityConfiguration {
         if (applicationProperties.getSecurity().getCsrfDisabled() || !loginEnabledValue) {
             http.csrf(csrf -> csrf.disable());
         }
+
         if (loginEnabledValue) {
             http.addFilterBefore(
                     userAuthenticationFilter, UsernamePasswordAuthenticationFilter.class);
@@ -184,8 +161,7 @@ public class SecurityConfiguration {
                                     .logoutSuccessHandler(
                                             new CustomLogoutSuccessHandler(applicationProperties))
                                     .clearAuthentication(true)
-                                    .invalidateHttpSession( // Invalidate session
-                                            true)
+                                    .invalidateHttpSession(true)
                                     .deleteCookies("JSESSIONID", "remember-me"));
             http.rememberMe(
                     rememberMeConfigurer -> // Use the configurator directly
@@ -247,14 +223,14 @@ public class SecurityConfiguration {
                                         .permitAll());
             }
             // Handle OAUTH2 Logins
-            if (applicationProperties.getSecurity().isOauth2Activ()) {
+            if (applicationProperties.getSecurity().isOauth2Active()) {
                 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'
+                                        If user exists, login proceeds as usual. If user does not exist, then it is auto-created but only if 'OAUTH2AutoCreateUser'
                                         is set as true, else login fails with an error message advising the same.
                                          */
                                         successHandler(
@@ -274,12 +250,11 @@ public class SecurityConfiguration {
                                                                                 userService,
                                                                                 loginAttemptService))
                                                                 .userAuthoritiesMapper(
-                                                                        userAuthoritiesMapper()))
+                                                                        oAuth2userAuthoritiesMapper))
                                         .permitAll());
             }
             // Handle SAML
-            if (applicationProperties.getSecurity().isSaml2Activ()) {
-                // && runningEE
+            if (applicationProperties.getSecurity().isSaml2Active() && runningEE) {
                 // Configure the authentication provider
                 OpenSaml4AuthenticationProvider authenticationProvider =
                         new OpenSaml4AuthenticationProvider();
@@ -291,7 +266,7 @@ public class SecurityConfiguration {
                                     try {
                                         saml2.loginPage("/saml2")
                                                 .relyingPartyRegistrationRepository(
-                                                        relyingPartyRegistrations())
+                                                        saml2RelyingPartyRegistrations)
                                                 .authenticationManager(
                                                         new ProviderManager(authenticationProvider))
                                                 .successHandler(
@@ -302,253 +277,20 @@ public class SecurityConfiguration {
                                                 .failureHandler(
                                                         new CustomSaml2AuthenticationFailureHandler())
                                                 .authenticationRequestResolver(
-                                                        authenticationRequestResolver(
-                                                                relyingPartyRegistrations()));
+                                                        saml2AuthenticationRequestResolver);
                                     } catch (Exception e) {
-                                        log.error("Error configuring SAML2 login", e);
+                                        log.error("Error configuring SAML 2 login", e);
                                         throw new RuntimeException(e);
                                     }
                                 });
             }
         } else {
-            //            if (!applicationProperties.getSecurity().getCsrfDisabled()) {
-            //                CookieCsrfTokenRepository cookieRepo =
-            //                        CookieCsrfTokenRepository.withHttpOnlyFalse();
-            //                CsrfTokenRequestAttributeHandler requestHandler =
-            //                        new CsrfTokenRequestAttributeHandler();
-            //                requestHandler.setCsrfRequestAttributeName(null);
-            //                http.csrf(
-            //                        csrf ->
-            //                                csrf.csrfTokenRepository(cookieRepo)
-            //                                        .csrfTokenRequestHandler(requestHandler));
-            //            }
+            log.debug("SAML 2 login is not enabled. Using default.");
             http.authorizeHttpRequests(authz -> authz.anyRequest().permitAll());
         }
         return http.build();
     }
 
-    @Bean
-    @ConditionalOnProperty(
-            value = "security.oauth2.enabled",
-            havingValue = "true",
-            matchIfMissing = false)
-    public ClientRegistrationRepository clientRegistrationRepository() {
-        List<ClientRegistration> registrations = new ArrayList<>();
-        githubClientRegistration().ifPresent(registrations::add);
-        oidcClientRegistration().ifPresent(registrations::add);
-        googleClientRegistration().ifPresent(registrations::add);
-        keycloakClientRegistration().ifPresent(registrations::add);
-        if (registrations.isEmpty()) {
-            log.error("At least one OAuth2 provider must be configured");
-            System.exit(1);
-        }
-        return new InMemoryClientRegistrationRepository(registrations);
-    }
-
-    private Optional<ClientRegistration> googleClientRegistration() {
-        OAUTH2 oauth = applicationProperties.getSecurity().getOauth2();
-        if (oauth == null || !oauth.getEnabled()) {
-            return Optional.empty();
-        }
-        Client client = oauth.getClient();
-        if (client == null) {
-            return Optional.empty();
-        }
-        GoogleProvider google = client.getGoogle();
-        return google != null && google.isSettingsValid()
-                ? Optional.of(
-                        ClientRegistration.withRegistrationId(google.getName())
-                                .clientId(google.getClientId())
-                                .clientSecret(google.getClientSecret())
-                                .scope(google.getScopes())
-                                .authorizationUri(google.getAuthorizationuri())
-                                .tokenUri(google.getTokenuri())
-                                .userInfoUri(google.getUserinfouri())
-                                .userNameAttributeName(google.getUseAsUsername())
-                                .clientName(google.getClientName())
-                                .redirectUri("{baseUrl}/login/oauth2/code/" + google.getName())
-                                .authorizationGrantType(
-                                        org.springframework.security.oauth2.core
-                                                .AuthorizationGrantType.AUTHORIZATION_CODE)
-                                .build())
-                : Optional.empty();
-    }
-
-    private Optional<ClientRegistration> keycloakClientRegistration() {
-        OAUTH2 oauth = applicationProperties.getSecurity().getOauth2();
-        if (oauth == null || !oauth.getEnabled()) {
-            return Optional.empty();
-        }
-        Client client = oauth.getClient();
-        if (client == null) {
-            return Optional.empty();
-        }
-        KeycloakProvider keycloak = client.getKeycloak();
-        return keycloak != null && keycloak.isSettingsValid()
-                ? Optional.of(
-                        ClientRegistrations.fromIssuerLocation(keycloak.getIssuer())
-                                .registrationId(keycloak.getName())
-                                .clientId(keycloak.getClientId())
-                                .clientSecret(keycloak.getClientSecret())
-                                .scope(keycloak.getScopes())
-                                .userNameAttributeName(keycloak.getUseAsUsername())
-                                .clientName(keycloak.getClientName())
-                                .build())
-                : Optional.empty();
-    }
-
-    private Optional<ClientRegistration> githubClientRegistration() {
-        OAUTH2 oauth = applicationProperties.getSecurity().getOauth2();
-        if (oauth == null || !oauth.getEnabled()) {
-            return Optional.empty();
-        }
-        Client client = oauth.getClient();
-        if (client == null) {
-            return Optional.empty();
-        }
-        GithubProvider github = client.getGithub();
-        return github != null && github.isSettingsValid()
-                ? Optional.of(
-                        ClientRegistration.withRegistrationId(github.getName())
-                                .clientId(github.getClientId())
-                                .clientSecret(github.getClientSecret())
-                                .scope(github.getScopes())
-                                .authorizationUri(github.getAuthorizationuri())
-                                .tokenUri(github.getTokenuri())
-                                .userInfoUri(github.getUserinfouri())
-                                .userNameAttributeName(github.getUseAsUsername())
-                                .clientName(github.getClientName())
-                                .redirectUri("{baseUrl}/login/oauth2/code/" + github.getName())
-                                .authorizationGrantType(
-                                        org.springframework.security.oauth2.core
-                                                .AuthorizationGrantType.AUTHORIZATION_CODE)
-                                .build())
-                : Optional.empty();
-    }
-
-    private Optional<ClientRegistration> oidcClientRegistration() {
-        OAUTH2 oauth = applicationProperties.getSecurity().getOauth2();
-        if (oauth == null
-                || oauth.getIssuer() == null
-                || oauth.getIssuer().isEmpty()
-                || oauth.getClientId() == null
-                || oauth.getClientId().isEmpty()
-                || oauth.getClientSecret() == null
-                || oauth.getClientSecret().isEmpty()
-                || oauth.getScopes() == null
-                || oauth.getScopes().isEmpty()
-                || oauth.getUseAsUsername() == null
-                || oauth.getUseAsUsername().isEmpty()) {
-            return Optional.empty();
-        }
-        return Optional.of(
-                ClientRegistrations.fromIssuerLocation(oauth.getIssuer())
-                        .registrationId("oidc")
-                        .clientId(oauth.getClientId())
-                        .clientSecret(oauth.getClientSecret())
-                        .scope(oauth.getScopes())
-                        .userNameAttributeName(oauth.getUseAsUsername())
-                        .clientName("OIDC")
-                        .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);
@@ -556,46 +298,6 @@ public class SecurityConfiguration {
         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.
-     */
-    @Bean
-    @ConditionalOnProperty(
-            value = "security.oauth2.enabled",
-            havingValue = "true",
-            matchIfMissing = false)
-    GrantedAuthoritiesMapper userAuthoritiesMapper() {
-        return (authorities) -> {
-            Set<GrantedAuthority> mappedAuthorities = new HashSet<>();
-            authorities.forEach(
-                    authority -> {
-                        // Add existing OAUTH2 Authorities
-                        mappedAuthorities.add(new SimpleGrantedAuthority(authority.getAuthority()));
-                        // Add Authorities from database for existing user, if user is present.
-                        if (authority instanceof OAuth2UserAuthority oauth2Auth) {
-                            String useAsUsername =
-                                    applicationProperties
-                                            .getSecurity()
-                                            .getOauth2()
-                                            .getUseAsUsername();
-                            Optional<User> userOpt =
-                                    userService.findByUsernameIgnoreCase(
-                                            (String) oauth2Auth.getAttributes().get(useAsUsername));
-                            if (userOpt.isPresent()) {
-                                User user = userOpt.get();
-                                if (user != null) {
-                                    mappedAuthorities.add(
-                                            new SimpleGrantedAuthority(
-                                                    userService.findRole(user).getAuthority()));
-                                }
-                            }
-                        }
-                    });
-            return mappedAuthorities;
-        };
-    }
-
     @Bean
     public IPRateLimitingFilter rateLimitingFilter() {
         // Example limit TODO add config level
@@ -609,7 +311,7 @@ public class SecurityConfiguration {
     }
 
     @Bean
-    public boolean activSecurity() {
+    public boolean activeSecurity() {
         return true;
     }
 }

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

@@ -22,22 +22,33 @@ import jakarta.servlet.FilterChain;
 import jakarta.servlet.ServletException;
 import jakarta.servlet.http.HttpServletRequest;
 import jakarta.servlet.http.HttpServletResponse;
+
+import lombok.extern.slf4j.Slf4j;
+
 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.ApplicationProperties;
+import stirling.software.SPDF.model.ApplicationProperties.Security;
+import stirling.software.SPDF.model.ApplicationProperties.Security.OAUTH2;
+import stirling.software.SPDF.model.ApplicationProperties.Security.SAML2;
 import stirling.software.SPDF.model.User;
 
+@Slf4j
 @Component
 public class UserAuthenticationFilter extends OncePerRequestFilter {
 
+    private final ApplicationProperties applicationProperties;
     private final UserService userService;
     private final SessionPersistentRegistry sessionPersistentRegistry;
     private final boolean loginEnabledValue;
 
     public UserAuthenticationFilter(
+            @Lazy ApplicationProperties applicationProperties,
             @Lazy UserService userService,
             SessionPersistentRegistry sessionPersistentRegistry,
             @Qualifier("loginEnabled") boolean loginEnabledValue) {
+        this.applicationProperties = applicationProperties;
         this.userService = userService;
         this.sessionPersistentRegistry = sessionPersistentRegistry;
         this.loginEnabledValue = loginEnabledValue;
@@ -77,7 +88,7 @@ public class UserAuthenticationFilter extends OncePerRequestFilter {
                     // Use API key to authenticate. This requires you to have an authentication
                     // provider for API keys.
                     Optional<User> user = userService.getUserByApiKey(apiKey);
-                    if (!user.isPresent()) {
+                    if (user.isEmpty()) {
                         response.setStatus(HttpStatus.UNAUTHORIZED.value());
                         response.getWriter().write("Invalid API Key.");
                         return;
@@ -112,43 +123,79 @@ public class UserAuthenticationFilter extends OncePerRequestFilter {
                 response.setStatus(HttpStatus.UNAUTHORIZED.value());
                 response.getWriter()
                         .write(
-                                "Authentication required. Please provide a X-API-KEY in request header.\n"
+                                "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");
+                                        + "Alternatively you can disable authentication if this is"
+                                        + " unexpected");
                 return;
             }
         }
 
         // Check if the authenticated user is disabled and invalidate their session if so
         if (authentication != null && authentication.isAuthenticated()) {
+
+            Security securityProp = applicationProperties.getSecurity();
+            LoginMethod loginMethod = LoginMethod.UNKNOWN;
+
+            boolean blockRegistration = false;
+
+            // Extract username and determine the login method
             Object principal = authentication.getPrincipal();
             String username = null;
-            if (principal instanceof UserDetails) {
-                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;
+            if (principal instanceof UserDetails detailsUser) {
+                username = detailsUser.getUsername();
+                loginMethod = LoginMethod.USERDETAILS;
+            } else if (principal instanceof OAuth2User oAuth2User) {
+                username = oAuth2User.getName();
+                loginMethod = LoginMethod.OAUTH2USER;
+                OAUTH2 oAuth = securityProp.getOauth2();
+                blockRegistration = oAuth != null && oAuth.getBlockRegistration();
+            } else if (principal instanceof CustomSaml2AuthenticatedPrincipal saml2User) {
+                username = saml2User.name();
+                loginMethod = LoginMethod.SAML2USER;
+                SAML2 saml2 = securityProp.getSaml2();
+                blockRegistration = saml2 != null && saml2.getBlockRegistration();
+            } else if (principal instanceof String stringUser) {
+                username = stringUser;
+                loginMethod = LoginMethod.STRINGUSER;
             }
 
+            // Retrieve all active sessions for the user
             List<SessionInformation> sessionsInformations =
                     sessionPersistentRegistry.getAllSessions(principal, false);
 
+            // Check if the user exists, is disabled, or needs session invalidation
             if (username != null) {
+                log.debug("Validating user: {}", username);
                 boolean isUserExists = userService.usernameExistsIgnoreCase(username);
                 boolean isUserDisabled = userService.isUserDisabled(username);
 
+                boolean notSsoLogin =
+                        !LoginMethod.OAUTH2USER.equals(loginMethod)
+                                && !LoginMethod.SAML2USER.equals(loginMethod);
+
+                // Block user registration if not allowed by configuration
+                if (blockRegistration && !isUserExists) {
+                    log.warn("Blocked registration for OAuth2/SAML user: {}", username);
+                    response.sendRedirect(
+                            request.getContextPath() + "/logout?oAuth2AdminBlockedUser=true");
+                    return;
+                }
+
+                // Expire sessions and logout if the user does not exist or is disabled
                 if (!isUserExists || isUserDisabled) {
+                    log.info(
+                            "Invalidating session for disabled or non-existent user: {}", username);
                     for (SessionInformation sessionsInformation : sessionsInformations) {
                         sessionsInformation.expireNow();
                         sessionPersistentRegistry.expireSession(sessionsInformation.getSessionId());
                     }
                 }
 
-                if (!isUserExists) {
-                    response.sendRedirect(request.getContextPath() + "/logout?badcredentials=true");
+                // Redirect to logout if credentials are invalid
+                if (!isUserExists && notSsoLogin) {
+                    response.sendRedirect(request.getContextPath() + "/logout?badCredentials=true");
                     return;
                 }
                 if (isUserDisabled) {
@@ -161,6 +208,25 @@ public class UserAuthenticationFilter extends OncePerRequestFilter {
         filterChain.doFilter(request, response);
     }
 
+    private enum LoginMethod {
+        USERDETAILS("UserDetails"),
+        OAUTH2USER("OAuth2User"),
+        STRINGUSER("StringUser"),
+        UNKNOWN("Unknown"),
+        SAML2USER("Saml2User");
+
+        private String method;
+
+        LoginMethod(String method) {
+            this.method = method;
+        }
+
+        @Override
+        public String toString() {
+            return method;
+        }
+    }
+
     @Override
     protected boolean shouldNotFilter(HttpServletRequest request) throws ServletException {
         String uri = request.getRequestURI();

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

@@ -23,6 +23,7 @@ import jakarta.servlet.FilterChain;
 import jakarta.servlet.ServletException;
 import jakarta.servlet.http.HttpServletRequest;
 import jakarta.servlet.http.HttpServletResponse;
+
 import stirling.software.SPDF.model.Role;
 
 @Component