MERLIC Directory Agent-Konfigurationsdatei
Beim Start einer beliebigen MERLIC-Anwendung sucht MERLIC automatisch nach einer Konfigurationsdatei des Directory Agents. Wenn keine Konfigurationsdatei gefunden werden kann – was in der Regel nach der erstmaligen Installation von MERLIC der Fall ist – wird diese automatisch erstellt. Mithilfe dieser Datei lassen sich die Einstellungen für den Directory Agent anpassen, beispielsweise für die Konfiguration des TCP-Servers oder von Transport Layer Security (TLS) für Remote-Verbindungen.
Speicherort
Standardmäßig wird die Konfigurationsdatei für den Directory Agent im selben Verzeichnis wie die Datei „MERLIC5.ini“ erstellt.
Windows
Unter Windows wird die Konfigurationsdatei im Verzeichnis „C:\Users\<username>\AppData\Roaming\MVTec“ erstellt. Sie können auch "%APPDATA%\MVTec" im Datei-Explorer eingeben, um zu diesem Verzeichnis zu gelangen.
Linux
Unter Linux wird die Konfigurationsdatei im Verzeichnis „~/.config/MVTec/“ erstellt.
Dateiname und -format
Die Konfigurationsdatei für den Directory Agent trägt den Namen „directory_agent_config.jsonc“ und ist standardmäßig im JSONC-Format definiert. Daher ist die nicht standardmäßige JSON-Kommentarerweiterung (JSONC) zulässig. Alternativ kann die Datei den Namen „directory_agent_config.json“ tragen, falls das Standard-JSON-Format bevorzugt wird.
Den MERLIC Directory Agent konfigurieren
Wenn Sie die Konfiguration für den Directory Agent-Prozess ändern möchten, können Sie die Standardkonfigurationsdatei als Ausgangspunkt verwenden. Diese enthält Inhalte, die den Standardeinstellungen entsprechen, darunter Anweisungen in Form von JSON-Kommentaren.
Standardkonfiguration für den Directory Agent
{
"$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- und Editor-Unterstützung
MVTec hostet JSON-Schema-Definitionen für die Konfigurationsdatei des Directory Agents. Die Verwendung eines modernen Texteditors mit JSONC-Unterstützung kann die Erstellung der Konfigurationsdatei in vielerlei Hinsicht vereinfachen:
- Der Editor kann Schlüssel und Attribute in der Konfigurationsdatei entsprechend der Schema-Definition automatisch vervollständigen.
- Der Editor kann Beschreibungen anzeigen, die im Schema angegeben sind, beispielsweise wenn Sie mit der Maus über Schlüssel und Attribute in der Konfigurationsdatei fahren.
- Beim Erstellen der Sequenzdateien können viele häufige Fehler frühzeitig erkannt werden, beispielsweise fehlende obligatorische Schlüssel, ungültige Werte oder falsche Datentypen.
Um die Vorteile des JSON-Schemas zu nutzen, enthält die Standard-Konfigurationsdatei für den Directory Agent den folgenden Schlüssel im obersten Objekt der Konfigurationsdatei:
"$schema": "http://download.mvtec.com/directory-agent-config-v1.0.schema.json",Verfügbare Konfigurationseinstellungen
In den folgenden Abschnitten finden Sie Informationen zu den Konfigurationseinstellungen, die über die Konfigurationsdatei angepasst werden können.
Wenn Sie Dateipfade angeben und dabei umgekehrte Schrägstriche als Pfadtrennzeichen verwenden, müssen Sie diese maskieren (\\). Alternativ können Sie einen Schrägstrich (/) als Pfadtrennzeichen verwenden.
Einstellungen auf oberster Ebene
|
Taste |
Standardwert |
Beschreibung |
|---|---|---|
|
Assets |
|
Legt Routen zu einer benutzerdefinierten HTML-Seite und den darin referenzierten Dateien fest, die vom Directory Agent bereitgestellt werden, um einen Überblick über die verfügbaren MERLIC-Instanzen zu bieten. Weitere Informationen finden Sie unter HTML-Übersicht über MERLIC-Instanzen. |
|
5 |
Legt fest, wie lange der Directory Agent inaktiv bleibt, bevor er sich abschaltet, wenn keine aktiven Dienstregistrierungen vorliegen. Dies gilt auch unmittelbar nach dem Start des Directory Agents. Der Wert wird in Sekunden festgelegt, kann aber auch als Dezimalbruch angegeben werden. |
|
|
MaxTTL |
3600 |
Legt die maximale Time-to-Live (TTL) fest, die von Diensten beim Directory Agent angefordert werden kann. Wenn sich Dienste beim Directory Agent registrieren, geben sie eine gewünschte TTL an. Die Registrierung bleibt für diese Zeit gültig und muss innerhalb dieses Zeitraums erneuert werden. Der für diese Einstellung angegebene Wert definiert die maximal zulässige TTL, die angefordert werden kann. Dadurch wird sichergestellt, dass Clients keine Dienste mit einer übermäßig langen TTL registrieren können, was zu unerwünschten Dienstregistrierungen führen könnte. Wenn bei einer Registrierung eine längere Zeit angefordert wird, wird die entsprechende TTL auf diesen Maximalwert begrenzt. Der Wert wird in Sekunden angegeben. |
|
Threads |
1 |
Legt die Anzahl der vom Directory Agent verwendeten Threads fest. Bei Bedarf können Sie diese Einstellung nutzen, um den Server des Directory Agents auf eine beliebige Anzahl von Threads zu skalieren und somit mehr Datenverkehr zu bewältigen. Der Directory Agent kann mehr Verbindungen gleichzeitig verarbeiten, als es verfügbare Threads gibt. |
|
TCP |
null |
Legt Einstellungen fest, die sich auf die Erreichbarkeit des HTTP(S)-Servers im Netzwerk über TCP beziehen. Als Wert kann ein JSON-Objekt mit den unter TCP-Server aufgeführten Schlüsseln angegeben werden. Standardmäßig ist der TCP-Server deaktiviert. |
|
Logging |
|
Legt Einstellungen fest, die sich auf die Protokollierungsinformationen für den Directory Agent beziehen. Als Wert kann ein JSON-Objekt mit den unter Protokollieren aufgeführten Schlüsseln angegeben werden. |
TCP-Server
|
Taste |
Beschreibung |
|---|---|
|
IP |
Legt die IP-Adresse der Netzwerkschnittstelle fest, die der HTTP(S)-Server auf eingehende Verbindungen überwacht. Diese muss als IPv4- oder IPv6-Adresse angegeben werden. Hostnamen werden nicht aufgelöst. Um Verbindungen über IPv4 zu akzeptieren, können Sie die Sonderadresse „0.0.0.0“ angeben. Um Verbindungen sowohl über IPv4 als auch über IPv6 auf einer beliebigen Netzwerkschnittstelle zu akzeptieren, können Sie „::“ angeben. |
|
Port |
Legt die Portnummer fest, die der HTTP(S)-Server auf eingehende Verbindungen überwacht. Sie können eine Portnummer im Bereich von 1 bis 65535 wählen. |
|
TLS |
Legt die Konfigurationsgruppe für Einstellungen im Zusammenhang mit der Transport Layer Security (TLS) für den TCP-Server fest. Sie enthält die Spezifikationen für die Zertifikatsdatei und den privaten Schlüssel. Die Transport Layer Security kann durch Setzen dieser Option auf „null“ deaktiviert werden. Die Deaktivierung darf jedoch nur erfolgen, wenn Sie sich der Auswirkungen auf die Cybersicherheit voll bewusst sind. |
|
CertFile |
Legt den absoluten Pfad zur Serverzertifikatsdatei fest, die der HTTPS-Server verwenden soll. Diese Datei darf für andere Benutzer nicht beschreibbar sein. |
|
KeyFile |
Definiert den absoluten Pfad zum privaten Schlüssel, der dem Serverzertifikat entspricht. Diese Datei darf für andere Benutzer weder lesbar noch beschreibbar sein. |
Protokollieren
Die Log-Dateien des Directory Agents tragen den Namen „merlic_directory_agent.*.log“ und werden standardmäßig im selben Ordner wie andere MERLIC-Log-Dateien gespeichert.
|
Taste |
Standardwert |
Beschreibung |
|---|---|---|
|
Directory |
Windows: %LOCALAPPDATA%\MVTec\MERLIC Linux: $HOME/.local/share/MVTec/MERLIC |
Legt das Verzeichnis für die Log-Dateien fest. Der Standardspeicherort entspricht dem für andere MERLIC-Programme wie MERLIC Creator oder MERLIC RTE. Sie können diese Einstellung bei Bedarf verwenden, um den Standardspeicherort für die Log-Dateien zu überschreiben. Beachten Sie, dass jegliche in der MERLIC-INI-Datei definierten benutzerdefinierten Protokollierungseinstellungen keine Auswirkung auf den Directory Agent haben, da der Directory Agent benutzerspezifisch ist und die INI-Datei nicht liest. |
|
Threshold |
Konsole: info Log-Datei: debug |
Legt die Log-Ebene für den Directory Agent fest. Standardmäßig protokolliert der Directory Agent auf der Konsole mit der Log-Ebene „info“ und in einer Log-Datei mit der Log-Ebene „debug“. Wird diese Option zur Festlegung einer Log-Ebene verwendet, gilt sie sowohl für die Konsole als auch für die Log-Datei. Verfügbare Log-Ebenen: critical, error, warning, info, debug, trace. |
Konfigurationsverzeichnis ändern
Wenn Sie einen anderen Speicherort für die Konfigurationsdatei des Directory Agents verwenden möchten, können Sie das Konfigurationsverzeichnis über die Umgebungsvariable „MERLIC_DIRECTORY_AGENT_CONFIG_DIR“ ändern. Die Konfigurationsdatei für den Directory Agent wird dann am angegebenen Speicherort erwartet.
