React, NodeJS and Postgres
Postgres setup

Deploying Vizzly with Postgres

These first steps will take you through setting up the Vizzly project within a few CLI commands, to deploying the Vizzly query engine with a Postgres integration.

Vizzly CLI

To get started, sign in to your Vizzly account (opens in a new tab), and visit the CLI authentication page (opens in a new tab). On that page, you will find two CLI commands, one to install the Vizzly CLI, and the other to authenticate the CLI. After running those commands, return here to continue the setup process.

Project setup

In this step, we will set up all the main resources that you need for your Vizzly integration in a single command.

vizzly setup -i postgres

You will now have


Now we need to deploy the Vizzly Query Engine. If you are doing this for the first time, we strongly recommend doing this for your local or staging environment.

Follow either one these guides to deploy your Vizzly Query Engine to your chosen environment;

Connecting to your data

To connect the Vizzly Query Engine to your data, you will need to navigate to the /connect page of your deployed Query Engine. Once your connection has been established, the /status page will tell you it is ready to start accepting queries!

Alternatively connecting via environment variables

If you would prefer to provide your connection credentials through environment variables, we support that too;

Postgres connection environment variables


Set this environment variable value to "postgres".


Set the password to use in the connection to your postgres database.


Set the name of the database to use in the connection to your postgres database.


Set the username to use in the connection to your postgres database.


Set the host to use in the connection to your postgres database.


Set the port to use in the connection to your postgres database.


Set the connection credentials using a single connection string.

These integation specific variables are in addition to the common environment variables.

Config Manager

Now that you have deployed the Vizzly Query Engine, we will now be able to open the config manager to build the data set schemas that you want to make available to your users on the dashboard.

From the same directory as your private key, run the following command to open the config manager;

vizzly config-manager