Under the hood

Not all i2 TextChart Server settings are available via the management UI. Some manager settings (and all settings on worker nodes) can only be changed by editing a local properties file. Changing any of these files requires a restart of the appropriate service.

Manager settings

The manager.properties file is located in the manager's installation directory. It's a simple Java settings file (one setting per line, <name>=<value>) that you can open in any text editor. It contains these properties that you can change in the file but not in the user interface:

Property

Description

authType

Determines the type of authorization for accessing the administration UI. Options are form (the default), which uses a single username-password combination (from the adminUser and adminPassword properties), or ldap, which uses the LDAP server defined in the conf/ldap.conf file for authentication and authorization.

authGroup

(LDAP only) Specifies the LDAP group of which the authenticated user must be a member in order to gain access to the UI. Setting this to ** (the default) authenticates the username and password but does not require any specific group membership.

Worker settings

The worker.properties file is located in the worker's installation directory. It's a simple Java settings file (one setting per line, <name>=<value>) that you can open in any text editor.

Typically, it is not necessary to edit the properties for a worker node. However, if you need to change a node port, or if the host or port of the manager changes, then you can make the edits to this file without having to reinstall the worker software.

Property

Description

name

A descriptive name for the worker.

ip

The hostname or IP address of the worker.

port

The port on the worker for communicating with the manager.

secure

true to use HTTPS communication between the worker and the manager. Secure communication requires a keystore file on both the manager and the worker.

keyStorePath

The absolute path to the keystore file for SSL communication. If secure communication is enabled but this parameter is not set, then the default is to use the keystore.jks file in the worker installation directory.

keyStorePassword

The password for the SSL keystore.

keyManagerPassword

The manager password for SSL keystore. If not set, this value defaults to the keyStorePassword value.

slots

The number of threads to use for extraction processing.

managerHost

The hostname or IP address of the manager.

workerServicePort

The port on the manager for communicating with the worker.

heapSize

The maximum Java heap usage for the worker process when started as a Linux or Windows service. Use the same syntax as would be passed to the -Xmx option. For example, to specify a heap size of 6 GB, use 6144m. If not present, defaults to 4096m.

General settings

Workers and the manager all contain a logger.properties file that you can use to configure service logging. By default, both services write a rotating set of log files to the logs directory in their respective installation directories.

To change how logging operates on either system, edit the logger.properties file in a text editor.