Class Installation

A static class providing everything needed to configure the installation and licensing of IronOCR

Inheritance
System.Object
Installation
Namespace: IronOcr
Assembly: IronOcr.dll
Syntax
public static class Installation : Object

Configure how IronOCR is installed, licensed, and logged across an application through Installation. It is the single static place to set engine paths, apply a license, and turn on diagnostics, so application startup can settle every cross-cutting setting before the first read. The licensing members it carries are also available on the focused License class; reach for Installation when paths, logging, or dependency setup belong in the same configuration block.

Because the class is static, you assign and read its members directly, typically once at startup. Settings take effect for every subsequent OCR call in the process, which is why this is configured ahead of any IronTesseract read rather than per read.

Its members group into three buckets. **Paths**: InstallationPath is the IronOCR install location, LanguagePackDirectory points at custom .ocrdata language files, and MachineLearningModelsDirectory holds the ML files behind the advanced-scan reads. **Licensing**: set LicenseKey to remove the watermark, read IsLicensed to confirm the running instance is licensed, and call IsValidLicense to validate a key string. **Logging and environment**: LoggingMode selects how detailed developer messages are emitted, LogFilePath directs them to a file, CustomLogger swaps in your own logger, Log writes a message to the enabled outputs, and ClearLogFiles removes existing log files. LinuxAndDockerDependenciesAutoConfig lets IronOCR install the native packages it needs on Linux and Docker automatically.

IronOcr.Installation.LicenseKey = "IRONOCR-MYLICENSE-KEY-1EF01";
IronOcr.Installation.LoggingMode = IronOcr.Installation.LoggingModes.All;
IronOcr.Installation.LinuxAndDockerDependenciesAutoConfig = true;

The Iron Tesseract how-to sets up a configured read, the debugging how-to uses the logging members, and the configure and set up Tesseract example puts the options together.

Properties

CustomLogger

Custom logger implementation

Declaration
public static ILogger CustomLogger { get; set; }
Property Value
Type Description
Microsoft.Extensions.Logging.ILogger

InstallationPath

IronOcr installation path

Declaration
public static string InstallationPath { get; set; }
Property Value
Type Description
System.String

IsLicensed

Determines whether this instance of IronOcr is Licensed. Will return false unless a LicenseKey is set to a valid trial or full license key in IronOcr.Installation.LicenseKey, Web.Config , App.Config or appsettings.json in .Net Core.

Declaration
public static bool IsLicensed { get; }
Property Value
Type Description
System.Boolean

LanguagePackDirectory

Custom language pack directory which contains .ocrdata language pack files

Declaration
public static string LanguagePackDirectory { get; set; }
Property Value
Type Description
System.String

LicenseKey

Removes watermarks. Get Licensed at https://ironsoftware.com/

Declaration
public static string LicenseKey { get; set; }
Property Value
Type Description
System.String

LinuxAndDockerDependenciesAutoConfig

If true The necessary package dependencies for IronOCR rendering will we automatically installed to Docker and Debian / Ubuntu Linux deployments.

Applies only to IronOCR for .Net Core.

This will take a few minutes the next time you run IronOCR. Watch the Visual Studio "Output" window for progress.

Set this to false if manual Docker / Linux setup is more convenient: https://ironsoftware.com/csharp/ocr/docs/questions/csharp-tesseract-ocr-docker-linux-setup-tutorial/

Declaration
public static bool LinuxAndDockerDependenciesAutoConfig { get; set; }
Property Value
Type Description
System.Boolean
See Also
IronSoftware.Deployment.DeploymentEngine.SkipInstallCommands

LogFilePath

Setting a log path produces ‘log files’ which may be vey useful for debugging in production or providing to Iron Software support when reporting an issue.

LogFilePath may be set to a directory name or a full file name.

Setting LogFilePath = null will turn off log files.

Declaration
public static string LogFilePath { get; set; }
Property Value
Type Description
System.String
See Also

LoggingMode

Activate or disable detailed developer messages sent to your choice of location in the IDE or application console.

Declaration
public static Installation.LoggingModes LoggingMode { get; set; }
Property Value
Type Description
Installation.LoggingModes

MachineLearningModelsDirectory

Directory containing machine learning files for advanced scan OCR features.

This path can be set manually. If not set (or set to null/whitespace), it falls back to the default path relative to the installation.

Declaration
public static string MachineLearningModelsDirectory { get; set; }
Property Value
Type Description
System.String

Methods

ClearLogFiles()

Removes any Iron Software log files at the LogFilePath.

Declaration
public static void ClearLogFiles()
See Also

IsValidLicense(String)

Checks if a given license key is valid for use with IronOCR.

Declaration
public static bool IsValidLicense(string LicenseKey)
Parameters
Type Name Description
System.String LicenseKey

Full License Key provided as a string.
Returns
Type Description
System.Boolean

True when a valid key is given.

Log(String)

Logs a message to enabled log outputs

Declaration
public static void Log(string message)
Parameters
Type Name Description
System.String message