PreviewHQ
  • Introduction
  • Basics
    • What is Continuous Product Review?
    • What is a Preview Environment?
    • Use Cases
      • Product and Stakeholder Review
      • QA Environments
      • Automated End-to-End Testing
      • Sales Demo Environments
      • Support Training
  • Getting Started
    • Installation
    • Add Configuration
    • Add a Cluster
    • Create a Deployment
      • with a Pull Request
      • with the Dashboard
      • with the CLI
      • with the API
  • Technical Stuff
    • Defining Deployments
      • Helm Charts
      • Kubernetes Manifests
      • [UNRELEASED] Terraform
    • Configuration File
      • Branches
      • Services
      • Chart Repositories
      • Chart Values
      • Docker Registries
      • Images
      • Webhooks
    • Template Strings
    • Using Seed Data
      • Using Shared Data Sources
    • Access Control
      • Preview Application Access
      • Preview Environment Access
    • Using Third-Party Integrations
    • Debugging
    • Current Limitations
  • Sample Applications
    • Emojivoto
    • Guestbook - Helm
    • Guestbook - Manifests
  • misc
    • FAQ
    • Changelog
    • Telemetry Data
    • Links
      • Homepace
      • Dashboard
Powered by GitBook
On this page
  • Disabling Image Building
  • Custom Default URL

Was this helpful?

  1. Technical Stuff

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:

deploy:
  defaultUrl: "https://app.${PREVIEWHQ_HOSTNAME}"
Previous[UNRELEASED] TerraformNextBranches

Last updated 4 years ago

Was this helpful?