update

Stirling-Tools · May 29, 2024 · fb36639 · fb36639
1 parent 66b76dd
commit fb36639
Show file tree

Hide file tree

Showing 17 changed files with 5,632 additions and 3,996 deletions.
diff --git a/docs/API.md b/docs/API.md
@@ -11,9 +11,10 @@ tags:
 
 Stirling PDF exposes a simple API for easy integration with external scripts. For an exhaustive list of all available API endpoints and their functions, please refer to the [Swagger Documentation](https://app.swaggerhub.com/apis-docs/Frooodle/Stirling-PDF/).
 
-Stirling-PDF's feature set is not entirely confined to the backend, hence not all functionalities are accessible via the API. Certain operations, such as document signing and flattening, are executed exclusively on the front-end, and as such, they are only available through the Web-UI. If you encounter a situation where some API endpoints appear to be absent, it is likely attributable to these front-end exclusive features.
+Stirling-PDF's feature set is not entirely confined to the backend, hence not all functionalities are accessible via the API. Certain operations, such as the "view-pdf" or "visually sign", are executed exclusively on the front-end, and as such, they are only available through the Web-UI. If you encounter a situation where some API endpoints appear to be absent, it is likely attributable to these front-end exclusive features.
 
-Stirling-PDF also has statistic and health endpoints to integrate with monitoring/dashboard applications such as [Heimdall](https://TODOAAAAAAAAAAAAAAAAAAAAAAAAA) and [Fenrus](https://TODO)
+Stirling-PDF also has statistic and health endpoints to integrate with monitoring/dashboard applications
+[Stats API docs](https://app.swaggerhub.com/apis-docs/Frooodle/Stirling-PDF/0.24.6#/Info)
 
 
 # Example CURL Commands

diff --git a/docs/FAQ.md b/docs/FAQ.md
@@ -6,25 +6,18 @@ sidebar_position: 8
 ### Q1: Can I add authentication to Stirling PDF?
 No, Stirling PDF doesn't support built-in authentication, and it is not a planned feature. For secure access, we recommend implementing an external, trusted authentication solution such as Authentik or Authelia.
 
-### Q2: What new features are planned for Stirling PDF?
-Some of the upcoming features include: 
-- Progress bar/Tracking: To give you a real-time update on ongoing operations.
-- Custom logic pipelines: To combine multiple operations.
-- Folder support: To automate operations on the contents of a folder.
-- Auto rename: To rename files based on their title text.
-
-### Q3: Why are .htm files being downloaded when I use the application?
+### Q2: Why are .htm files being downloaded when I use the application?
 This is often caused by your NGINX configuration. NGINX's default file upload size is 1MB, and any file larger than this will cause an .htm file to be downloaded instead. To fix this issue, you should modify your NGINX configuration to increase the maximum file upload size.
 
-### Q4: Can I customize the appearance and language of the Stirling PDF application?
+### Q3: Can I customize the appearance and language of the Stirling PDF application?
 Yes, Stirling PDF provides several environment variables to allow customization of the application, including the name, description, default language, and visibility to search engines. Please refer to the "Customization" section for more details.
 
-### Q5: I want to add a new feature to Stirling PDF. How can I contribute?
+### Q4: I want to add a new feature to Stirling PDF. How can I contribute?
 We welcome contributions from the community! Please open an issue on our GitHub page to discuss any large features before making any changes. Any small changes are fully welcome without discussion! After the feature has been discussed and approved, you can make the changes and submit a pull request.
 
-### Q6: I have a cool idea can you add it?
+### Q5: I have a cool idea can you add it?
 All feedback and suggestions are appreciated. It is best to submit these via a Github issue ticket with [Feature Request] in the title.
 You can also reach out in discord but without a ticket to track it the request can often get lost!
 
-### Q7: I found a bug in Stirling PDF. Where can I report it?
+### Q6: I found a bug in Stirling PDF. Where can I report it?
 Please report any bugs or issues you encounter through our GitHub Issues page. Be sure to include as much detail as possible so we can diagnose and resolve the issue quickly.
diff --git a/docs/Functionality/Convert/Overview.md b/docs/Functionality/Convert/Overview.md
@@ -30,4 +30,4 @@ sidebar_position: 2
 
 - `pdf-to-pdfa`: This feature transforms PDF files into PDF/A format for long-term archiving.
 
-- `pdf-to-csv`: 
+- `pdf-to-csv`: This feature Tries to detect tables within a PDF which can be exported, This only works with digital PDFs not scanned and is a Work in progress feature due to its complexity 
diff --git a/docs/Functionality/Miscellaneous/Overview.md b/docs/Functionality/Miscellaneous/Overview.md
@@ -35,4 +35,6 @@ sidebar_position: 4
 
 - `show-javascript`: Shows any embedded javascript within a PDF
 
-- `stamp`: Adds a user-defined text or image to the corner of certain or all PDF pages
+- `auto-split-pdf`: This Automatically splits documents into seperate files based on the QR code detected between each. It's intent is that a "seperator" page be placed between scans so that bulk scanning can be achieved with splitting as a post process.
+
+- `add-stamp`: Adds a user-defined text or image to the corner of certain or all PDF pages
diff --git a/docs/Functionality/Page operations/Overview.md b/docs/Functionality/Page operations/Overview.md
@@ -29,6 +29,6 @@ sidebar_position: 1
 
 - `split-by-size-or-count`: Splits one or multiple PDF files into parts consisting of a maximum file size or page count definde by the user.
 
-- `overlay-pdf`: 
+- `overlay-pdf`: Can merge multiple PDFs into one another (ontop/behind etc) in various ways
 
-- `split-pdf-by-sections`:
+- `split-pdf-by-sections`: Splits a page in multiple section vertically, horizontally or both. Can be used to split a page in half etc.
diff --git a/docs/Functionality/Security/Overview.md b/docs/Functionality/Security/Overview.md
@@ -17,3 +17,4 @@ sidebar_position: 3
 
 - `auto-redact`: This features lets the user input text (or regex) to be redacted/blacked out from the pdf document.
 
+- `get-info-on-pdf`: This grabs all info on a PDF such as version, font types, width height and any and all information it can find and puts it within a formatted JSON doc (or visual tables within UI)
diff --git a/docs/Getting started/Installation/Docker/Docker Install.md b/docs/Getting started/Installation/Docker/Docker Install.md
@@ -13,26 +13,27 @@ Please note that Stirling PDF offers three distinct versions tailored for variou
 | Version    | Latest Tag          |
 | ---------- | ------------------- |
 | Standard   | `latest`            |
-| Lite       | `latest-lite`       |
 | Ultra Lite | `latest-ultra-lite` |
 
 ### Run docker container with `docker run`
 
 ```
 docker run -d \
   -p 8080:8080 \
-  -v /location/of/trainingData:/usr/share/tesseract-ocr/4.00/tessdata \
+  -v /location/of/trainingData:/usr/share/tessdata \
   -v /location/of/extraConfigs:/configs \
+  -v /location/of/logs:/logs \
   -e DOCKER_ENABLE_SECURITY=false \
+  -e INSTALL_BOOK_AND_ADVANCED_HTML_OPS=false \
+  -e LANGS=en_GB \
   --name stirling-pdf \
   frooodle/s-pdf:latest
 
-
-  Can also add these for customization but are not required
-
+  Can also add these for customisation but are not required
   -v /location/of/customFiles:/customFiles \
 ```
 
+
 ### Run docker container with `docker compose`
 
 - `docker-compose.yml`
@@ -44,14 +45,16 @@ services:
     ports:
       - '8080:8080'
     volumes:
-      - /location/of/trainingData:/usr/share/tesseract-ocr/4.00/tessdata #Required for extra OCR languages
+      - /location/of/trainingData:/usr/share/tessdata #Required for extra OCR languages
       - /location/of/extraConfigs:/configs
 #      - /location/of/customFiles:/customFiles/
+#      - /location/of/logs:/logs/
     environment:
       - DOCKER_ENABLE_SECURITY=false
-
+      - INSTALL_BOOK_AND_ADVANCED_HTML_OPS=false
+      - LANGS=en_GB
 ```
 
 ### Extras
 
-For extra parameters and customization please check the [advanced configuration](http://todo) page!
+For extra parameters and customization please check the [advanced configuration](https://stirlingtools.com/docs/Advanced%20Configuration/How%20to%20add%20configurations) page!
diff --git a/docs/Getting started/Installation/Docker/Docker Versions.md b/docs/Getting started/Installation/Docker/Docker Versions.md
@@ -5,9 +5,8 @@ title: Docker Versions
 ---
 # Docker Versions of Stirling PDF
 
-Stirling PDF is avaiable in three distinct docker images:
+Stirling PDF is avaiable in two distinct docker images:
 - ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/frooodle/s-pdf/latest?label=Stirling-PDF%20Full)
-- ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/frooodle/s-pdf/latest-lite?label=Stirling-PDF%20Lite)
 - ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/frooodle/s-pdf/latest-ultra-lite?label=Stirling-PDF%20Ultra-Lite)
 
 Each version caters to different needs based on the specific features required and the storage space available. 
@@ -17,50 +16,57 @@ If storage optimization is not a concern, we recommend using the latest tag for
 
 Here are the different technologies each version uses.
 
-|Technology      | Ultra-Lite | Lite | Full |
-|----------------|:----------:|:----:|:----:|
-| Java           |     ✔️      |  ✔️  |  ✔️  |
-| JavaScript     |     ✔️      |  ✔️  |  ✔️  |
-| Libre          |             |  ✔️  |  ✔️  |
-| Python         |             |      |  ✔️  |
-| OpenCV         |             |      |  ✔️  |
-| OCRmyPDF       |             |      |  ✔️  |
+| Technology     | Ultra-Lite | Full |
+|----------------|:----------:|:----:|
+| Java           |     ✔️      |  ✔️  |
+| JavaScript     |     ✔️      |  ✔️  |
+| Libre          |            |  ✔️  |
+| Python         |            |  ✔️  |
+| OpenCV         |            |  ✔️  |
+| OCRmyPDF       |            |  ✔️  |
 
 And here you see what functions are offered as part of each.
 
-Operation           | Ultra-Lite | Lite | Full
---------------------|------------|------|-----
-add-password        |     ✔️      |  ✔️   |  ✔️
-add-watermark       |     ✔️      |  ✔️   |  ✔️
-cert-sign           |     ✔️      |  ✔️   |  ✔️
-change-metadata     |     ✔️      |  ✔️   |  ✔️
-change-permissions  |     ✔️      |  ✔️   |  ✔️
-compare             |     ✔️      |  ✔️   |  ✔️
-extract-images      |     ✔️      |  ✔️   |  ✔️
-flatten             |     ✔️      |  ✔️   |  ✔️
-img-to-pdf          |     ✔️      |  ✔️   |  ✔️
-merge-pdfs          |     ✔️      |  ✔️   |  ✔️
-multi-page-layout   |     ✔️      |  ✔️   |  ✔️
-pdf-organizer       |     ✔️      |  ✔️   |  ✔️
-pdf-to-img          |     ✔️      |  ✔️   |  ✔️
-remove-pages        |     ✔️      |  ✔️   |  ✔️
-remove-password     |     ✔️      |  ✔️   |  ✔️
-rotate-pdf          |     ✔️      |  ✔️   |  ✔️
-scale-pages         |     ✔️      |  ✔️   |  ✔️
-sign                |     ✔️      |  ✔️   |  ✔️
-split-pdfs          |     ✔️      |  ✔️   |  ✔️
-add-image           |     ✔️      |  ✔️   |  ✔️
-file-to-pdf         |             |  ✔️   |  ✔️
-pdf-to-html         |             |  ✔️   |  ✔️
-pdf-to-presentation |             |  ✔️   |  ✔️
-pdf-to-text         |             |  ✔️   |  ✔️
-pdf-to-word         |             |  ✔️   |  ✔️
-pdf-to-xml          |             |  ✔️   |  ✔️
-repair              |             |  ✔️   |  ✔️
-xlsx-to-pdf         |             |  ✔️   |  ✔️
-compress-pdf        |             |       |  ✔️
-extract-image-scans |             |       |  ✔️
-ocr-pdf             |             |       |  ✔️
-pdf-to-pdfa         |             |       |  ✔️
-remove-blanks       |             |       |  ✔️
-
+Operation                | Ultra-Lite | Full
+-------------------------|------------|-----
+add-page-numbers         |     ✔️      |  ✔️
+add-password             |     ✔️      |  ✔️
+add-image                |     ✔️      |  ✔️
+add-watermark            |     ✔️      |  ✔️
+adjust-contrast          |     ✔️      |  ✔️
+auto-split-pdf           |     ✔️      |  ✔️
+auto-redact              |     ✔️      |  ✔️
+auto-rename              |     ✔️      |  ✔️
+cert-sign                |     ✔️      |  ✔️
+crop                     |     ✔️      |  ✔️
+change-metadata          |     ✔️      |  ✔️
+change-permissions       |     ✔️      |  ✔️
+compare                  |     ✔️      |  ✔️
+extract-page             |     ✔️      |  ✔️
+extract-images           |     ✔️      |  ✔️
+flatten                  |     ✔️      |  ✔️
+get-info-on-pdf          |     ✔️      |  ✔️
+img-to-pdf               |     ✔️      |  ✔️
+markdown-to-pdf          |     ✔️      |  ✔️
+merge-pdfs               |     ✔️      |  ✔️
+multi-page-layout        |     ✔️      |  ✔️
+overlay-pdf              |     ✔️      |  ✔️
+pdf-organizer            |     ✔️      |  ✔️
+pdf-to-csv               |     ✔️      |  ✔️
+pdf-to-img               |     ✔️      |  ✔️
+pdf-to-single-page       |     ✔️      |  ✔️
+remove-blanks            |     ✔️      |  ✔️
+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              |            |  ✔️
Original file line number	Diff line number	Diff line change
Expand Up		@@ -30,4 +30,4 @@ sidebar_position: 2

		- `pdf-to-pdfa`: This feature transforms PDF files into PDF/A format for long-term archiving.

		- `pdf-to-csv`:
		- `pdf-to-csv`: This feature Tries to detect tables within a PDF which can be exported, This only works with digital PDFs not scanned and is a Work in progress feature due to its complexity
Original file line number	Diff line number	Diff line change
Expand Up		@@ -17,3 +17,4 @@ sidebar_position: 3

		- `auto-redact`: This features lets the user input text (or regex) to be redacted/blacked out from the pdf document.

		- `get-info-on-pdf`: This grabs all info on a PDF such as version, font types, width height and any and all information it can find and puts it within a formatted JSON doc (or visual tables within UI)