MERLIC Directory Agent Configuration File

MERLIC automatically checks for a configuration file of the Directory Agent when starting any MERLIC application. If no configuration file could be found, usually after installing MERLIC for the first time, it is automatically created. It can be used to adjust the configuration for the Directory Agent, for example, to configure the TCP server or the Transport Layer Security (TLS) for remote connections.

Location

By default, the configuration file for the Directory Agent is created in the same directory as the MERLIC5.ini file.

Windows

On Windows, the configuration file is created in the directory "C:\Users\<username>\AppData\Roaming\MVTec". You can also enter "%APPDATA%\MVTec" into your file explorer to reach that directory.

Linux

On Linux, the configuration file is created in the directory "~/.config/MVTec/".

File Name and Format

The configuration file for the Directory Agent is named "directory_agent_config.jsonc" and is defined in JSONC format by default. Therefore, the non-standard JSON comments (JSONC) extension is allowed. Alternatively, the file can be named "directory_agent_config.json" if the standard JSON format is preferred.

Configuring the MERLIC Directory Agent

If you want to change the configuration for the Directory Agent process, you can use the default configuration file as starting point. It contains default-equivalent contents which include instructions as JSON comments.

Default configuration for the Directory Agent

Copy

{
  "$schema": "http://download.mvtec.com/directory-agent-config-v1.0.schema.json",
  "Version": "1.0",

  // By default, services are not exposed to the network and can only be
  // accessed by the local user.
  "TCP": null
}

JSON Schema and Editor Support

MVTec hosts JSON schema definitions for the configuration file of the Directory Agent. Using a modern text editor with support for JSONC can simplify the process of authoring the configuration file in various ways:

• Keys and attributes in the configuration file can be auto-completed by the editor according to the schema definition.
• The editor can display descriptions which are given in the schema, for example when hovering over keys and attributes in the configuration file.
• Many common errors when authoring the sequence files can be caught early, for example, missing mandatory keys, invalid values, or wrong data types.

The default configuration file for the Directory Agent includes the following key in the top-level object of configuration file to benefit from the JSON schema:

"$schema": "http://download.mvtec.com/directory-agent-config-v1.0.schema.json",

Available Configuration Settings

In the following sections, you will find information on the configuration settings that can be adjusted via the configuration file.

When specifying file paths and using backslashes as path separator, make sure to escape them (\\). Alternatively, you may use forward slashes (/) as path separator.

Top-Level Settings

TCP Server

Logging

The log files of the Directory Agent are named "merlic_directory_agent.*.log" and are written to the same folder as other MERLIC log files by default.

Changing the Configuration Directory

If you want to use a different location for the configuration file for the Directory Agent, you can change the configuration directory using the environment variable MERLIC_DIRECTORY_AGENT_CONFIG_DIR. The configuration file for the Directory Agent will then be expected in the specified location.