Installation checklist
Warning
Swagger Contract Testing On-Premises 1.x.x is now deprecated and no longer supported as of March 11, 2026. This version no longer receives updates, including security updates. We recommend upgrading to a supported version 2.x as soon as possible.
1. Swagger Contract Testing On-Premises license file
The Contract Testing On-Premises version requires a license file to run. You should have received this from us during the onboarding process. If not, please contact your Account Manager.
2. Run Docker Compose example
See the Docker Compose example.
3. Choose the domain name for your Contract Testing On-Premises application
e.g., https://pactflow.mycompany.com
You will need this for the next step.
4. Configure identity provider
Configure the Contract Testing On-Premises application in your identity provider. See the Azure Active Directory documentation.
5. Deploy Swagger Contract Testing On-Premises application stack
Configure the Contract Testing On-Premises Docker image to be pulled from Quay.
Use the environment variable templates to create the appropriate deployment configuration artifacts for the Contract Testing On-Premises Docker image (e.g., Cloudformation template, Helm chart etc.)
Ensure the compute resources have the appropriate specifications.
Create a PostgreSQL database.
Ensure the network is configured appropriately.
Ensure the logs are forwarded to a log aggregation service.
Make sure the license file is mounted into the running containers.
Ensure you have load-tested the system and have confidence the system can handle your baseline load and can scale with increased demand.
6. Setup database cleaning
Setup database cleaning to ensure optimal PactFlow performance and reliability.
Caution
THIS STEP IS NOT OPTIONAL
Failure to enable database cleaning is likely to result in a gradual decline in system performance and, eventually, query timeouts and system failure.