Setting deployment options

Below is a list of application settings that you can change by redefining variables when deploying ABBYY OCR Container:

Parameter Description
General
ASPNETCORE_URLS

Specifies the port in the container on which the application is running.

By default, the application uses port 5000. If you want to set a different port, for example, port 80, set the value of the parameter to "http://+:80".

EulaAccepted

Specifies whether the EULA has been accepted.

Set the value of the parameter to true if you have read and accept the terms of the agreement.

Kestrel__Limits__MaxRequestBodySize

Specifies the maximum size of the request body in bytes.

The request body size limit affects the maximum size of the input image file. The default value of the parameter is "2147483648", which corresponds to 2 GB.

Licensing__WorkingDirectory

Specifies the folder where the license files will be stored.

By default, the license is stored in the /app/bin/linux/License folder in the container. When running the container in production, to store the license, you need to mount a folder in the cluster storage, so that all container replicas can share the same license. When deploying the container, set the value of the parameter to the path to this folder, for example "/mnt/license_data".

LicensingHqClient__Proxy__Use

Specifies whether a proxy will be used to send requests to the license server.

The value of the parameter can be true or false.

LicensingHqClient__Proxy__Uri A string containing the proxy address, including the port.
LicensingHqClient__Proxy__Domain The domain where the user is located.
LicensingHqClient__Proxy__UserName The username to authenticate on the proxy server.
LicensingHqClient__Proxy__Password The user password to authenticate on the proxy server.
RecognizeService__ProcessingTimeoutSeconds

Specifies the maximum time (specified in seconds) that an application can take to process an API request.

By default, the value of the parameter is "3600" (60 minutes). Processing large multi-page documents can take a long time (perhaps up to several hours). In this case, you may need to increase the response timeout of the container and your infrastructure (ingress, load balancer, etc.). In the container, you can do this by changing the value of this parameter.

Authorization
Authentication__Type

Specifies the authentication type to be used.

The value of the parameter can be Certificate or None.

Authentication__CertPath Specifies the folder where the root certificate file is stored.
Authentication__CertPassword The password for the root certificate.
Authentication__CertHeaderName The name of the HTTP header in which the client certificate will be transmitted. Mandatory only if the certificate will be transmitted in the HTTP header.
Authentication__CertHeaderEncoding

Specifies the method for encoding the client certificate in the HTTP-header. Mandatory only if the certificate will be transmitted in the HTTP header.

The value of the parameter can be Base64 or UrlEncoded.

HTTPS
Network__HttpsCertPath Specifies the folder where the SSL certificate file is stored.
Network__HttpsCertPassword The password for the SSL certificate.
Network__HttpDisabled

Specifies whether the unencrypted HTTP endpoint will be disabled.

The value of the parameter can be true or false.

The default value of the parameter is false.

19.02.2024 10:23:36

Usage of Cookies. In order to optimize the website functionality and improve your online experience ABBYY uses cookies. You agree to the usage of cookies when you continue using this site. Further details can be found in our Privacy Notice.