Config.Properties File
Article ID: KB0071531
Updated On:
| Products | Versions |
|---|---|
| TIBCO OpenSpirit Runtime | 4.3 |
Description
Master Config Directory - The directory that the configuration's config.properties file will be written to. This should be an empty directory prior to creating the master configuration. This setting is for informational purposes only when configuring a master on Windows. The default configuration directory must be used on Windows. The directory must be readable by the users that will be running applications or data connectors from the master. The config directory cannot be changed once the master configuration has been saved
Satellite Config Directory - The directory that the configuration's config.properties file will be written to. This should be an empty directory prior to creating the satellite configuration. This file is for informational purposes only when configuring a satellite on Windows.
The configuration folder, where the file is automatically written upon installation of a Master or Satellite (on Windows), is in a fixed location on Windows; %ProgramData%\OpenSpirit\v#.# where the "#.#" component of the folder path is the major and minor version number of the OpenSpirit Runtime you are using.
Individual users can manually create a config.properties file under %LocalAppData%\OpenSpirit\v#.# (for satellite installations) which will override the configuration under %ProgramData%\OpenSpirit\v#.#. When you launch OpenSpirit, that is where we would look for a config.properties first, THEN if the file is not found (typically the file will not be found), then it goes to look for the config file under %ProgramData%\OpenSpirit\v#.# which is where OpenSpirit creates it during the installation. NOTE: The config.properties file is never auto created under %LocalAppData%\OpenSpirit\v#.# during the OpenSpirit Satellite installation.
Example of what the file contents should look like follows (user assumes their own environment variables):
Satellite and/or Master on Windows:
#OpenSpirit configuration file.
#
#version: 4.3.0.144
#
#Fri Oct 07 15:28:10 CDT 2022
HOST=na1devospwin02.dev.tibco.com (HOST on Windows Master would be a local PC name)
HOME=C\:\\Program Files\\OpenSpirit\\v4.3
PORT=15437
LINUX installations
You must select an empty directory when configuring on Linux. The directory must be readable by the
users that will be running applications or data connectors from the satellite.
The default directory on Linux is a sub-directory named config in the top-level folder of the OpenSpirit software installation that the Install Config Manager is being run from. Using the default directory eliminates the need to have an OSP_CONFIG environment variable set prior to running the OpenSpirit Desktop on Linux. The environment variable must be set if a different name or location is used.
Example of what the file contents should look like follows (user assumes their own environment variables):
Master on Linux:
#OpenSpirit configuration file.
#
#version: 4.3.0.158 HF02
#
#Thu Mar 16 15:28:10 CDT 2023
HOST=na1devosprhl02.dev.tibco.com
DATA=/prod/spirit/v430_GAcjl_rh6-r5000/v4.3/config/data
LOG=/ prod/spirit/v430_GAcjl_rh6-r5000/v4.3/config/logs
HOME=/ prod/spirit/v430_GAcjl_rh6-r5000/v4.3
DB_UUID=fd01351d-8ac9-40a2-a931-d9267025302d
PORT=15437
Satellite Config Directory - The directory that the configuration's config.properties file will be written to. This should be an empty directory prior to creating the satellite configuration. This file is for informational purposes only when configuring a satellite on Windows.
The configuration folder, where the file is automatically written upon installation of a Master or Satellite (on Windows), is in a fixed location on Windows; %ProgramData%\OpenSpirit\v#.# where the "#.#" component of the folder path is the major and minor version number of the OpenSpirit Runtime you are using.
Individual users can manually create a config.properties file under %LocalAppData%\OpenSpirit\v#.# (for satellite installations) which will override the configuration under %ProgramData%\OpenSpirit\v#.#. When you launch OpenSpirit, that is where we would look for a config.properties first, THEN if the file is not found (typically the file will not be found), then it goes to look for the config file under %ProgramData%\OpenSpirit\v#.# which is where OpenSpirit creates it during the installation. NOTE: The config.properties file is never auto created under %LocalAppData%\OpenSpirit\v#.# during the OpenSpirit Satellite installation.
Example of what the file contents should look like follows (user assumes their own environment variables):
Satellite and/or Master on Windows:
#OpenSpirit configuration file.
#
#version: 4.3.0.144
#
#Fri Oct 07 15:28:10 CDT 2022
HOST=na1devospwin02.dev.tibco.com (HOST on Windows Master would be a local PC name)
HOME=C\:\\Program Files\\OpenSpirit\\v4.3
PORT=15437
LINUX installations
You must select an empty directory when configuring on Linux. The directory must be readable by the
users that will be running applications or data connectors from the satellite.
The default directory on Linux is a sub-directory named config in the top-level folder of the OpenSpirit software installation that the Install Config Manager is being run from. Using the default directory eliminates the need to have an OSP_CONFIG environment variable set prior to running the OpenSpirit Desktop on Linux. The environment variable must be set if a different name or location is used.
Example of what the file contents should look like follows (user assumes their own environment variables):
Master on Linux:
#OpenSpirit configuration file.
#
#version: 4.3.0.158 HF02
#
#Thu Mar 16 15:28:10 CDT 2023
HOST=na1devosprhl02.dev.tibco.com
DATA=/prod/spirit/v430_GAcjl_rh6-r5000/v4.3/config/data
LOG=/ prod/spirit/v430_GAcjl_rh6-r5000/v4.3/config/logs
HOME=/ prod/spirit/v430_GAcjl_rh6-r5000/v4.3
DB_UUID=fd01351d-8ac9-40a2-a931-d9267025302d
PORT=15437
Issue/Introduction
This article describes the functionality of the config.properties file and where it is located
Environment
Windows & Linux
Resolution
Once this file is created, it controls which Master the Satellite installation is configured to associate with.
Additional Information
OpenSpirit Runtime Installation & Configuration Guide (TIB_os_rt_4.3.0_install_and_config.pdf) pp 49, 52-53, 76
Feedback
Yes
No
Powered by
