Stirling-PDF/README.md

Stirling-PDF

This is a powerful locally hosted web based PDF manipulation tool using docker that allows you to perform various operations on PDF files, such as splitting merging, converting, reorganizing, adding images, rotating, compressing, and more. This locally hosted web application started as a 100% ChatGPT-made application and has evolved to include a wide range of features to handle all your PDF needs.

Stirling PDF makes no outbound calls for any record keeping or tracking.

All files and PDFs are either purely client side, in server memory only during the execution of the task or within a temporay file only for execution of the task. Any file which has been downloaded by the user will have already been deleted from the server by that time.

Feel free to request any features or bug fixes either in github issues or our Discord

Features

• Full interactive GUI for merging/splitting/rotating/moving PDFs and their pages.
• Split PDFs into multiple files at specified page numbers or extract all pages as individual files.
• Merge multiple PDFs together into a single resultant file
• Convert PDFs to and from images
• Reorganize PDF pages into different orders.
• Add/Generate signatures
• Format PDFs into a multi-paged page
• Scale page contents size by set %
• Adjust Contrast
• Crop PDF
• Auto Split PDF (With physically scanned page dividers)
• Flatten PDFs
• Repair PDFs
• Detect and remove blank pages
• Compare 2 PDFs and show differences in text
• Add images to PDFs
• Rotating PDFs in 90 degree increments.
• Compressing PDFs to decrease their filesize. (Using OCRMyPDF)
• Add and remove passwords
• Set PDF Permissions
• Add watermark(s)
• Convert Any common file to PDF (using LibreOffice)
• Convert PDF to Word/Powerpoint/Others (using LibreOffice)
• Convert HTML to PDF
• URL to PDF
• Extract images from PDF
• Extract images from Scans
• Add page numbers
• Auto rename file by detecting PDF header text
• OCR on PDF (Using OCRMyPDF)
• PDF/A conversion (Using OCRMyPDF)
• Edit metadata
• Dark mode support.
• Custom download options (see here for example)
• Parallel file processing and downloads
• API for integration with external scripts

For a overview of the tasks and the technology each uses please view groups.md Hosted instance/demo of the app can be seen here hosted by the team at adminforge.de

Technologies used

• Spring Boot + Thymeleaf
• PDFBox
• IText7
• LibreOffice for advanced conversions
• OcrMyPdf
• HTML, CSS, JavaScript
• Docker
• PDF.js
• PDF-LIB.js

How to use

Locally

Please view https://github.com/Frooodle/Stirling-PDF/blob/main/LocalRunGuide.md

Docker

https://hub.docker.com/r/frooodle/s-pdf

Stirling PDF has 3 different versions, a Full version, Lite and ultra-Lite. 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 For people that dont mind about space optimisation just use latest tag.

Docker Run

docker run -d \
  -p 8080:8080 \
  -v /location/of/trainingData:/usr/share/tesseract-ocr/4.00/tessdata \
  --name stirling-pdf \
  frooodle/s-pdf:latest
  
  
  Can also add these for customisation but are not required
  -v /location/of/extraConfigs:/configs \
  -v /location/of/customFiles:/customFiles \
  -e APP_HOME_NAME="Stirling PDF" \
  -e APP_HOME_DESCRIPTION="Your locally hosted one-stop-shop for all your PDF needs." \
  -e APP_NAVBAR_NAME="Stirling PDF" \
  -e ALLOW_GOOGLE_VISIBILITY="true" \
  -e APP_ROOT_PATH="/" \
  -e APP_LOCALE="en_GB" \

Docker Compose

version: '3.3'
services:
  stirling-pdf:
    image: frooodle/s-pdf:latest
    ports:
      - '8080:8080'
    volumes:
      - /location/of/trainingData:/usr/share/tesseract-ocr/4.00/tessdata #Required for extra OCR languages
#      - /location/of/extraConfigs:/configs
#      - /location/of/customFiles:/customFiles/
#    environment:
#      APP_LOCALE: en_GB
#      APP_HOME_NAME: Stirling PDF
#      APP_HOME_DESCRIPTION: Your locally hosted one-stop-shop for all your PDF needs.
#      APP_NAVBAR_NAME: Stirling PDF
#      APP_ROOT_PATH: /
#      ALLOW_GOOGLE_VISIBILITY: true

Enable OCR/Compression feature

Please view https://github.com/Frooodle/Stirling-PDF/blob/main/HowToUseOCR.md

Want to add your own language?

Stirling PDF currently supports 16!

• English (English) (en_GB)
• Arabic (العربية) (ar_AR)
• German (Deutsch) (de_DE)
• French (Français) (fr_FR)
• Spanish (Español) (es_ES)
• Chinese (简体中文) (zh_CN)
• Catalan (Català) (ca_CA)
• Italian (Italiano) (it_IT)
• Swedish (Svenska) (sv_SE)
• Polish (Polski) (pl_PL)
• Romanian (Română) (ro_RO)
• Korean (한국어) (ko_KR)
• Portuguese Brazilian (Português) (pt_BR)
• Russian (Русский) (ru_RU)
• Basque (Euskara) (eu_ES)
• Japanese (日本語) (ja_JP)

If you want to add your own language to Stirling-PDF please refer https://github.com/Frooodle/Stirling-PDF/blob/main/HowToAddNewLanguage.md

And please create a PR to merge it back in so others can use it!

Also please note as i add new features i will google translate existing languages so that they dont lose support. This could mean that new features need grammer corrections as added.

How to View

1. Open a web browser and navigate to http://localhost:8080/
2. Use the application by following the instructions on the website.

Customize App

Stirling PDF allows easy customization of the visible application name. Simply use environment variables APP_HOME_NAME, APP_HOME_DESCRIPTION and APP_NAVBAR_NAME with Docker or Java. If running Java directly, you can also pass these as properties using -D arguments.

Using the same method you can also change

• The default language by providing APP_LOCALE with values like de-DE fr-FR or ar-AR (Note the - character not _ ) to select your default language (Will always default to English on invalid locale) Current accepted locales can be seen above in the Want to add your own language section
• Enable/Disable search engine visiblility with ALLOW_GOOGLE_VISIBILITY with true / false values. Default disable visiblility.
• Change root URI for Stirling-PDF ie change server.com/ to server.com/pdf-app by running APP_ROOT_PATH as pdf-app
• Disable and remove endpoints and functionality from Stirling-PDF. Currently the endpoints ENDPOINTS_TO_REMOVE and GROUPS_TO_REMOVE can include comma seperated lists of endpoints and groups to disable as example ENDPOINTS_TO_REMOVE=img-to-pdf,remove-pages would disable both image to pdf and remove pages, GROUPS_TO_REMOVE=LibreOffice Would disable all things that use LibreOffice. You can see a list of all endpoints and groups here
• Change the max file size allowed through the server with the environment variable MAX_FILE_SIZE. default 2000MB
• Customise static files such as app logo by placing files in the /customFiles/static/ directory. Example to customise app logo is placing a /customFiles/static/favicon.svg to override current SVG. This can be used to change any images/icons/css/fonts/js etc in Stirling-PDF
• Enable/Disable metric api endpoints with ENABLE_API_METRICS. Default enabled

API

For those wanting to use Stirling-PDFs backend API to link with their own custom scripting to edit PDFs you can view all existing API documentation here or navigate to /swagger-ui/index.html of your stirling-pdf instance for your versions documentation (Or by following the API button in your settings of Stirling-PDF)

Login authentication (CURRENTLY ALPHA TAG ONLY)

Prerequisites:

• User must have the folder ./configs volumed within docker so that it is retained during updates.
• The environment variable 'login.enabled' must be set to true
• The environment variables "INITIAL_USERNAME" and "INITIAL_PASSWORD" must also be populated (only required on first boot to create initial user, ignored after.)

Once the above has been done, on restart a new stirling-pdf-DB.mv.db will show if everything worked.

When you login to Stirling PDF you will be redirected to /login page to login with those credentials. After login everything should function as normal

To access your account settings go to Account settings in the settings cog menu (top right in navbar) this Account settings menu is also where you find your API key.

To add new users go to bottom of Account settings and hit 'Admin Settings', here you can add new users. The different roles mentioned within this are for rate limiting. This is a Work in progress which will be expanding on more in future

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?

• Crop
• Progress bar/Tracking
• Full custom logic pipelines to combine multiple operations together.
• Folder support with auto scanning to perform operations on
• Redact sections of pages
• Add page numbers
• Auto rename (Renames file based on file title text)
• URL to PDF
• Change contrast

Q2: Why is my application downloading .htm files?

This is a issue caused commonly by your NGINX congifuration. 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.