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 self-hosted --project-id "<< ID of the project you are setting up >>"

You will now have

A vizzly.env file with generated values that must be set as environment variables.
A vizzly-private.pem file you will use to sign your Vizzly identity config.
A vizzly-public.pem file that validates the identity config JSON Web Tokens (JWTs).

Deployment

Select your deployment environment for your Vizzly Query Engine;

Connecting to your data

To connect the Vizzly Query Engine to your data, open the URL of your deployed Query Engine in your browser, and you will be directed to the "get started" page where you can create the first account for the Query Engine and then establish the connection to your database.

Alternatively connect via environment variables

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

Postgres connection environment variables

VIZZLY_CLIENT

Set this environment variable value to "postgres".

VIZZLY_POSTGRES_PASSWORD

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

VIZZLY_POSTGRES_DATABASE

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

VIZZLY_POSTGRES_USER

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

VIZZLY_POSTGRES_HOST

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

VIZZLY_POSTGRES_PORT

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

PG_CONNECTION_STRING

Set the connection credentials using a single connection string.

DATABASE_URL

Alias for PG_CONNECTION_STRING, useful for some deployment environments that set this variable by default, such as Heroku.

VIZZLY_CONNECTION_SSL_REQUIRE

Optional - Require SSL for connection to the database by setting this variable to 'false' or 'true'.

VIZZLY_CONNECTION_SSL_REJECT_UNAUTHORIZED

Optional - Allow connecting when the SSL authorization fails

VIZZLY_CONNECTION_SSL_CA

Optional - Set a base64 encoded CA certificate to use for connections

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 have access to the config manager where we can build and edit the data sets that you want to make available to your users on the dashboard.