From 3576c32c5273c1a91bb731f4591306274e9e525c Mon Sep 17 00:00:00 2001 From: Anthony Stirling <77850077+Frooodle@users.noreply.github.com.> Date: Sun, 16 Jun 2024 15:42:45 +0100 Subject: [PATCH] add fat jar --- README.md | 25 ++++++++++++++----------- Version-groups.md | 5 ++++- 2 files changed, 18 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index f83aff25..4d5eae28 100644 --- a/README.md +++ b/README.md @@ -105,33 +105,36 @@ Please view https://github.com/Stirling-Tools/Stirling-PDF/blob/main/LocalRunGui https://hub.docker.com/r/frooodle/s-pdf -Stirling PDF has 2 different versions, a Full version and ultra-Lite version. Depending on the types of features you use you may want a smaller image to save on space. +Stirling PDF has 3 different versions, a Full version and ultra-Lite version as well as a 'Fat' version. Depending on the types of features you use you may want a smaller image to save on space. To see what the different versions offer please look at our [version mapping](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/Version-groups.md) For people that don't mind about space optimization just use the latest tag. ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/frooodle/s-pdf/latest?label=Stirling-PDF%20Full) ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/frooodle/s-pdf/latest-ultra-lite?label=Stirling-PDF%20Ultra-Lite) +![Docker Image Size (tag)](https://img.shields.io/docker/image-size/frooodle/s-pdf/latest-fat?label=Stirling-PDF%20Fat) -Docker Run +Please note in below examples you may need to change the volume paths as needed, current examples install them to the current working directory +eg ``./extraConfigs:/configs`` to ``/opt/stirlingpdf/extraConfigs:/configs`` + +### Docker Run ```bash docker run -d \ -p 8080:8080 \ - -v /location/of/trainingData:/usr/share/tessdata \ - -v /location/of/extraConfigs:/configs \ - -v /location/of/logs:/logs \ + -v ./trainingData:/usr/share/tessdata \ + -v ./extraConfigs:/configs \ + -v ./logs:/logs \ -e DOCKER_ENABLE_SECURITY=false \ -e INSTALL_BOOK_AND_ADVANCED_HTML_OPS=false \ -e LANGS=en_GB \ --name stirling-pdf \ frooodle/s-pdf:latest - Can also add these for customisation but are not required -v /location/of/customFiles:/customFiles \ ``` -Docker Compose +### Docker Compose ```yaml version: '3.3' @@ -141,10 +144,10 @@ 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/ + - ./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 diff --git a/Version-groups.md b/Version-groups.md index 2495ae4d..a9a9ac16 100644 --- a/Version-groups.md +++ b/Version-groups.md @@ -1,4 +1,7 @@ -| Technology | Ultra-Lite | Full | +|All versions in a Docker envrionment 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 | ✔️ | ✔️ |