STEP System Configuration
SPOT provides the ability to manage STEP’s properties files (such as config.properties and sharedconfig.properties) by checking syntax, searching available properties, encrypting security- exposed properties, and viewing / updating license information.
The STEP property files are key for configuring / customizing the STEP environment. For example, adding additional servers to the cluster, increasing STEP’s JVM heap size, housekeeping, and managing background processes’ queue sizes.
Each application server has its own property file, config.properties, that is used to customize STEP on the local application server only. A shared property file, sharedconfig.properties, is read from the config.properties file by using the @include option and is the preferred file to change when customizing a STEP environment, as the file is shared between all application servers when in a clustered configuration.
Additional property files can be included using the @include option and added to the config.properties file. Any changes made to sharedconfig.properties or additional properties files require the application’s configuration to be updated (as seen below).
Check the syntax of STEP’s property files / update the configuration
- Go to the directory where STEP is installed. The default path is /opt/stibo/step
- Run the SPOT command as follows:
./spot --config
Note: If an unknown property has been added, an error will be displayed after executing the above command.
Search available properties and associated documentation
- Go to the directory where STEP is installed. The default path is /opt/stibo/step
- Run the SPOT command as follows:
./spot --prop=<SEARCH_STRING>
Encrypt a property value within a property file
- Go to the directory where STEP is installed. The default path is /opt/stibo/step
- Run the SPOT command as follows:
./spot --encrypt=<PROPERTY_NAME>
View license information
- Go to the directory where STEP is installed. The default path is /opt/stibo/step
- Run the SPOT command as follows:
./spot --license
Update license information
- Go to the directory where STEP is installed. The default path is /opt/stibo/step
- Run the SPOT command as follows:
./spot --updatelicense
Note: Prior to running the above command, any change in customer license must first be made internally by Stibo Systems personnel. Once that has been done, this command is then used to update the intended STEP environment(s).