Configuration

Command Line Argument

The command-line arguments use default values that can be configured with environment variables, but can be overridden via CLI.

run Command

Parameter	Beschreibung	Default
--console-log-level	Restricts the log level of the console to the level	COLLECTOR_CONSOLE_LEVEL; 'info'
--log-dir	Sets the directory where the log files are stored. The collector creates the directory if it does not already exist. The collector must have write permission on the folder. Relative paths are allowed and are relative to the 'Working directory'.	COLLECTOR_LOG_DIR; $working-dir/logs
--working-dir	The execution directory of the collector. The collector creates files according to the directory.	Linux: COLLECTOR_WORK_DIR;'.' Docker: COLLECTOR_WORK_DIR;'/opt/ite-si/collector/tmp/' Windows: COLLECTOR_WORK_DIR;'%APPDATA%\iTE-SI\Collector\'
--config-dir	The configuration directory of the collector. The collector creates the directory and empty configuration files if it does not exist.	Linux/Windows: COLLECTOR_CONFIG_DIR;$working-dir Docker: COLLECTOR_CONFIG_DIR;'/opt/ite-si/collector/etc/'

migrate-v1 Command

Migrates a Collector v1 configuration file (config.toml) into a equivalent Collector v2 config files. Further information can be obtained using the following line in the shell.

iTE-SI_Collector migrate-v1 --help

Environment Variables

Variable	Beschreibung
COLLECTOR_CONSOLE_LOG_LEVEL	Specifies the default value for the console log level when the collector is started.
COLLECTOR_LOG_DIR	Specifies the default value for the log directory.
COLLECTOR_WORK_DIR	Specifies the default execution directory.
COLLECTOR_CONFIG_DIR	Specifies the default directory for the configuration files (service.toml, objects.toml)

Configuration file

The collector uses two configuration files: service.toml and objects.json. The configuration files are created if they do not exist. The 'service.toml' should be edited manually, the objects.json should not be edited by the user. This file is modified on the fly.

service.toml

Sample Configuration

version = 1

[general]
hideConsole = false

[http]
port = 8001
token = "unsecure-plaintext-token"

[http.certificate]
certificateFile = "./cert.pem"
keyFile = "./key.pem"

Description of the fields

Section	Field	Type	Optional	Description	Default
	version			Internal format of the json file. Used for automatic upgrade in case of format changes.	1
general	hideConsole	bool		Hides the window in Windows.	false
http	port	uint16		The REST API is started under this port.	8001
http	token	string	true	HTTP bearer token for authentication of the REST API. Can be omitted in order to.
http.certificate			true	HTTP Zertifikat zur Verwendung von ssl/tls in der REST API.
http.certificate	certificateFile	string		Path to the HTTPs certificate in PEM format. Relative to the configuration directory.
http.certificate	keyFile	string		Path to the HTTPs private key in PEM format. Relative to the configuration directory. File must not be password protected.