Zoomdata Version

Configuring Your Zoomdata Installation

The Zoomdata server uses multiple configuration files to ensure successful deployment of Zoomdata in your operating environment. Each Zoomdata component has a configuration file including:

  • Zoomdata Server (zoomdata.properties and zoomdata.jvm)
  • Screenshot microservice (screenshot-service.properties and screenshot-service.jvm)
  • Query engine microservice (query-engine.properties, query-engine.env, and query-engine.jvm
  • Connector servers (each with their own unique property file)

See Configuration Properties and Options, Managing the Zoomdata Query Engine, and Connector Properties to view the variables and parameters available in these files.

These configuration files are where the Zoomdata administrator can make changes to the Zoomdata server. These files need to be created after the Zoomdata server has been installed to override Zoomdata's default configuration. To access these files on the Zoomdata server and make edits, follow the step-by-step instructions below.

Accessing A Zoomdata Configuration File

The configuration files are located in either the /etc/zoomdata or the /opt/zoomdata/conf directory (depending on how you set up your server).

To access and update a Zoomdata configuration file:

  1. From your terminal, SSH to your Zoomdata server.
  2. Stop the appropriate Zoomdata microservice (Zoomdata, Screenshot, or the specific connector server). For the appropriate Linux command (for CentOS v6, v7 or Ubuntu v14, v16), see Stopping Zoomdata Microservices.
  3. Use the following command to access and open the configuration file:
    vi /etc/zoomdata/<config-file-name>

    If the configuration file does not exist, this command creates it.

    If you are not logged in as a root user, then you need to enter sudo vi /etc/zoomdata/zoomdata.properties to create the desired file.
    If zoomdata.properties is not the configuration file you need to edit, specify the file name you need: zoomdata.jvm | screenshot-service.properties | screenshot-service.jvm
    Make sure the file is readable by the zoomdatamicroservice account.
  4. Add the new variable or property into the file on a new line or edit an existing one, as needed. Read either Configuration Properties and Options or Connector Properties (depending on your needs), to view the available properties and variables.
  5. Save and exit the configuration file.
  6. Restart Zoomdata microservices. For the appropriate Linux command line, see Restarting Zoomdata Microservices.

Wait a few minutes for the microservice to restart completely, then open a new browser window to log back into Zoomdata. Confirm that your changes have taken effect.

Situations where the zoomdata.properties file needs to be created include:

Situations where the zoomdata.jvm file needs to be created include:

Was this topic helpful?