Advanced protocol server configuration

SecureTransport 5.5 allows administrators to configure the Transaction Manager and protocol servers using configuration files. The underlying concept is to supply unified daemon configuration by adding a dedicated start scripts configuration per server daemon.

Note The start scripts configuration overrides any other configuration.

Start scripts global configuration

SecureTransport start scripts configuration is placed in the STStartScriptsConfig file, which is created during installation in the FILEDRIVEHOME/conf directory. The location of this file is pre-configured in the ${FILEDRIVEHOME}/bin/common.sh script and can be changed in to ways:

  • by editing the ST_START_SCRIPTS_CONF_PATH parameter in common.sh
  • by setting ST_START_SCRIPTS_CONF_PATH as a permanent operating system environment variable. This method takes precedence over the setting in the common.sh script.

In the start scripts configuration file, you specify configuration settings using predefined properties, which are name/value pairs in the following format:

[PROTOCOL_NAME]_[OPTION_NAME]=[value]

Possible values for PROTOCOL_NAME: TM, SSH, FTP, HTTP, ADMIN, AS2, PESIT, STATUSCHECKER

Possible values for OPTION_NAME:

  • JAVA_MEM_MIN - sets minimum memory of the PROTOCOL_NAME daemon's JVM heap size.
  • JAVA_MEM_MAX - sets maximum memory of the PROTOCOL_NAME daemon's JVM heap size.
  • JAVA_OPTS - sets java options to the PROTOCOL_NAME JVM.

Unlike the start_* scripts, the properties defined in the STStartScriptsConfig file must be provided one per line. The order of definitions does not matter. You cannot assign multiple values to the same variable in a single line.

An example of invalid syntax is:

TM_JAVA_OPTS="-DStreaming.numberOfConnections=10 -DAdvancedRouting.maxRuntimes=32"

An example of valid syntax is:

TM_JAVA_OPTS="-DStreaming.numberOfConnections=10"

TM_JAVA_OPTS="-DAdvancedRouting.maxRuntimes=32 $TM_JAVA_OPTS"

Changing the start scripts configuration

You can change the start scripts configuration in two ways:

  • Edit the existing file, STStartScriptsConfig. Always make a copy of any configuration file before editing.
  • Create a new configuration file and set the ST_START_SCRIPTS_CONF_PATH to its location.

You must restart all SecureTransport services for the configuration changes to take effect.

The following is an example configuration for the protocol daemon servers. Read through it to see what could be specified.

# Example: Setting file encoding to UTF-8

# SSH_JAVA_OPTS="-Dfile.encoding=utf8"

# Default values

 

# SSH

SSH_JAVA_MEM_MIN=256M

SSH_JAVA_MEM_MAX=512M

SSH_JAVA_OPTS="-Dfile.encoding=utf8"

 

# HTTP

HTTP_JAVA_MEM_MIN=256M

HTTP_JAVA_MEM_MAX=512M

HTTP_JAVA_OPTS="-Dfile.encoding=utf8"

 

# FTP

FTP_JAVA_MEM_MIN=256M

FTP_JAVA_MEM_MAX=512M

FTP_JAVA_OPTS="-Dfile.encoding=utf8"

 

# AS2

AS2_JAVA_MEM_MIN=256M

AS2_JAVA_MEM_MAX=512M

AS2_JAVA_OPTS="-Dfile.encoding=utf8"

 

# Admin

ADMIN_JAVA_MEM_MIN=256M

ADMIN_JAVA_MEM_MAX=512M

ADMIN_JAVA_OPTS="-Dfile.encoding=utf8"

 

# PeSIT

PESIT_JAVA_MEM_MIN=256M

PESIT_JAVA_MEM_MAX=512M

PESIT_JAVA_OPTS="-Dfile.encoding=utf8"

 

# Docker streaming status checker

STATUSCHECKER_JAVA_MEM_MIN=256M

STATUSCHECKER_JAVA_MEM_MAX=384M

STATUSCHECKER_JAVA_OPTS="-Dfile.encoding=utf8"

 

# TM

TM_JAVA_MEM_MIN=256M

TM_JAVA_MEM_MAX=512M

TM_JAVA_OPTS="-DStreaming.numberOfConnections=10"

Note You can add different shell script commands to the start script. Act with caution as your input will be executed each time the start script runs.

For more configuration options, refer to the "Additional SecureTransport configuration" topic in the SecureTransport Capacity Planning Guide. This document is available on the Axway Documentation portal to logged in users only.

TM options

In addition, a few TM options available in the start_tm_console are configurable through the STStartScriptsConfig file. The following code snippet shows them with example values:

# TM-specific options

disableHeapDumpOnOutOfMemoryError=true

generate_heap_dump=true

GC_LOGGING=true

NumberOfGCLogFiles=30

GCLogFileSize=5000K

Certificates for daemon configuration

You can use the following operating system environment variables to import certificates and use them later in SecureTransport for different purposes, including daemon configuration.

  • ST_CA_PATH - Path to the Certificate Authority
  • ST_CA_ALIAS - Certificate Authority alias
  • ST_CERT_PATH - Local certificate path
  • ST_CERT_PASS - Password for the local certificate
  • ST_CERT_ALIAS - Local certificate alias

When ready with the configuration, restart the Admin service. Certificates will be imported on admin startup.

Related Links