Skip to content

Commit

Permalink
Frooodle patch 1 (#31)
Browse files Browse the repository at this point in the history
* Update What is Stirling-PDF.md

* Update Docker Install.md

* Update Docker Versions.md
  • Loading branch information
Frooodle authored Nov 11, 2024
1 parent 56be5d2 commit c3bb249
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 13 deletions.
23 changes: 12 additions & 11 deletions docs/Getting started/Installation/Docker/Docker Install.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,25 +12,25 @@ Please note that Stirling PDF offers three distinct versions tailored for variou

| Version | Latest Tag |
| ---------- | ------------------- |
| Fat | `latest-fat` |
| Standard | `latest` |
| Ultra Lite | `latest-ultra-lite` |

### Run docker container with `docker run`

```
docker run -d \
--name stirling-pdf \
-p 8080:8080 \
-v /location/of/trainingData:/usr/share/tessdata \
-v /location/of/extraConfigs:/configs \
-v /location/of/logs:/logs \
-v "./StirlingPDF/trainingData:/usr/share/tessdata" \
-v "./StirlingPDF/extraConfigs:/configs" \
-v "./StirlingPDF/customFiles:/customFiles/" \
-v "./StirlingPDF/logs:/logs/" \
-v "./StirlingPDF/pipeline:/pipeline/" \
-e DOCKER_ENABLE_SECURITY=false \
-e INSTALL_BOOK_AND_ADVANCED_HTML_OPS=false \
-e LANGS=en_GB \
--name stirling-pdf \
frooodle/s-pdf:latest
Can also add these for customisation but are not required
-v /location/of/customFiles:/customFiles \
```


Expand All @@ -45,10 +45,11 @@ services:
ports:
- '8080:8080'
volumes:
- /location/of/trainingData:/usr/share/tessdata #Required for extra OCR languages
- /location/of/extraConfigs:/configs
# - /location/of/customFiles:/customFiles/
# - /location/of/logs:/logs/
- ./StirlingPDF/trainingData:/usr/share/tessdata # Required for extra OCR languages
- ./StirlingPDF/extraConfigs:/configs
- ./StirlingPDF/customFiles:/customFiles/
- ./StirlingPDF/logs:/logs/
- ./StirlingPDF/pipeline:/pipeline/
environment:
- DOCKER_ENABLE_SECURITY=false
- INSTALL_BOOK_AND_ADVANCED_HTML_OPS=false
Expand Down
18 changes: 17 additions & 1 deletion docs/Getting started/Installation/Docker/Docker Versions.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,15 @@ title: Docker Versions
---
# Docker Versions of Stirling PDF

Stirling PDF is avaiable in two distinct docker images:
Stirling PDF is avaiable in three distinct docker images:
- ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/frooodle/s-pdf/latest-fat?label=Stirling-PDF%20Fat)
- ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/frooodle/s-pdf/latest?label=Stirling-PDF%20Full)
- ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/frooodle/s-pdf/latest-ultra-lite?label=Stirling-PDF%20Ultra-Lite)

Each version caters to different needs based on the specific features required and the storage space available.

The Fat version contains the same from Full but with additional fonts for conversion and the Security jar pre-bundled. It is the recommended version for those unconcerned about storage

For an in-depth comparison of what each version offers, please refer to the graph below.
If storage optimization is not a concern, we recommend using the latest tag for the most complete set of features.

Expand Down Expand Up @@ -70,3 +73,16 @@ compress-pdf | | ✔️
extract-image-scans | | ✔️
ocr-pdf | | ✔️
pdf-to-pdfa | | ✔️
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 | | ✔️
xlsx-to-pdf | | ✔️
html-to-pdf | | ✔️
url-to-pdf | | ✔️
repair | | ✔️
2 changes: 1 addition & 1 deletion docs/Overview/What is Stirling-PDF.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Although the application is OpenSource the majority of work is done by a single
# Benefits

## Privacy comes first
Originally developed as a purely ChatGPT-powered application, Stirling PDF has evolved to accommodate a plethora of PDF-related needs. Most importantly, the platform guarantees utmost privacy and security as it doesn't make outbound calls for tracking or record keeping. All files and PDFs remain either on the client side, stored temporarily on the server during the execution of tasks, or within a transient file created specifically for task execution. Once the user downloads a file, it is immediately purged from the server.
Originally developed as a purely ChatGPT-powered application, Stirling PDF has evolved to accommodate a plethora of PDF-related needs. Most importantly, the platform guarantees privacy and security as it doesn't make outbound calls for file processing ensuring file data is safe. All files and PDFs remain either on the client side, stored temporarily on the server during the execution of tasks, or within a transient file created specifically for task execution. Once the user downloads a file, it is immediately purged from the server.


## Always improving
Expand Down

0 comments on commit c3bb249

Please sign in to comment.