DGNum/Stirling-PDF
15
0
Fork 0
Code Issues 4 Pull requests 1 Projects Releases Packages Wiki Activity

documentation

Browse source
This commit is contained in:
Anthony Stirling 2023-05-06 16:10:06 +01:00
parent 654f7742e4
commit 4b4cdb85ff
3 changed files with 31 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
HowToUseOCR.md
View file

@ -34,14 +34,14 @@ services:
your_service_name: your_service_name:
image: your_docker_image_name image: your_docker_image_name
volumes: volumes:
- /usr/share/tesseract-ocr/4.00/tessdata:/location/of/trainingData - /location/of/trainingData:/usr/share/tesseract-ocr/4.00/tessdata
``` ```
#### Docker run #### Docker run
Add the following to your existing docker run command Add the following to your existing docker run command
```bash ```bash
-v /usr/share/tesseract-ocr/4.00/tessdata:/location/of/trainingData -v /location/of/trainingData:/usr/share/tesseract-ocr/4.00/tessdata
``` ```
#### Non-Docker #### Non-Docker

30
README.md
View file

@ -21,7 +21,10 @@ Feel free to request any features or bug fixes either in github issues or our [D
- Merge multiple PDFs together into a single resultant file - Merge multiple PDFs together into a single resultant file
- Convert PDFs to and from images - Convert PDFs to and from images
- Reorganize PDF pages into different orders. - Reorganize PDF pages into different orders.
- Add images to PDFs at specified locations. (WIP) - Add/Generate signatures
- Flatten PDFs
- Repair PDFs
- Add images to PDFs
- Rotating PDFs in 90 degree increments. - Rotating PDFs in 90 degree increments.
- Compressing PDFs to decrease their filesize. (Using OCRMyPDF) - Compressing PDFs to decrease their filesize. (Using OCRMyPDF)
- Add and remove passwords - Add and remove passwords
@ -35,6 +38,7 @@ Feel free to request any features or bug fixes either in github issues or our [D
- Dark mode support. - Dark mode support.
- Custom download options (see [here](https://github.com/Frooodle/Stirling-PDF/blob/main/images/settings.png) for example) - Custom download options (see [here](https://github.com/Frooodle/Stirling-PDF/blob/main/images/settings.png) for example)
- Parallel file processing and downloads - Parallel file processing and downloads
- API for integration with external scripts
## Technologies used ## Technologies used
- Spring Boot + Thymeleaf - Spring Boot + Thymeleaf
@ -64,16 +68,34 @@ https://hub.docker.com/r/frooodle/s-pdf
Docker Run Docker Run
``` ```
docker run -p 8080:8080 frooodle/s-pdf docker run -d \
-p 8080:8080 \
-v /location/of/trainingData:/usr/share/tesseract-ocr/4.00/tessdata \
--name stirling-pdf \
frooodle/s-pdf
Can also add these for customisation
-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" \
``` ```
Docker Compose Docker Compose
``` ```
version: '3.3' version: '3.3'
services: services:
s-pdf: stirling-pdf:
image: frooodle/s-pdf
ports: ports:
- '8080:8080' - '8080:8080'
image: frooodle/s-pdf volumes:
- /location/of/trainingData:/usr/share/tesseract-ocr/4.00/tessdata #Required for extra OCR languages
# - /location/of/extraConfigs:/configs
# environment:
# APP_HOME_NAME: Stirling PDF
# APP_HOME_DESCRIPTION: Your locally hosted one-stop-shop for all your PDF needs.
# APP_NAVBAR_NAME: Stirling PDF
``` ```

2
build.gradle
View file

@ -5,7 +5,7 @@ plugins {
} }
group = 'stirling.software' group = 'stirling.software'
version = '0.7.0' version = '1.0.0'
sourceCompatibility = '17' sourceCompatibility = '17'
repositories { repositories {