Skip to main content

Pdftools OCR Service licensing

The Pdftools OCR Service validates license keys either directly or through the Licensing Gateway Service (LGS). By default, the service validates license keys directly against the Pdftools Licensing Service. This is online only and requires a network connection. To run without a continuous network connection, route licensing through the LGS. For more information, see Use the Licensing Gateway Service.

Product documentation

For information about using Pdftools OCR Service, review Pdftools OCR Service documentation.

Use the Licensing Gateway Service​

To let the Pdftools OCR Service operate without a continuous internet connection, route licensing through the Licensing Gateway Service (LGS). Offline licensing is available only through the LGS. The LGS runs in Connected mode (partially offline) or Full offline mode.

To set up the LGS, follow these steps:

  1. Download and install the LGS on a machine in your network. The download page provides a Windows installer and a Linux snap. Refer to Install the LGS.
  2. Configure the LGS for Connected mode or Full offline mode.
  3. Point each worker at the LGS by setting the LgsURL value, as described in Set the Licensing Gateway Service URL.

Set the Licensing Gateway Service URL​

After you configure the LGS, set the LgsURL value on each worker to the machine where you configured the LGS. The location depends on your platform.

Windows​

To set the URL on Windows, follow these steps:

  1. Open the worker’s appsettings.json. The default path is C:\Program Files\Pdftools\Pdftools OCR Service\PdftoolsOcrWorker\appsettings.json.
  2. Set the LgsURL value: 
    "LgsURL": "http://localhost:9999"

Docker​

To set the URL in Docker, follow these steps:

  1. Open your docker-compose.yaml file.
  2. Set the Licensing__LgsURL environment variable on the worker container: 
    - Licensing__LgsURL=http://localhost:9999

Linux​

To set the URL on Linux, follow these steps:

  1. Open the worker’s appsettings.json at /opt/pdftools/ocr-worker/appsettings.json.
  2. Set the LgsURL value: 
    "LgsURL": "http://localhost:9999"

For more information, review Default appsettings.json in Pdftools OCR Service documentation.