Sign inSign up

pdftoolsag/ocr-service-worker

By pdftoolsag

Updated 3 months ago

Pdftools OCR Service Worker: OCR processing engine for the Pdftools OCR Service

Image
Integration & delivery
Content management system
0

650

pdftoolsag/ocr-service-worker repository overview

About This Image

The Pdftools OCR Service Worker is the processing engine of the Pdftools OCR Service. It performs the actual OCR recognition on submitted documents and returns results to the OCR Service Manager.

For more information, please see the online documentation.

How to Use the Image

The OCR Service Worker is used together with the OCR Service Manager. Both images are required for a functional deployment.

Using Docker Compose

services:
  manager:
    image: pdftoolsag/ocr-service-manager:TAG
    ports:
      - "7982:8080"
    environment:
      - ServiceCommunication__ServiceCommunicationType=Rest
      - ServiceCommunication__ConnectionString=http://worker:8080
      - PortNumber=8080
    volumes:
      - pdftools-data:/var/lib/pdftools
      - pdftools-db:/usr/share/Pdftools
      - pdftools-logs:/var/log/pdftools

  worker:
    image: pdftoolsag/ocr-service-worker:TAG
    shm_size: "2gb"
    ports:
      - "7998:8080"
    environment:
      - Licensing__LicenseKey=PDFTOOLS_LICENSE_KEY
      - PortNumber=8080
    volumes:
      - pdftools-data:/var/lib/pdftools
      - pdftools-logs:/var/log/pdftools

volumes:
  pdftools-data:
  pdftools-db:
  pdftools-logs:

Note: The worker requires at least 2 GB of shared memory (shm_size: "2gb") for the OCR engine.

PDFTOOLS_LICENSE_KEY is your Pdftools OCR license key, required for the worker to process documents. TAG is the image tag.

Environment Variables

VariableDefaultDescription
Licensing__LicenseKeyRequired. Your Pdftools OCR license key
Licensing__LgsURLLicense Gateway Service URL (optional, for offline/proxy licensing via license-gateway)
FileStorage__FileStorageTypeHostFileSystemStorage backend (HostFileSystem, MinIO)
FileStorage__FilesDirectoryPath/var/lib/pdftools/filesPath for file storage (when using HostFileSystem)
ServiceCommunication__ServiceCommunicationTypeRestCommunication protocol with the manager (Rest, RabbitMQ, PostgreSql)
PortNumber8080Internal listening port
LogFilePath/var/log/pdftools/worker-log.txtLog file location
LogRetentionDays7Number of days to retain log files

Volumes

PathDescription
/var/lib/pdftoolsShared file storage for input and output documents (shared with manager)
/var/log/pdftoolsApplication logs

System Requirements

  • Shared memory: Minimum 2 GB (shm_size: "2gb")
  • CPU: The worker spawns one OCR process per available CPU core (up to 8 cores)

Health Checks

EndpointDescription
GET /healthz/startupStartup probe — checks worker service status
GET /healthz/readyReadiness probe — checks worker service status
GET /healthz/liveLiveness probe — checks worker service status

License

Pdftools is a world leader in PDF software, delivering reliable PDF products to international customers in all market segments.

Pdftools provides server-based software products designed specifically for developers, integrators, consultants, customizing specialists and IT departments. Thousands of companies worldwide use our products directly and hundreds of thousands of users benefit from the technology indirectly via a global network of OEM partners. Our tools can be easily embedded into application programs and are available for a multitude of operating system platforms.

OCR Service is copyrighted by PDF Tools AG.

Tag summary

Content type

Image

Digest

sha256:f854d9f66

Size

2.2 GB

Last updated

3 months ago

docker pull pdftoolsag/ocr-service-worker:1.1.4