Quick Start Guide for ABBYY FineReader Engine 12 Linux

FineReader Engine
Knowledge Base & Support
General Features
Tips & How to Information

Before you start: Download ABBYY FineReader Engine SDK on your computer using the link from the email you've received from ABBYY with the license information.

SDK Installation

  1. To install the FineReader Engine 12 Linux run the self-extracting archive file %archive_name%.sh from the command line:


    • You can run the archive file without any parameters. The installation will run in an interactive mode and you will be prompted to enter the necessary information during the installation. You can as well run the archive file with certain options. For more details please refer to the User Guide of the product the chapter 'Distribution'.
    • The installation of the licensing service and license activation requires ROOT rights.
    • We recommend to run the installation of the FineReader Engine under ROOT user.
    • To change the current user to the ROOT use the command 'su root' (if you have a password of the ROOT) or the command 'sudo su' (the password of the current user is required).
  2. Read and Accept End User License Agreement (EULA):
  3. Continue the installation by entering 'y':
  4. Specify the installation folder for the FineReader Engine 12:
    1. if you want to use the default folder, which is /opt/ABBYY/FREngine12, enter 'y'
    2. if you want to use a different folder, enter 'n' and specify your own directory.
      In this guide we are using the default directory.
  5. Specify the installation type:
  6. Specify the activation type:

    For the Trial License (Software or Online) select the Local License Server. Remote License Server is used for a network license.
  7. Set license parameters:
    1. enter the Project ID:
    2. if you are installing the Software license, then enter 'n':
    3. if you are installing the Online license, then enter 'y' and set the required parameters (password and path to the activation file):
  8. Choose the option for the licensing service to install:

    The option 2) may be useful, if the Licensing Service was already installed on the machine before and you do not need to install it again, just want to run it.

License activation

  • Software License
  • Online License

Software License

  1. Right after the FineReader Engine 12 installation you will be asked to activate the license:
    1. Enter your serial number:
    2. Select the connection method for the license activation:

      If you have an Internet connection, we recommend to choose ‘Internet’ method. In this case the activation is carried out automatically and takes only a few seconds.
      In the case of activation 'by e-mail', you will need to load the activation file by specifying the path to the activation file received from ABBYY.

      Activation information is sent as a code (Installation ID), which is generated on the basis of information about the computer on which the program is being installed. No personal information about the user or computer is used for generating this code and it cannot be used for identifying the user.

Online License

The Online License is primarily intended to be used for installations on cloud and virtual environments including the Docker containers in order to ensure uninterrupted operation of FineReader Engine 12. However, it can be used on premise installations as well. Please note that a permanent internet connection is necessary for connecting to an ABBYY licensing server.

  • License activation is not required. The Online License parameters can be reviewed through the License Console
  • Important: Verify that you allow connections to *.abbyy.com on port 443

How to use the Online license

How to use the Online license

  • Call InitializeEngine function. The syntax of this function is the following:
  • The parameters of the InitializeEngine function:
    • Customer Project ID;
    • Full path to Online license Activation Token;
    • Password of your license;
    • [Optional, may be an empty string] Path to the folder, in which ABBYY FineReader Engine should store user-specific data. By default, it is the FineReader Engine data folder: /var/lib/ABBYY/SDK/12/FineReader Engine for automatic installation.
    • [Optional, may be an empty string] Path to the folder for ABBYY FineReader Engine temporary files. By default, it is /tmp/ABBYY FineReader Engine 12 folder.
    • [Optional] A Boolean value that specifies whether the CPU cores should be used in shared mode;
    • A pointer to IEngine pointer variable that receives the interface pointer to the resulting Engine object.

The configuration file will look like (all data will be inserted automatically during an installation):

License Manager Utility

Managing the licenses is possible both through an interactive console interface and via the command line. To enter the interactive mode, run activatefre.sh without any parameters and select the Manage licenses option:

or run LicenseManager.Console without any parameters:

In both cases, you will see the console interface for the License Manager utility and can manage the licenses or review the license parameters:

Start Working with the FineReader Engine 12 Linux

The ABBYY FineReader Engine 12 Linux distribution pack contains a set of sample source codes showing how to use the Engine in common scenarios and illustrating different FineReader Engine technologies. The detailed description of the samples can be found in the Code Samples Library provided with the distribution pack.

Running the Code Samples

All code samples can be found in the Samples folder of the FineReader Engine installation folder. The samples are provided for C++ and/or JAVA:

Before you can run the C++ samples, you need to:

  1. set the environment variable LD_LIBRARY_PATH to the full path to Bin folder of the distribution pack, e.g. 'export LD_LIBRARY_PATH=/opt/ABBYY/FREngine12/Bin'
  2. build the sample, e.g. 'make':
  3. run the built sample:

The build instructions for the JAVA samples you will find in the ReadMe.txt file of the particular code sample.

See also: Code Samples in FineReader Engine 12 Linux.

SDK Usage Scenarios

Before you start the development of your application, please read the Basic Usage Scenarios Implementation chapter in the User Guide of the product, which is located in /opt/ABBYY/FREngine12/Help folder. It describes the most common usage scenarios for ABBYY FineReader Engine. Each article contains a detailed description of the scenario, implementation advice, and suggestions on optimizing the code for specific tasks.

This website uses cookies which enable you to see pages or use other functions of our websites. You can turn off such cookies in your browser’s settings. If you continue to use these pages, you consent to the use of cookies.