Query Engines
Deploy
Heroku

Deploy Vizzly on Heroku

Vizzly makes heroku deployments easy by supporting the DATABASE_URL environment variable for the connection.

Heroku Query Engine URI

ghcr.io/vizzly-co/query-engine:latest

Installing the Vizzly config

Upon startup, the Vizzly query engine can be configured to install the config from various sources.

You can set environment variables to install the Vizzly config from public or private github repositories.

VIZZLY_CONFIG_GITHUB_REPO

The VIZZLY_CONFIG_GITHUB_REPO environment variable is required, and specifies the organisation and name of the repository to search in for the Vizzly config in the format

<<organisation>>/<<repository name>>

For example, you might set

VIZZLY_CONFIG_GITHUB_REPO=vizzly-co/examples

VIZZLY_CONFIG_GITHUB_PATH

The VIZZLY_CONFIG_GITHUB_PATH environment variable is required and specifies the path from the base directory of the repository, to the vizzly config file. For example, you might set

VIZZLY_CONFIG_GITHUB_PATH=/some-directory/sub-directory/vizzly.config.json

VIZZLY_CONFIG_GITHUB_TOKEN

The VIZZLY_CONFIG_GITHUB_TOKEN variable is an optional GitHub access token, but it is required if your repository is private.