Skip to content

Set up Uffizzi for your application


If this is your first time using Uffizzi, we recommend following the Quickstart (GitHub Actions) or Quickstart (Uffizzi CI) to see how Uffizzi is configured with an example application.

Uffizzi is usually added to the end of your CI pipeline after images have been built and pushed to a container registry. Alternatively, you can use Uffizzi CI if you want to let Uffizzi build and store images for you. In either case, Uffizzi will deploy your application images and manage the environments for you. This guide will walk you through the following steps:

  1. Create a Docker Compose template - A template which defines your application configuration and is used as the basis for the Uffizzi Preview Environment.

  2. Add a preview step to your CI pipeline - This step defines the lifecycle of your Uffizzi Preview Environments.

  3. Configure credentials - Add registry credentials to grant Uffizzi access to pull images.

Next article

Create a Docker Compose template