Configuration Property Files and Their Corresponding Variables
Zoomdata leverages the following configuration files to ensure successful deployment in your operating environment:
-
The
zoomdata.properties
file defines variables and parameters related to Zoomdata specifically. -
The
zoomdata.env
file defines configurations and variables that help Zoomdata connect to and communicate with your network. -
The
scheduler.properties
file defines variables and parameters related to Zoomdata Scheduler process. -
The
scheduler.env
file defines variables and parameters related to Zoomdata Scheduler process. - Zoomdata's data connectors each have their own property file containing variables and parameters related to Zoomdata connector servers. For more information, see Connector Properties.
- Zoomdata's query engine has its own files containing the variables and parameters related to the query engine process. For more information, see Configuring and Starting the Query Engine.
With the release of version 2.6.2, the default configuration for server ports has changed. By default, Zoomdata has one port set to http. To enabled https for your environment if you are upgrading or completing a new installation, you will need to alter a few properties and provide a certificate from a trusted vendor. For steps, see Adding an SSL Certificate.
Before editing these property files, be sure to log off Zoomdata from your web browser. When you have completed your edits, restart Zoomdata to ensure your changes take effect. For the security-related properties, you can refer to spring.io's Appendix A covering common application properties.
Zoomdata.properties HTTPS Port Values for 2.6.0 and 2.6.1
http.port | 8443 |
The default port with https automatically enabled. No other values needed to be altered. |
For all other Zoomdata properties and their default variables, refer to the following tables.
zoomdata.properties variables for 2.6.2+
Property Name | Default Value | Description |
---|---|---|
access.control.allow.origin | * |
By default, CORS is set to --- in the Zoomdata Server. You can set CORS to restrict access:
For more information, see
Enabling Cross-Origin Requests with CORS Settings
.
|
server.port | 8080 |
The default server port, which is set to use http. Prior releases used http.port |
logs.dir | ZD_Install_dir /logs |
Path to Zoomdata logs. The placeholder
install.dir
is replaced with the actual location where Zoomdata is installed.
Example:
|
multipart.maxFileSize | 500Mb |
Example:
|
multipart.maxRequestSize | 500Mb |
Example:
|
proxyHost | user defined | For cloud-based connectors (including Google Analytics and Salesforce) being used in a proxy configuration, this property specifies the server host to be returned for calls, and identifies the proxy host server that will provide internet access. |
proxyPort | user defined | For cloud-based connectors (including Google Analytics and Salesforce) being used in a proxy configuration, this property specifies the server port to be returned for calls, and identifies the proxy port server that will provide internet access. |
saml.maxAuthAge | 86400 |
Sets the timeout for SAML, in seconds. The default is 24 hours.
Example:
|
server.compression.enabled | spring.http.gzip.enabled |
Enables gzip compression for http requests.
Example:
|
server.contextPath | /zoomdata |
Example:
|
server.session-timeout | 1800 |
Sets when your Zoomdata session will timeout (in seconds).
Example:
|
source.attribute.values.limit | 1000 |
Sets the limit for the number of attribute values that can be displayed in the Filter list.
Example:
|
scheduler.service.url | http://localhost:3333 |
Points to the scheduler service that Zoomdata uses to clear caches.
Example:
|
Default Account Configurations | ||
supervisor.password | user defined |
Allows the account administrator to set the password for the supervisor role.
Example:
|
admin.password | user defined |
Allows the account administrator to set the password for the admin role.
Example:
|
disable.auth | false |
Allows the account administrator to disable authentication completely, allowing for auto login using only the specified username identified in the property file 'autologin.username'. (with no password requirement).
Example:
|
autologin.username | admin |
Sets the username that can be automatically logged into Zoomdata (used in conjunction with the property file 'disable.auth'.
Example:
|
Keystore Properties | ||
keystore.location | classpath:security/zoomkeystore.jks |
Zoomdata uses symmetric encryption. You can point to a new keystore to strengthen security.
Example:
Refer to the article
Creating a Symmetric Key
for further guidance.
|
keystore.password | zoomkey |
Lets you set up a unique password for the keystore.
Example:
|
keystore.key.alias | zoomkey |
Example:
|
keystore.key.password | zoomkey |
Example:
|
Server SSL Properties | ||
server.ssl.ciphers | user defined |
Example:
|
server.ssl.client_auth | user defined |
Example:
|
server.ssl.key-store | HOME/conf/keystore |
Sets the path for the keystore location.
Example:
|
server.ssl.key_store_password | user defined |
Stores the keystore password.
Example:
|
server.ssl.key_store_type | user defined |
Example:
|
server.ssl.trust_store | user defined |
Example:
|
server.ssl.trust_store_password | user defined |
Example:
|
server.ssl.trust_store_type | user defined |
Example:
|
Security Properties | ||
saml.artifactBindingDefault | true |
Example:
|
saml.useMultiValueList | true |
Example:
|
saml.stringDelimiter-, |
Example:
|
|
Kerberized PostgreSQL Properties | ||
spring.datasource.connection-properties:jaasApplicationName | com.sun.security.jgss.initiate |
Property that identifies the library to use for secure connection between PostgreSQL and the Zoomdata Server.
Example:
|
spring.datasource.url | jdbc:postgresql:// your_IP_address :5432/zoomdata |
Property to identify PostgreSQL URL.
Example:
|
spring.datasource.username | zoomdata |
Property to identify the username in PostgreSQL.
Example:
|
Source Sampling Properties | ||
source.sampling.count.default | 1000 |
Example:
|
source.attribute.values.limit | 1000 |
Example:
|
System Log Properties | ||
syslog.log.level | OFF |
Sets the message logging function. The following options are available for this property:
Example:
|
syslog.host | 127.0.0.1 |
Sets the host IP address for message logging.
Example:
|
syslog.port | 1514 |
Sets the port for message logging.
Example:
|
syslog.suffix | local |
Specifies a suffix that is appended at the end of the log entry that Zoomdata generates.
Example:
|
Screenshot Properties | ||
screenshot.webdriver.timeout | 180 |
Example:
|
screenshot.daemon.schedule.rate | 24h |
Example:
|
screenshot.daemon.retry.attempts | 1 |
Example:
|
screenshot.daemon.enabled | false |
Toggle the screenshot function to enable or disable in the background.
Example:
|
screenshots.dashboards.enabled | true |
Example:
|
screenshots.datasource-charts.enabled | true |
Example:
|
screenshot.height
screenshot.width |
588
1000 |
Set the size of the screenshot.
Example:
|
Password Policy | ||
auth.password.policy.specialCharacters | [email protected]#$%^&*()-_=+,.:;<> | |
auth.password.policy.minCharacters | 9 | |
auth.password.policy.maxCharacters | 255 | |
auth.password.policy.minLowercaseCharacters | 1 | |
auth.password.policy.minUppercaseCharacters | 1 | |
auth.password.policy.minNumericCharacters | 1 | |
auth.password.policy.minSpecialCharacters | 1 | |
auth.password.policy.helpMessage | Password must contain at least 9 characters including 1 lowercase, 1 uppercase, 1 number and 1 special ([email protected]#$%^&*()-_=+,.:;<>). | Text is not enclosed in quotation marks. |
Data Export Properties | ||
zoomdata.export.data.max.cols | 1000 columns | Use this property to define the maximum number of columns that can be exported for two-dimensional chart visualizations (such as a pivot table). Zoomdata enforces this limit for chart data, but does not enforce it for raw data. The distributed default for this setting is 1000 columns. Valid values can range from 0 through 2147483647 columns. |
zoomdata.export.data.max.rows | 100000 rows |
Use this property to define the maximum number of rows that can be exported for charts. Zoomdata enforces this limit for chart data. However, for raw data, Zoomdata produces an error if the number of rows requested for export exceeds this setting. The distributed default for this setting is 100000 rows. Valid values can range from 0 through 2147483647 rows. |
Field Settings | ||
FieldsTypeDetector | 200 characters | Use this property to set the maximum character length of attribute fields. If this limit is exceeded, the field will be recognized as a Text field. |
Zoomdata.env Variables
Environment Property Name | Default Value | Description |
---|---|---|
DEBUG_ENABLED | 0/false |
Toggle switch to enable or disable the Java debug capability. To enable, enter '1' or 'true'.
Example:
|
DEBUG_PORT | 9393 |
The default port for the Java debug capability.
Example:
|
JAVA_OPTS | -Xss256k -Xms2048m -Xmx8192m | Java-related options for JVM. Refer to Oracle's article on Java HotSpot VM Options for information. |
KERBEROS_CONFIG | /etc/krb5.conf | Default location for the Kerberos configuration details. However, the path to the file may be different in your environment. Refer to Oracle's article on File Formats for information. |
KERBEROS_PRINCIPAL | [email protected] | Kerberos principal name |
KERBEROS_KEYTAB | /etc/zoomdata/zoomdata.keytab | Kerberos keytab location |
PROXY_HOST | user defined | For cloud-based connectors (including Google Analytics and Salesforce) being used in a proxy configuration, this property specifies the server host to be returned for calls, and identifies the proxy host server that will provide internet access. |
PROXY_PORT | user defined | For cloud-based connectors (including Google Analytics and Salesforce) being used in a proxy configuration, this property specifies the server port to be returned for calls, and identifies the proxy port server that will provide internet access. |
Scheduler.properties Variables
Property Name | Default Value | Description |
---|---|---|
server.port | 3333 |
Sets the default port for the scheduler service.
Example:
|
spring.datasource.url | jdbc:postgresql://localhost:5432/zoomdata-scheduler |
Identifies the JDBC URL where the Scheduler service resides. If on the same server as the Zoomdata Server, will be 'localhost'.
|
spring.datasource.name | zoomdata |
Sets the username access credential for the Scheduler service.
Example:
|
spring.datasource.password | YourSchedulerPassword |
Sets the password access credential for the Scheduler service.
Example:
|
syslog.log.level | OFF | |
syslog.host | 127.0.0.1 |
Identifies the host IP for the system log.
Example:
|
syslog.port | 1514 |
Identifies the port ID for the system log.
Example:
|
Scheduler.env Variables
Environment Property Name | Default Value | Description |
---|---|---|
JAVA_OPTS | -Xms512m -Xmx1024m | Java-related options for JVM specifically for the Scheduler component. Refer to Oracle's article on Java HotSpot VM Options for information. |
Was this topic helpful?