Skip to main content
This topic also exists for Linux.
This section provides instructions for running ABBYY FineReader Engine 12 inside a Docker container. This scenario uses two containers:
  1. one container with ABBYY FineReader Engine
  2. one container with the Licensing Service
Implementing of this scenario increases the fault tolerance and ensures the continuous operation of all containers. If one of the containers fails, you can restart it without interrupting the other. An Online License, which connects to *.abbyy.com license server, is used for this scenario.
ABBYY Licensing Service can work with only one Online License at the same time.
You need:
You need to fulfill the following conditions for using an Online License wherever ABBYY Licensing Service is installed:
  • Active Internet connection
  • Allowed connections to *.abbyy.com on port 443 (HTTPS)
  • GoDaddy Trusted Root Certification Authority
GoDaddy root certificate for the Certification Authority should be installed in the local machine version of the Trusted Root Certification Authorities certificate store. See the detailed information about the certificate on the GoDaddy website.
To run ABBYY FineReader Engine 12 in Docker container:
  1. Download and install Docker for Windows on your machine.
  2. Enable Hyper-V and Containers Windows features.
  3. Select the “Use Windows containers instead of Linux containers” option during the container installation.
  4. Create an empty directory and put into it:
  • docker-compose.yml — a configuration of Docker Compose (See its listing below)
  • TestAppFolder — a directory with
    • Online License token file
    • test application compiled to use this token file as well as the password to it and your Customer Project ID
  • Dockerfile_ls — a Dockerfile for container with the Licensing Service (See its listing below)
Dockerfile_ls is intended for building a container that will be working with only one container built from Dockerfile_worker . Do not configure multiple replicas of container with ABBYY FineReader Engine to work with a single Licensing Service.
  • LicensingSettings_ls.xml - a file with parameters of licensing for the Licensing Service (See its listing below)
  • DeployLS.ps1 — a script for launching the Licensing Service (See its listing below)
Note: This script runs the Licensing Service with /standalone key. With this key, the Licensing Service works as a foreground process, which is the best practice for working in Docker containers.
  • Dockerfile_worker — a Dockerfile for container with ABBYY FineReader Engine and test application (See its listing below)
  • LicensingSettings_worker.xml - a file with parameters of licensing for the ABBYY FineReader Engine library (See its listing below)
  • SetUpWorkerLicensing.ps1 - a script for replacing the server name in LicensingSettings_worker.xml with the name specified in docker-compose.yml (See its listing below)
  • RunTestApp.ps1 — a command-line script to run the test application (See its listing below)
  1. Unpack the ABBYY FineReader Engine distributive package to the previously created directory with the command:
installRnt64.exe /extract InstallDir="<your_directory>/FRE"
  1. To build and run the containers, use the following command:
docker-compose up
The results of running the test application will be displayed in the console.
If you use Windows Server Core as a container base image, set the fonts after deploying ABBYY FineReader Engine, as described in Working with Fonts
version: '3'
services:
  ls:
    build:
      context: .
      dockerfile: Dockerfile_ls
    hostname: servername
    networks:
      frenet:
        aliases:
          - servername
    restart: on-failure
  worker:
    build:
      context: .
      dockerfile: Dockerfile_worker
      args:
        - service_address=servername
    depends_on:
      - ls
    networks:
      frenet:
    restart: on-failure
networks:
  frenet:
Dockerfile_ls
# Copy the Licensing Service
FROM mcr.microsoft.com/windows/servercore:ltsc2019 as fre12_ls
WORKDIR /app
ADD ./FRE/Licensing /app/FRE_Licensing
ADD ./LicensingSettings_ls.xml /app/FRE_Licensing/LicensingSettings.xml
WORKDIR /app/FRE_Licensing
# Installing the Licensing Service
COPY ./DeployLS.ps1 /app/DeployLS.ps1
EXPOSE 3022
SHELL ["powershell", "-Command", "$ErrorActionPreference = 'Stop'; $ProgressPreference = 'SilentlyContinue';"]
ENTRYPOINT /app/DeployLS.ps1
LicensingSettings_ls.xml
<?xml version="1.0" encoding="utf-8"?>
<LicensingSettings xmlns="http://www.abbyy.com/Protection/LicensingSettings">
  <LocalLicenseServer>
    <ConnectionProtocol ProtocolType="TCP/IP" />
  </LocalLicenseServer>
</LicensingSettings>

echo "Preparing logging folder:"
$folder = "C:\ProgramData\ABBYY\SDK\12\Licenses"
echo $folder
if( (Test-Path -Path $folder) -ne $True ) {
    New-Item -Path $folder -ItemType Directory
}
echo "LicensingSettings.xml found:"
cd "C:/app/FRE_Licensing"
type LicensingSettings.xml
echo "Starting license service..."
.\LicensingService.exe /standalone
 
echo "License service stopped."
return 500
Dockerfile_worker
FROM mcr.microsoft.com/windows/servercore:ltsc2019 as fre12installation
# Copy extracted library to the folder C:/app/FRE12
ARG library_src="./FRE/FineReader Engine"
ADD $library_src /app/FRE12
ADD ./LicensingSettings_worker.xml /app/FRE12/Bin64/LicensingSettings.xml
# Replace <service_address> in worker LicensingSetting.xml
ARG service_address
COPY ./SetUpWorkerLicensing.ps1 /app/SetUpWorkerLicensing.ps1
SHELL ["powershell", "-Command", "$ErrorActionPreference = 'Stop'; $ProgressPreference = 'SilentlyContinue';"]
RUN /app/SetUpWorkerLicensing.ps1 -ServerAddress $service_address
# Copy and run a test application
COPY ./TestAppFolder /app/TestAppFolder
COPY ./RunTestApp.ps1 /app/RunTestApp.ps1
CMD /app/RunTestApp.ps1
LicensingSettings_worker.xml
<?xml version="1.0" encoding="utf-8"?>
<LicensingSettings xmlns="http://www.abbyy.com/Protection/LicensingSettings">
  <LicensingServers>
    <MainNetworkLicenseServer ServerAddress="<server_address>" ProtocolType="TCP/IP" />
  </LicensingServers>
</LicensingSettings>

Param (
[string]$service_address
)
# Script for preparing client licensing log folder and setting ServerAddress to LicesingSettings.xml
echo "Preparing logging folder:"
echo "C:\ProgramData\ABBYY\SDK\12\Licenses"
New-Item -Path "C:\ProgramData\ABBYY\SDK\12\Licenses" -ItemType Directory
echo "LicensingSettings.xml found:"
cd "C:/app/FRE12/Bin64"
type LicensingSettings.xml
echo "Setting service address to: "
echo $service_address
((Get-Content -path LicensingSettings.xml -Raw) -replace '<server_address>',$Env:service_address) `
| Set-Content -Path LicensingSettings.xml
echo "LicensingSettings.xml was set:"
type LicensingSettings.xml

# Script for running a test application from TestAppFolder folder
# Launching the test application with arguments (CommandLineInterface.exe is used as the test application)
cd C:\app\TestAppFolder
.\CommandLineInterface.exe  -pi -if Demo.tif -f PDF -of Demo.pdf
# For using the CommandLineInterface code sample in a Docker container, you need to:
# 1)specify data for Docker container in SamplesConfig.h:
# - GetLicensePath, GetCustomerProjectId, GetLicensePassword
# - L"C:\\app\\FRE12\\Bin64\\FREngine.dll" as GetFreDllPath
# 2)rebuild your project for x64 configuration.
# 3)copy the CommandLineInterface.exe, *.ABBYY.ActivationToken license file
#  and demo image (Demo.tif) in the folder \TestAppFolder.

​
See also

Installing the Licensing Service on Windows Licensing Activation