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: `access.control.allow.origin= user_defined` 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: `logs.dir=/opt/ zoomdata /logs).`
multipart.maxFileSize	500Mb	Example: `multipart.maxFileSize=500Mb`
multipart.maxRequestSize	500Mb	Example: `multipart.maxRequestSize=500Mb`
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: `saml.maxAuthAge=86400`
server.compression.enabled	spring.http.gzip.enabled	Enables gzip compression for http requests. Example: `server.compression.enabled=spring.http.gzip.enabled`
server.contextPath	/zoomdata	Example: `server.contextPath=/zoomdata`
server.session-timeout	1800	Sets when your Zoomdata session will timeout (in seconds). Example: `server.session-timeout=1800`
source.attribute.values.limit	1000	Sets the limit for the number of attribute values that can be displayed in the Filter list. Example: `source.attribute.values.limit=1000`
scheduler.service.url	http://localhost:3333	Points to the scheduler service that Zoomdata uses to clear caches. Example: `scheduler.service.url=http://localhost:3333`
Default Account Configurations
supervisor.password	user defined	Allows the account administrator to set the password for the supervisor role. Example: `supervisor.password= YourSupervisorPassword`
admin.password	user defined	Allows the account administrator to set the password for the admin role. Example: `admin.password= YourAdminPassword`
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: `disable.auth=false`
autologin.username	admin	Sets the username that can be automatically logged into Zoomdata (used in conjunction with the property file 'disable.auth'. Example: `autologin.username=admin`
Keystore Properties
keystore.location	classpath:security/zoomkeystore.jks	Zoomdata uses symmetric encryption. You can point to a new keystore to strengthen security. Example: `keystore.location=classpath:security/zoomkeystore.jks` 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.password=zoomkey`
keystore.key.alias	zoomkey	Example: `keystore.key.alias=zoomkey`
keystore.key.password	zoomkey	Example: `keystore.key.password=zoomkey`
Server SSL Properties
server.ssl.ciphers	user defined	Example: `server.ssl.ciphers= YourCipher`
server.ssl.client_auth	user defined	Example: `server.ssl.client-auth= YourClientAuth`
server.ssl.key-store	HOME/conf/keystore	Sets the path for the keystore location. Example: `server.ssl.key-store=HOME/conf/keystore`
server.ssl.key_store_password	user defined	Stores the keystore password. Example: `server.ssl.key-store-password= YourPassword`
server.ssl.key_store_type	user defined	Example: `server.ssl.key-store-type= YourKeystoreType`
server.ssl.trust_store	user defined	Example: `server.ssl.trust-store= YourTrustStore`
server.ssl.trust_store_password	user defined	Example: `server.ssl.trust-store-password= YourTrustStorePassword`
server.ssl.trust_store_type	user defined	Example: `server.ssl.trust-store-type= YourTrustStoreType`
Security Properties
saml.artifactBindingDefault	true	Example: `saml.artifactBindingDefault=true`
saml.useMultiValueList	true	Example: `saml.useMultiValueList=true`
saml.stringDelimiter-,		Example: `saml.stringDelimiter-,=`
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.connection-properties:jaasApplicationName=com.sun.security.jgss.initiate`
spring.datasource.url	jdbc:postgresql:// your_IP_address :5432/zoomdata	Property to identify PostgreSQL URL. Example: `spring.datasource.url=jdbc:postgresql:// your_IP_address :5432/zoomdata`
spring.datasource.username	zoomdata	Property to identify the username in PostgreSQL. Example: `spring.datasource.username=zoomdata`
Source Sampling Properties
source.sampling.count.default	1000	Example: `source.sampling.count.default=1000`
source.attribute.values.limit	1000	Example: `source.attribute.values.limit=1000`
System Log Properties
syslog.log.level	OFF	Sets the message logging function. The following options are available for this property: TRACE DEBUG INFO WARN ERROR Example: `syslog.log.level=DEBUG`
syslog.host	127.0.0.1	Sets the host IP address for message logging. Example: `syslog.host=127.0.0.1`
syslog.port	1514	Sets the port for message logging. Example: `syslog.port=1514`
syslog.suffix	local	Specifies a suffix that is appended at the end of the log entry that Zoomdata generates. Example: `syslog.suffix=local`
Screenshot Properties
screenshot.webdriver.timeout	180	Example: `screenshot.webdriver.timeout=180`
screenshot.daemon.schedule.rate	24h	Example: `screenshot.daemon.schedule.rate=24h`
screenshot.daemon.retry.attempts	1	Example: `screenshot.daemon.retry.attempts=1`
screenshot.daemon.enabled	false	Toggle the screenshot function to enable or disable in the background. Example: `screenshot.daemon.enabled=true`
screenshots.dashboards.enabled	true	Example: `screenshots.dashboards.enabled=true`
screenshots.datasource-charts.enabled	true	Example: `screenshots.datasource-charts.enabled=true`
screenshot.height screenshot.width	588 1000	Set the size of the screenshot. Example: `screenshot.height=704`
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.

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_ENABLED=false`
DEBUG_PORT	9393	The default port for the Java debug capability. Example: `DEBUG_PORT=9393`
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: `server.port=3333`
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'. 5432 is the default port for the PostgreSQL metadata store 'zoomdata-scheduler' is the default name stored in the Postgres metadata store
spring.datasource.name	zoomdata	Sets the username access credential for the Scheduler service. Example: `spring.datasource.name=zoomdata`
spring.datasource.password	YourSchedulerPassword	Sets the password access credential for the Scheduler service. Example: `spring.datasource.password= YourSchedulerPassword`
syslog.log.level	OFF
syslog.host	127.0.0.1	Identifies the host IP for the system log. Example: `syslog.host=127.0.0.1`
syslog.port	1514	Identifies the port ID for the system log. Example: `syslog.host=1514`

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?