Skip to content

Getting Started

The Document Reader SDK is distributed as:

  • Package repositories for popular Linux distributions, including Ubuntu, CentOS, and Debian
  • Standalone installer or Regula Downloads Manager for Windows
  • Docker image ready for popular platforms, such as OpenShift and Kubernetes
  • Cloud deployment, for example, on Amazon Web Services

Worker Model

By default, the Web Service starts with one worker process. Each worker handles documents in a single-threaded mode that means that it can process only one request at a time. The number of workers is limited by available hardware resources.

See also: Performance Optimization

Licensing

For the Document Reader SDK web service, Online and Software licensing types are available, see details on the Licensing page.

See also: How to perform the licensing service health check

Minimum System Requirements

The minimum acceptable hardware: 1 CPU and 2 GB RAM per worker.

Versioning

The version A.B.C.D.E is composed of:

  • A.B for the Regula SDK version
  • C for the document database version
  • D for the service wrapper version
  • E for the patch number

For example, the 5.2.103350.140.p1 version should be interpreted as follows:

  • 5.2 is the Regula SDK version
  • 103350 is the current document database version
  • 140 is the web service wrapper version
  • p1 is the patch number (contains security or bug fixes)

Supported Image File Formats

Document Reader SDK Web Service supports the following image file formats:

  • BMP
  • PNG
  • JPG / JPEG / JP2
  • TIF / TIFF
  • WebP
  • DAT
  • PDF