--- title: "Linux Configuration Properties" slug: "configuration-linux" updated: 2026-01-15T10:59:08Z published: 2026-01-15T10:59:08Z canonical: "docs.zetaly.io/configuration-linux" --- > ## Documentation Index > Fetch the complete documentation index at: https://docs.zetaly.io/llms.txt > Use this file to discover all available pages before exploring further. # Linux Configuration Properties ## Introduction Zetaly provides a global configuration file called `zetalyinstall.cnf` which contains all the necessary properties to perform a default installation under Linux. Before executing the `run.sh` installation script, you must define the values for the properties in the `zetalyinstall.cnf` file according to [this article](/v1/docs/configuration-global). In some cases you may need to customize your installation to support your installation environment. Examples include, but are not limited to the following: - needing to change the default port of one or more Zetaly modules to avoid port clashes with other services that are already using the same port, - changing the default log level of the Zetaly modules, - installing the different Zetaly modules on different servers, To customize your installation under Linux you must add additional properties at the end of the `zetalyinstall.cnf` file before executing the `run.sh` installation script. Note: The `run.sh` script contains properties to determine which of the Zetaly modules are installed. It is pre-configured according to your installation package. Typically you do not need to edit this file unless you run into installation problems. If you run into installation problems, you can edit the `run.sh` script accordingly to match your installation package's requirements. For more information, see [Editing the run.sh Script](/v1/docs/configuration-linux#editing-the-runsh-script). ## Custom Configuration Properties The list below summarizes the properties that you can add into the `zetalyinstall.cnf` file to customize your installation. Each line you add for a property in the `zetalyinstall.cnf` file overrides the `zetalyinstall.sh` script's default value with the value that you specify. Each line you add must take the following format, where the `custom.property` and `custom value` you define are seperated by an equals symbol (=). ``` custom.property = custom value ``` Some properties can be customized individually, while other groups of properties must be customized together (as they have interdependencies). For examples of when groups of properties must be customized together, see [Customization Examples](/v1/docs/configuration-linux#customization-examples). You can also add comments using the hash symbol (#) to describe your custom installation properties. ``` ############################################ # Custom Installation Properties # ############################################ custom.property.1 = custom value 1 custom.property.2 = custom value 2 custom.property.3 = custom value 3 ``` Note: The customizable properties below have default values which typically do not need changing. Change them with caution. If in doubt, contact Zetaly support for more information. ## List of Configuration Properties #### Installation.Directory Directory used for the installation. *Default Value* : "/home/$(whoami)/zetaly" > $(whoami) gives the name of the current user #### Database.GenerationMode Generation mode for the internal database. Possible values: - update (Update the database structure only, default) - drop-and-create (Drop and create the database at launch. Test purpose only) *Default Value* : update #### Frontal.Host.Port Port used to access the Zetaly Portal. *Default Value* : 443 #### BI.Anonymous.Email Anonymous username, used to access the public dashboard. *Default Value* : anonymous-user@zetaly.io #### BI.Anonymous.Password Anonymous password. *Default Value* : Zetaly01!. #### Backend.BI.Scheme The protocol used by the BI module. Possible values: - https - http **Note**: Typically this property not added to the zetalyinstall.cnf file. You must always use https use for new installations or for an environment that already has the BI module installed and configured using https (i.e. you do not need to add this parameter). You only need to add this parameter and specify http for an environment that already has the BI module installed and configured to use http. *Default Value* : https #### Backend.ZSA.Scheme Protocol to access the ZSA module. Possible values: - https - http **Note**: If you change the value to https you must additionally create and install an SSL certificate. Since this property defines the protocol to use internally behind the FrontalWeb component, Zetaly recommend that you leave the default setting of http. *Default Value* : http #### Backend.ZSA.Host Host to access the ZSA module. *Default Value* : localhost #### Backend.ZSA.Port Port to access the ZSA module. *Default Value* : 11010 #### Backend.ZSA.LogLevel Log level for the ZSA module. Possible values (case sensitive): - Debug - Information - Warning - Error *Default Value* : Warning #### Backend.ZSA.Email ZSA username. This user is only used to communicate between the ZSA module and the other Zetaly modules. *Default Value* : zsa-user@zetaly.io #### Backend.ZSA.Password ZSA password. *Default Value* : Zetaly01!. #### Backend.ZSA.StorageConfiguration Type of storage for RAW records. Possible values : - SQL - GRAPH - BOTH *Default Value* : SQL #### Backend.ZSA.Loadviews.Timeout.ms Loadviews maximum waiting time (in milliseconds) for all the agents to stop. *Default Value* : 60000 #### Backend.ZRP.Scheme Protocol to internally access the ZRP module. **Note**: If you change the value to https you must additionally create and install an SSL certificate. Since this property defines the protocol to use internally behind the FrontalWeb component, Zetaly recommend that you leave the default setting of http. Possible values : - https - http *Default Value* : http #### Backend.ZRP.Host Host to internally access the ZRP module. *Default Value* : localhost #### Backend.ZRP.Port Port to internally access the ZRP module. *Default Value* : 11020 #### Backend.ZRP.LogLevel Log level for the ZRP module. Possible values : - ALL - FATAL - ERROR - WARN - INFO - DEBUG *Default Value* : INFO #### Backend.ZRP.replaceSmfIntervalGap Mode if ZRP should fill the gap between two data intervals. Possible values: - REPLACE_GAP - NOTHING *Default Value* : REPLACE_GAP #### Backend.ZRP.maxPeriodIntervalNumber Number of intervals between two data intervals that should be detected as a gap. *Default Value* : 2 #### Backend.ZRP.Args JDK arguments. *Default Value* : Empty #### Backend.MYZ.Scheme Protocol to internally access the MYZ module. Possible values: - https - http **Note**: If you change the value to https you must additionally create and install an SSL certificate. Since this property defines the protocol to use internally behind the FrontalWeb component, Zetaly recommend that you leave the default setting of http. *Default Value* : http #### Backend.MYZ.Host Host to internally access the MYZ module. *Default Value* : localhost #### Backend.MYZ.Port Port to internally access the MYZ module. *Default Value* : 11030 #### Backend.MYZ.LogLevel Log level for the MYZ module. Possible values: - ALL - FATAL - ERROR - WARN - INFO - DEBUG - TRACE - OFF *Default Value* : INFO #### Backend.MYZ.Args JDK arguments. *Default Value* : Empty #### Backend.ZDE.Scheme Protocol to internally access the ZDE module. Possible values: - https - http **Note**: If you change the value to https you must additionally create and install an SSL certificate. Since this property defines the protocol to use internally behind the FrontalWeb component, Zetaly recommend that you leave the default setting of http. *Default Value* : http #### Backend.ZDE.Host Host to internally access the ZDE module. *Default Value* : localhost #### Backend.ZDE.Port Port to internally access the ZDE module. *Default Value* : 11040 #### Backend.ZDE.LogLevel Log level for the ZDE module. Possible values: - ALL - FATAL - ERROR - WARN - INFO - DEBUG - TRACE - OFF *Default Value* : INFO #### Backend.ZDE.Args JDK arguments. *Default Value* : Empty #### Backend.ZCC.Scheme Protocol to internally access the ZCC module. Possible values: - https - http **Note**: If you change the value to https you must additionally create and install an SSL certificate. Since this property defines the protocol to use internally behind the FrontalWeb component, Zetaly recommend that you leave the default setting of http. *Default Value* : http #### Backend.ZCC.Host Host to internally access the ZCC module. *Default Value* : localhost #### Backend.ZCC.Port Port to internally access the ZCC module. *Default Value* : 11050 #### Backend.ZCC.LogLevel Log level for the ZCC module. Possible values (case sensitive): - Debug - Information - Warning - Error *Default Value* : Warning #### Backend.ZHB.Scheme Protocol internally access the ZHB module. Possible values: - https - http **Note**: If you change the value to https you must additionally create and install an SSL certificate. Since this property defines the protocol to use internally behind the FrontalWeb component, Zetaly recommend that you leave the default setting of http. *Default Value* : http #### Backend.ZHB.Host Host to internally access the ZHB module. *Default Value* : localhost #### Backend.ZHB.Port Port to internally access the ZHB module. *Default Value* : 11060 #### Backend.ZHB.LogLevel Log level for the ZHB module. Possible values: - ALL - FATAL - ERROR - WARN - INFO - DEBUG - TRACE - OFF *Default Value* : INFO #### Backend.ZHB.Args JDK arguments. *Default Value* : Empty #### Backend.ZUP.Scheme Protocol to internally access the ZUP module. Possible values: - http - https **Note**: If you change the value to https you must additionally create and install an SSL certificate. Since this property defines the protocol to use internally behind the FrontalWeb component, Zetaly recommend that you leave the default setting of http. *Default Value* : http #### Backend.ZUP.Host Host to internally access the ZUP module. *Default Value* : localhost #### Backend.ZUP.Port Port to internally access the ZUP module. *Default Value* : 11070 #### Backend.ZUP.LogLevel Log level for the ZUP module. Possible values: - ALL - FATAL - ERROR - WARN - INFO - DEBUG - TRACE - OFF *Default Value* : INFO #### Backend.ZUP.Email ZUP username. This user is only used to communicate between the ZUP module and the other Zetaly modules. *Default Value* : zup-user@zetaly.io #### Backend.ZUP.Password ZUP password. *Default Value* : Zetaly01!. #### Backend.ZUP.ConfigurationType Name of the configuration type for SMF. *Default Value* : SMF #### Backend.ZUP.Args JDK arguments. *Default Value* : Empty #### Backend.ZCO.Scheme Protocol to internally access the ZCO module. Possible values: - http - https **Note**: If you change the value to https you must additionally create and install an SSL certificate. Since this property defines the protocol to use internally behind the FrontalWeb component, Zetaly recommend that you leave the default setting of http. *Default Value* : http #### Backend.ZCO.Host Host to internally access the ZCO module. *Default Value* : localhost #### Backend.ZCO.Port Port to internally access the ZCO module. *Default Value* : 11080 #### Backend.ZCO.LogLevel Log level for the ZCO module. Possible values: - ALL - FATAL - ERROR - WARN - INFO - DEBUG - TRACE - OFF *Default Value* : INFO #### Backend.ZCO.Args JDK arguments. *Default Value* :INFO #### Backend.ZQM.Scheme Protocol to internally access the ZQM module. Possible values: - http - https **Note**: If you change the value to https you must additionally create and install an SSL certificate. Since this property defines the protocol to use internally behind the FrontalWeb component, Zetaly recommend that you leave the default setting of http. *Default Value* :http #### Backend.ZQM.Host Host to internally access the ZQM module. *Default Value* : localhost #### Backend.ZQM.Port Port to internally access the ZQM module. *Default Value* : 11090 #### Backend.ZQM.LogLevel Log level for the ZQM module. Possible values: - ALL - FATAL - ERROR - WARN - INFO - DEBUG - TRACE - OFF *Default Value* : INFO #### Backend.ZQM.Args JDK arguments. *Default Value* : Empty #### Backend.ZSAC.Scheme Protocol to internally access the ZSAC module. Possible values: - http - https **Note**: If you change the value to https you must additionally create and install an SSL certificate. Since this property defines the protocol to use internally behind the FrontalWeb component, Zetaly recommend that you leave the default setting of http. *Default Value* : http #### Backend.ZSAC.Host Host to internally access the ZSAC module. *Default Value* : localhost #### Backend.ZSAC.Port Port to internally access the ZSAC module. *Default Value* : 11100 #### Backend.ZSAC.LogLevel Log level for the ZSAC module. Possible values (case sensitive): - Debug - Information - Warning - Error *Default Value* : Warning #### Backend.ZDC.Scheme Protocol to internally access the ZDC module. Possible values: - http - https **Note**: If you change the value to https you must additionally create and install an SSL certificate. Since this property defines the protocol to use internally behind the FrontalWeb component, Zetaly recommend that you leave the default setting of http. *Default Value* : http #### Backend.ZDC.Host Host to internally access the ZDC module. *Default Value* : localhost #### Backend.ZDC.Port Port to internally access the ZDC module. *Default Value* : 11110 #### Backend.ZDC.LogLevel Log level for the ZDC module. Possible values: - ALL - FATAL - ERROR - WARN - INFO - DEBUG - TRACE - OFF *Default Value* : INFO #### Backend.ZDC.Args JDK arguments. *Default Value* : Empty #### Database.Host.Port May be used when database is to be accessed with a non-default port. *Default Value* : No default value #### Reverse.Proxy.Host.Base Value of the reverse proxy used in front of Zetaly proxy. You can use it when you want to access the Zetaly portal via a DNS other than that of the environment where the suite is deployed. *Default Value*: Value of Frontal.Host.Base #### Reverse.Proxy.Host.Port Port value of the reverse proxy used in front of Zetaly proxy. You can use it when you want to access the Zetaly portal via a DNS other than that of the environment where the suite is deployed. *Default Value*: Value of Frontal.Host.Port #### Reverse.Proxy.Host.Scheme Scheme value of the reverse proxy used in front of Zetaly proxy. You can use it when you want to access the Zetaly portal via a DNS other than that of the environment where the suite is deployed. *Default Value*: Value of Frontal.Host.Scheme #### Folder.Java Folder where the Java binary will be installed. *Default Value*:/usr/local/bin/java$JAVA_VERSION $JAVA_VERSION is replaced by the version in your package. #### Folder.DotNet Folder where the DotNet binary will be installed. *Default Value*:/usr/local/bin/dotnet$NET_VERSION $NET_VERSION is replaced by the version in your package. #### Folder.Node Folder where the NodeJS binary will be installed. *Default Value*:/usr/local/bin/zetaly-node #### Folder.Service.Scripts Folder where the different scripts used by Zetaly will be copied. *Default Value*:/usr/local/bin/zetaly #### Folder.KeyCloak Folder where KeyCloak will be installed. *Default Value*:/usr/local/bin/keycloak ## Customization Examples This section describes some examples of adding additional properties at the end of the `zetalyinstall.cnf` file for different customization scenarios. ### Resolving Port Clashes With Zetaly Modules The table below summarizes the default port numbers and their associated properties for each of the Zetaly modules. | Zetaly Module | Property | Default Port Number | | --- | --- | --- | | ZCC | `Backend.ZCC.Port` | 11050 | | ZRP | `Backend.ZRP.Port` | 11020 | | MYZ | `Backend.MYZ.Port` | 11030 | | ZDE | `Backend.ZDE.Port` | 11040 | | ZSA | `Backend.ZSA.Port` | 11010 | | ZSAC | `Backend.ZSAC.Port` | 11100 | | ZHB | `Backend.ZHB.Port` | 11060 | | ZUP | `Backend.ZUP.Port` | 11070 | | ZCO | `Backend.ZCO.Port` | 11080 | | ZQM | `Backend.ZQM.Port` | 11090 | | ZDC | `Backend.ZDC.Port` | 11110 | In our example, the server that will have Zetaly installed has services already using ports 11010 and 11060. By default the ZSA module also uses port 11010. To avoid a port clash between the ZSA module and the other service using port 11010, you must change the ZSA module to another unused port (for example 11015). By default the ZHB module also uses port 11060. To avoid a port clash between the ZHB module and the other service using port 11060, you must change the ZHB module to another unused port (for example 11065). In this case you would create the following section at the end of the `zetalyinstall.cnf` file. ``` ################################################################# # Custom ports for Zetaly modules to avoid port clashes # ################################################################# Backend.ZSA.Port = 11015 Backend.ZHB.Port = 11060 ``` ### Changing the Default Log Level of the Zetaly Modules The table below summarizes the default log levels, possible log levels and their associated properties for each of the Zetaly modules. | Zetaly Module | Property | Default Log Level | Possible Log Levels | | --- | --- | --- | --- | | ZCC | `Backend.ZCC.LogLevel` | Warning | Debug, Information, Warning, Error | | ZRP | `Backend.ZRP.LogLevel` | INFO | OFF, FATAL, ERROR, WARN, INFO, DEBUG, TRACE, ALL | | MYZ | `Backend.MYZ.LogLevel` | INFO | OFF, FATAL, ERROR, WARN, INFO, DEBUG, TRACE, ALL | | ZDE | `Backend.ZDE.LogLevel` | INFO | µERROR, WARNING, INFORMATION, DEBUG | | ZSA | `Backend.ZSA.LogLevel` | Warning | Debug, Information, Warning, Error | | ZSAC | `Backend.ZSAC.LogLevel` | Warning | Error, Warning, Information, Debug | | ZHB | `Backend.ZHB.LogLevel` | INFO | OFF, FATAL, ERROR, WARN, INFO, DEBUG, TRACE, ALL | | ZUP | `Backend.ZUP.LogLevel` | INFO | OFF, FATAL, ERROR, WARN, INFO, DEBUG, TRACE, ALL | | ZQM | `Backend.ZQM.LogLevel` | INFO | OFF, FATAL, ERROR, WARN, INFO, DEBUG, TRACE, ALL | | ZCO | `Backend.ZCO.LogLevel` | INFO | OFF, FATAL, ERROR, WARN, INFO, DEBUG, TRACE, ALL | | ZDC | `Backend.ZDC.LogLevel` | INFO | OFF, FATAL, ERROR, WARN, INFO, DEBUG, TRACE, ALL | In our example we want to change the default log levels of the ZHB, ZUP and ZQM modules from INFO to WARN. In this case you would create the following section at the end of the `zetalyinstall.cnf` file. ``` ############################################################ # Custom Log Levels # ############################################################ Backend.ZHB.LogLevel = WARN Backend.ZUP.LogLevel = WARN Backend.ZQM.LogLevel = WARN ``` ## Editing the run.sh Script The `run.sh` script contains properties to determine which of the Zetaly modules are installed. It is pre-configured according to your installation package. Typically you do not need to edit this file unless you run into installation problems. If you run into installation problems, you can edit the `run.sh` script accordingly to match your installation package's requirements. The list below summarizes properties in the `run.sh` script. #### ZETALY_CNF_FILE_PATH Defines the path to the zetalyinstall.cnf file. Never change this. *Default Value* : $package_folder/zetalyinstall.cnf #### ZETALY_INSTALLATION_MODE Defines the installation mode. Possible values: - docker - linux *Default Value* : docker #### FRONTAL_INSTALLATION Determines whether the Frontal module is installed. Possible values: - 1 - the Frontal module is installed (i.e. is always installed in order to have access to the Zetaly Portal) *Default Value* : Depends on installation package #### MYZ_INSTALLATION Determines whether the MYZ module is installed. Possible values: - 0 - the MYZ module is not installed - 1 - the MYZ module is installed *Default Value* : Depends on installation package #### ZRP_INSTALLATION Determines whether the ZRP module is installed. Possible values: - 0 - the ZRP module is not installed - 1 - the ZRP module is installed *Default Value* : Depends on installation package #### ZDE_INSTALLATION Determines whether the ZDE module is installed. Possible values: - 0 - the ZDE module is not installed - 1 - the ZDE module is installed *Default Value* : Depends on installation package #### ZCC_INSTALLATION Determines whether the ZCC module is installed. Possible values: - 0 - the ZCC module is not installed - 1 - the ZCC module is installed *Note:* The ZCC module requires the MYZ module installed as it relies on the MyInfrastructure functionality provided by the MYZ module. If you set this value to 1 the install_myz property must also be set to 1. *Default Value* : Depends on installation package #### ZSA_INSTALLATION Determines whether the ZSA module is installed. Possible values: - 1 - the ZSA module is installed (i.e. is always installed as the Zetaly Streaming Agent is always required for collecting mainframe data). *Default Value* : Depends on installation package #### ZHB_INSTALLATION Determines whether the ZHB module is installed. Possible values: - 1 - the ZHB module is installed (i.e. is always required as this module provide the user management functionality). *Default Value* : Depends on installation package #### ZUP_INSTALLATION Determines whether the ZUP module is installed. Possible values: - 0 - the ZUP module is not installed - 1 - the ZUP module is installed *Default Value* : Depends on installation package #### ZCO_INSTALLATION Determines whether the ZCO module is installed. Possible values: - 0 - the ZCO module is not installed - 1 - the ZCO module is installed *Default Value* : Depends on installation package #### ZQM_INSTALLATION Determines whether the ZQM module is installed. Possible values: - 0 - the ZQM module is not installed - 1 - the ZQM module is installed *Default Value* : Depends on installation package #### ZDC_INSTALLATION Determines whether the ZDC module is installed. Possible values: - 0 - the ZDC module is not installed - 1 - the ZDC module is installed *Default Value* : Depends on installation package #### ZSI_INSTALLATION Determines whether the ZSI module is installed. Possible values: - 0 - the ZSI module is not installed - 1 - the ZSI module is installed *Default Value* : Depends on installation package #### ZBI_INSTALLATION Determines whether the BI Tool SISENSE is installed. Possible values: - 0 - the BI Tool SISENSE is not installed - 1 - the BI Tool SISENSE is installed *Default Value* : Depends on installation package #### ZBI_ONLY Determines whether the ZSI module is installed along with some core backend functions of the ZCC module without displaying the ZCC module in the Zetaly Portal. Possible values: 0 - the ZSI module is not installed along with some core backend functions of the ZCC module 1 - 1 - the ZSI module is installed along with some core backend functions of the ZCC module *Default Value* : Depends on installation package #### ARCHITECTURE Determines the architecture of the server. Possible values: - 0 - x86 for the x86/64 architecture - 1 - s390x for the IBM Z architecture #### KEYCLOAK_INSTALLATION Determines whether the Keycloak module is installed. Possible values: - 0 - the Keycloak module is not installed - 1 - the Keycloak module is installed #### JAVA_INSTALLATION Determines whether Java is installed. Possible values: - 0 - Java is not installed - 1 - Java is installed #### JAVA_VERSION Determines the Java version. If JAVA_INSTALLATION = 1, JAVA_VERSION must be equal to "21". #### NET_INSTALLATION Determines whether ASP runtime .net is installed. Possible values: - 0 - ASP runtime .net is not installed - 1 - ASP runtime .net is installed #### NET_VERSION Determines the ASP runtime .net version. If NET_INSTALLATION = 1, NET_VERSION must be equal to "10". #### NODE_INSTALLATION Determines whether NodeJs is installed. Possible values: - 0 - NodeJs is not installed - 1 - NodeJs is installed #### NODE_VERSION Determines the NodeJs version. If NODE_INSTALLATION = 1, NET_VERSION must be equal to "16.20.2". #### DB_CREATION_AND_UPDATE Determines weather the database should be created and updated to last version. It must always be set when a Java module is installed (MYZ, ZRP, ZDE, ZSAJ, ZSAC, ZHB, ZUP, ZQM, ZSI). ### Example The example below shows a `run.sh` script for an installation which has the following modules installed: - Frontal (always required as it provides access to the Zetaly Portal). - MYZ (required because ZCC is going to be installed, which needs the MyInfrastructure functionality of MYZ) - ZRP - ZCC - ZSA (always required as it provides the Streaming Agent which is used to collect data from the mainframe). - ZHB (always required as it provides the user management functionality within the Zetaly Portal). ``` package_folder=$(pwd) export ZETALY_CNF_FILE_PATH=$package_folder/test-zetalyinstall.cnf sudo chmod 700 configure.sh sudo chmod 700 healthcheck.sh sudo chmod 700 clean.sh sudo chmod 700 zetalyinstall.sh export DRY_RUN=0 # Choose between docker or linux export ZETALY_INSTALLATION_MODE=linux if [ "$ZETALY_INSTALLATION_MODE" == "docker" ]; then sudo chmod 700 docker_functions.sh sudo chmod 700 network.sh elif [ "$ZETALY_INSTALLATION_MODE" == "linux" ]; then sudo chmod 700 linux_functions.sh fi export MYZ_INSTALLATION=1 export ZRP_INSTALLATION=1 export ZDE_INSTALLATION=0 export FRONTAL_INSTALLATION=1 export ZSA_INSTALLATION=1 export ZCC_INSTALLATION=1 export ZHB_INSTALLATION=1 export ZUP_INSTALLATION=0 export ZCO_INSTALLATION=0 export ZQM_INSTALLATION=0 export ZDC_INSTALLATION=0 export ZSI_INSTALLATION=0 export ZBI_INSTALLATION=0 # Use to set the front permissions when only zsi is deployed export ZBI_ONLY=0 export ARCHITECTURE=x86 export KEYCLOAK_INSTALLATION=1 export JAVA_INSTALLATION=1 export JAVA_VERSION="21" export NET_INSTALLATION=1 export NET_VERSION="10" export NODE_INSTALLATION=1 export NODE_VERSION="16.20.2" export DB_CREATION_AND_UPDATE=1 ./zetalyinstall.sh ```