Web Server Configuration

config.yaml

service:
  webServer:
    port: 8080
    workers: 2
    timeout: 30
    workerConnections: 3000

Parameter	Type	Default	Description
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.
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.
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.
maxRequests	integer	0 N/A for Windows	Maximum number of requests a worker will process before restarting. See details in Gunicorn documentation
maxRequestsJitter	integer	0 N/A for Windows	Maximum jitter to add to the max_requests value. See details in Gunicorn documentation
gracefulTimeout	integer	30 N/A for Windows	Timeout for graceful workers restart. See details in Gunicorn documentation
keepalive	integer	2 N/A for Windows	Number of seconds to wait for requests on a Keep-Alive connection. See details in Gunicorn documentation
workerConnections	integer	1000 N/A for Windows	Maximum number of simultaneous clients. See details in Gunicorn documentation

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.