Skip to content

Web Server Configuration

config.yaml
service:
  mode: inProc

  webServer:
    port: 8080
    workers: 2
    timeout: 30
    workerConnections: 3000
Parameter Type Default Description
mode string inProc
N/A for Windows		 Mode in which the Document Reader Web Service is operated: inProc or outProc. See details in the Service Mode section.
webServer → port integer 8080 Port number for the web server. If the environment variable DOCREADER_BIND is set, then the value is taken from there, regardless of the YAML parameter.
webServer → workers integer 1
N/A for Windows		 Number of workers to process requests. For Windows 1 is the only option; for other OS, you can set another number, depending on available hardware resources.
webServer → timeout integer 30
N/A for Windows		 Number of seconds for the worker to process the request. For Windows a timeout is not applied, the parameter's value is ignored. Workers that remain idle for more than this number of seconds are killed and restarted.
webServer → maxRequests integer 0
N/A for Windows		 Maximum number of requests a worker will process before restarting. See details in Gunicorn documentation
webServer → maxRequestsJitter integer 0
N/A for Windows		 Maximum jitter to add to the max_requests value. See details in Gunicorn documentation
webServer → gracefulTimeout integer 30
N/A for Windows		 Timeout for graceful workers restart. See details in Gunicorn documentation
webServer → keepalive integer 2
N/A for Windows		 Number of seconds to wait for requests on a Keep-Alive connection. See details in Gunicorn documentation
webServer → workerConnections integer 1000
N/A for Windows		 Maximum number of simultaneous clients. See details in Gunicorn documentation

Service Mode

The Document Reader Web Service can be operated in one of two modes:

  • inProc—in-process mode (default). The configured number of workers are launched internally on the Web Server. Each worker runs a separate instance of the Document Reader Core.
  • outOfProc—out-of-process mode. The single worker handles all processing, while the defined number of external processes (as configured in the workers parameter) are created and run independently of the Web Server. Each process runs its own Document Reader Core instance. This mode isolates the Core from the Web Server, providing better reliability, lower dependency on shared libraries, and improved memory management.

Note

On Windows, only the in-process mode is available due to single-worker limitation.

System Information

config.yaml
sdk:
  systemInfo:
    license: "UmVndWxhIGV4YW1wbGUgbGljZW5zZSBzdHJpbmc="
    returnSystemInfo: false
Parameter Type Default Description
license boolean — Specifies the license as a Base64-encoded string.
returnSystemInfo boolean true Whether to return the system information in the /api/ping and /api/process response.