Configuration File

Preview uses a YAML configuration file located within your repository at .preview/config.yaml in order to define how Preview behaves. A core tenant is that all of the configuration should live within the repository, rather than within the Preview application.

Disabling Image Building

For many reasons, you may wish to build your images outside of Preview, and only have Preview manage the deployment.

You can disable image building by setting build.enabled: False in your config.yaml file.

When builds are disabled, Preview will go straight to the deployment step and make the following assumptions:

  • Pushed images are accessible via a registry specified in the Docker Registries config

  • Pushed images are tagged with the commit hash

  • The repository addresses that you are pushing to are appropriately included in your values files.

Custom Default URL

We use links to your Preview Environments in numerous places, including our Dashboard, Github Pull Request Pages, and our CLI. By default, these URLs point to the root of the Environment hostname.

You can overwrite this by specifying the deploy.defaultUrl in your configuration file. You can use the PREVIEWHQ_HOSTNAME template value in order to formulate this. For example, if you want a defaultUrl that goes to your app subdomain, you can use:

  defaultUrl: "https://app.${PREVIEWHQ_HOSTNAME}"

Last updated