Sign inSign up

pdftoolsag/ocr-service-manager

By pdftoolsag

Updated 3 months ago

Pdftools OCR Service Manager: Job orchestrator for document OCR processing

Image
Integration & delivery
Content management system
0

811

pdftoolsag/ocr-service-manager repository overview

About This Image

The Pdftools OCR Service Manager is the job orchestrator for the Pdftools OCR Service. It receives document processing requests, manages job lifecycle, and coordinates work with one or more OCR Service Workers.

For more information, please see the online documentation.

How to Use the Image

The OCR Service Manager works together with the OCR Service Worker. 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
ServiceCommunication__ServiceCommunicationTypeRestCommunication protocol with the worker (Rest, RabbitMQ, PostgreSql)
ServiceCommunication__ConnectionStringWorker connection string (e.g. http://worker:8080 for REST)
Database__DatabaseTypeSqlLiteDatabase backend (SqlLite, PostgreSql)
Database__DeleteJobsAfterDays2Number of days before completed jobs are automatically deleted
FileStorage__FileStorageTypeHostFileSystemStorage backend (HostFileSystem, MinIO)
FileStorage__FilesDirectoryPath/var/lib/pdftools/filesPath for file storage (when using HostFileSystem)
FileStorage__DeleteFilesAfterDays2Number of days before files are automatically deleted
MaxRequestBodySizeBytes104857600Maximum upload size in bytes (default 100 MB)
PortNumber8080Internal listening port
LogFilePath/var/log/pdftools/manager-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 worker)
/usr/share/PdftoolsDatabase storage
/var/log/pdftoolsApplication logs

Health Checks

EndpointDescription
GET /healthz/startupStartup probe — checks database connectivity
GET /healthz/readyReadiness probe — checks database connectivity
GET /healthz/liveLiveness probe — always returns healthy

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:e468380fd

Size

119 MB

Last updated

3 months ago

docker pull pdftoolsag/ocr-service-manager:1.1.4