Installing Zoomdata Manually

If running the installer script is not a viable options for you, you can install Zoomdata manually.

To install Zoomdata manually, complete the following steps:

  1. Review the prerequisites and prepare the server as recommended.
  2. Preconfigure your server by establishing a dedicated Zoomdata directory on your target server.
  3. Download the Zoomdata installation component packages and placing the microservices in the Zoomdata directory.
  4. Install the metadata store that Zoomdata uses (which is PostgreSQL v9.5).
  5. Install and then activate the Zoomdata components (including the Zoomdata server, the Screenshot microservice, and the Connector microservices).
  6. Complete the post-installation steps.


Refer to System Requirements and Sizing Guidelines for information on the recommended settings for deploying Zoomdata on-premises.

The target server for the Zoomdata program should meet the following conditions:

  • The server does not have PostgreSQL already installed
  • The server does not contain any Zoomdata property files, meaning if a previous version of Zoomdata was installed in this server, ensure that all property files have been deleted.
  • The user installing Zoomdata is able to use the sudo command in the server

CentOS and Ubuntu Requirements

If your server is running either CentOS v7 or Ubuntu v16, you can skip this prerequisite step. Zoomdata has no requirements specific to these two environments.

If you are installing Zoomdata on a server running either CentOS v6 or Ubuntu v14, then you must configure the maximum number of open processes and files that can be run in your operating environment. See Installation Prerequisites for instructions. Be sure to complete this prerequisite setup before installing Zoomdata.

The Google Chrome-based Screenshot microservice provided with Zoomdata v3.2 and later versions cannot be installed in CentOS v6 environments because the Chrome dependencies do not support that platform. See Setting Up the Screenshot Microservice.

Time Synchronization Requirements

In addition, Zoomdata benefits from time synchronization in your network. Specifically, Zoomdata leverages Network Time Protocol (NTP), which performs time synchronization of networked servers to Coordinated Universal Time (UTC). If needed, read Using the Network Time Protocol to Synchronize Time for instructions on setting this up.

Java Requirements

You must have Java 8 (1.8.0_131) or later installed to use Zoomdata. Without it, Zoomdata will not start. For steps on how to set Zoomdata to use a different version of Java, see Configuring JRE/JVM.

After you have made any needed adjustments to your network configurations, return to this topic to continue the installation process.

Prerequisite Steps

Before you can download the Zoomdata installation packages onto your server, you need to create the Zoomdata directory where the installation and property files are stored. After the directory is created, you need to create property files in that directory.

Create the Zoomdata Directory

Create the following directory to store all Zoomdata-related files:

sudo install -o root -g root -m 0755 -d /etc/zoomdata

Create the Default Zoomdata Configuration File

Create the default Zoomdata configuration file that contains the available variables and parameters related to Zoomdata operation:

sudo touch /etc/zoomdata/
sudo chmod 0644 /etc/zoomdata/
sudo vi /etc/zoomdata/

Add the Default Metadata Parameters to the Appropriate Zoomdata Properties File

  1. Add the following metadata store-related parameters in the newly-created file. Essentially, you are storing the username and password details for the metadata store in this property file.

    spring.datasource.url=jdbc:postgresql://<ip of host>:<port>/zoomdata
    keyset.destination.params.jdbc_url=jdbc:postgresql://<ip of host>:<port>/zoomdata-keyset
    upload.destination.params.jdbc_url=jdbc:postgresql://<ip of host>:<port>/zoomdata-upload
  2. Add the following zoomdata-qe database metadata store-related parameters in the newly-created file.

    spring.qe.datasource.jdbcUrl=jdbc:postgresql://<ip of host>:<port>/zoomdata-qe

In each case, remember to save the files before exiting the editor.

Download Dependencies and the Zoomdata Installation Packages

Zoomdata requires the following external dependencies for a successful installation:

If you did not already receive the Zoomdata installation package, contact Zoomdata Technical Support to request it. In the request, be sure to include the Linux operating system version you are using (for example, CentOS v7). You can select the Support button on this page to create your request.

If your server does not have internet access, you will need an internet-enabled computer to download the packages and then move them to the intended server.

Set Up Zoomdata's Metadata Store

Zoomdata installs and uses a standard PostgreSQL v9.5 database instance to store its metadata. Zoomdata strongly recommends using this instance as it is configured with the appropriate settings.

If you would like to use your own or alternative PostgreSQL instance, contact Zoomdata Technical Support for further guidance.

Read Installing and Setting Up Zoomdata's Metadata Store. Complete the setup instructions and then return to this topic to continue the manual installation of Zoomdata on your server.

Installation Steps

After you have received the download instructions from your Zoomdata representative, remember to place the installation packages in the Zoomdata directory on the target server. The following Zoomdata components are included in your installation packages:

  • The Zoomdata server
  • Connector microservices
  • Query Engine

After all the dependencies are in place, follow the steps below for your server's OS to install, enable, and run Zoomdata microservices on your server.

Step 1: Install Zoomdata

Install Zoomdata in a CentOS Environment

Use the following command to install Zoomdata in a CentOS environment:

sudo yum install zoomdata* -y

Install Zoomdata in an Ubuntu Environment

Use the following command to install Zoomdata in an Ubuntu environment:

sudo dpkg -i zoomdata*

Step 2: Set Zoomdata Microservices to Start Whenever the Server Boots

The following command line allows Zoomdata microservices to automatically start whenever the server is started or rebooted:

For CentOS v6, run the following command:

ls /etc/init.d/zoomdata* | xargs -n1 basename | xargs -I % sudo chkconfig % on

Optionally, you can manually set up each Zoomdata microservice by running the following commands in CentOS v6:

sudo chkconfig zoomdata-edc-<connector-name> on
sudo chkconfig zoomdata-screenshot-service on
sudo chkconfig zoomdata-consul on
sudo chkconfig zoomdata on
sudo chkconfig zoomdata-query-engine on

For Ubuntu v14, run the following command:

ls /etc/init.d/zoomdata* | xargs -n1 basename | xargs -I % sudo update-rc.d % defaults

Optionally, you can manually set up each Zoomdata microservice by running the following commands in Ubuntu v14:

sudo update-rc.d zoomdata-edc-<connector-name> defaults
sudo update-rc.d zoomdata-screenshot-service defaults
sudo update-rc.d zoomdata-consul defaults
sudo update-rc.d zoomdata defaults

For CentOS v7 and Ubuntu v16, run the following command:

sudo systemctl enable $(systemctl list-unit-files | grep zoomdata | awk '{print $1}')

Optionally, you can manually set up each Zoomdata microservice by running the following commands in CentOS v7 and Ubuntu v16:

sudo systemctl enable zoomdata-edc-<connector-name>
sudo systemctl enable zoomdata-screenshot-service
sudo systemctl enable zoomdata-consul
sudo systemctl enable zoomdata
sudo systemctl enable zoomdata-query-engine

Step 3: Enable Zoomdata Microservices

To enable Zoomdata microservices in CentOS v6 and Ubuntu v14 environments, run the following command:

ls /etc/init.d/zoomdata* | xargs -n1 basename | xargs -I % sudo service % start

Optionally, you can manually enable each Zoomdata microservice by running the following commands in CentOS v6 and Ubuntu v14:

sudo service zoomdata-edc-<connector-name> start
sudo service zoomdata-edc-rts start
sudo service zoomdata-screenshot-service start
sudo service zoomdata-query-engine start
sudo service zoomdata start

To enable Zoomdata microservices in CentOS v7 and Ubuntu v16 environments, run the following command:

sudo systemctl start $(systemctl list-unit-files | grep zoomdata | awk '{print $1}')

Optionally, you can manually enable each Zoomdata microservice by running the following commands in CentOS v7 and Ubuntu v16:

sudo systemctl start zoomdata-edc-<connector-name>
sudo systemctl start zoomdata-edc-rts
sudo systemctl start zoomdata-screenshot-service
sudo systemctl start zoomdata-query-engine
sudo systemctl start zoomdata

After you have activated the Zoomdata microservices, complete the steps described in the following sections:

Post-Installation Steps

There are also post-installation options available to you including:

  1. Enabling the Real-Time Sales demo data source
  2. Setting up the Screenshot microservice.

See Post-Installation Options for setup instructions.

Configuring JRE/JVM

When starting your newly installed environment for the first time, Zoomdata takes the following rules into account:

  • If you have configured the JAVA_HOME variable and defined it as a version that meets the minimum requirements, then the provided Java version is used.
  • If you have configured the JAVA_HOME variable and it does not meet the minimum requirements, Zoomdata is started using the versions packaged with Zoomdata.
  • If the JAVA_HOME variable is not defined, Zoomdata checks for the presence of the embedded JRE in the installation directory and sets the JAVA_HOME variable to that location.

To use your own version of Java, perform these high-level steps:

  1. Navigate to the zoomdata.jvm file.
  2. Edit the file and change the JAVA_HOME variable to identify the version of Java that is already installed in the environment.
  3. Save your changes.