Global Configuration Properties
- 29 Aug 2024
- 3 Minutes to read
- Contributors
- Print
- DarkLight
Global Configuration Properties
- Updated on 29 Aug 2024
- 3 Minutes to read
- Contributors
- Print
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Note:
Installation on Windows is deprecated.
Zetaly provides a unified global configuration file called zetalyinstall.cnf for Linux, Docker, and Windows.
Before running the installation script within your environment, you must define the values for the properties listed in the table below within the zetalyinstall.cnf file.
| Property | Description | Default Value | Example Value |
|---|---|---|---|
INSTALLER.logDirPath | Folder where the installation logs are written. Note: This parameter is specific to Windows. It is ignored by the Linux and Docker installation scripts. | ||
INSTALLER.logLevel | Level of the installation log. This parameter only changes the log level displayed in the console. A debug level log file in is always created. Possible values:
| INFO | INFO |
Database.Type | Database type. Possible values:
| None. You must define. | Example values:
|
Database.Host.Base | Database host address. Can be a domain name or an IP. Does not contain the port. Note: For Docker, if your PostgreSQL database is in the same Docker container than the Zetaly suite, it must be the container name (e.g. zetaly_pg). | None. You must define. | company.domain.name |
Database.UserName | Database user used by the Zetaly application. This user must be able to create a new database. | None. You must define. | username |
Database.Password | Database user's password. For Linux and Docker, must not contain : "';For Linux and Docker, must be escaped with a \ : $.*[^&/ | None. You must define. | password |
Database.Name | Name of the database. Note: This parameter is commented out by default. The installation script creates a database with the name zetalydb. If you want to change the default database name, uncomment this line and specify a different database name. Database name MUST be lowercase | zetalydb | zetalydb |
Frontal.Host.Base | Domain name or IP of the server that provides access to the Zetaly Portal. | None. You must define. | company.domain.name |
Frontal.Certif.Crt | Location of the SSL certificate (*.crt) file.Absolute path only. | None. You must define. | Linux/Docker example: /home/zetaly/secrets/domain.crt |
Frontal.Certif.Key | Location of the SSL certificate key (*.key) file.Absolute path only. | None. You must define. | Linux/Docker example: /home/zetaly/secrets/domain.key |
BI.LicenseFile | Path to the license file of the BI module. Note: Only used for the Windows installation of the BI module. The license file is provided by Zetaly support. | None. Note: You must define if the installation is in a Windows environment. | |
BI.Host.Base | Address of the BI server (fully qualified domain name or IP). | None. You must define. | company.domain.name |
BI.Host.Port | Port of the BI server. | None. You must define. | 8081 |
BI.UserName | BI System Admin e-mail. This is provided by Zetaly support. | None. You must define. | user@zetaly.io |
BI.Password | BI System Admin password. This is provided by Zetaly support. | None. You must define. | password |
Installation links
Note for Linux and Docker:
The zetalyinstall.sh installation script for Linux and Docker processes the properties that you define in the table above. It contains the rest of the configuration properties with default values that typically do not need modifying.
In some cases, you may need to customize your installation. For example:
- Some of the Zetaly modules may need to run on a different port as your installation environment may already be using the default port number used by the Zetaly modules.
- You may want to change the default log level of some of the Zetaly modules.
If you need to change the default values of any property, you must add additional lines in the zetalyinstall.cnf file for each of the property whose default value you wish to modify.
Compared to Windows (see note below), Linux and Docker also includes a run.sh script that determines which Zetaly modules are installed. Typically you do not need to edit this file unless you run into installation problems.
For more information, see this article for Linux and this article for Docker.
Note for Windows:
The installation script for Windows processes the properties that you define in the table above. It contains the rest of the configuration properties with default values that typically do not need modifying. In some cases, you may need to customize your installation. For example:
- Some of the Zetaly modules may need to run on a different port as your installation environment may already be using the default port number used by the Zetaly modules.
- You may want to change the default log level of some of the Zetaly modules.
If you need to change the default values of any property, you must add additional lines in the zetalyinstall.cnf file for each of the property whose default value you wish to modify. For more information, see this article.
:::