This guide describes how to install, configure and verify a VariantValidator installation.
Whether you choose a native installation or Docker deployment, these guides will help you install the required software, configure the databases and confirm that VariantValidator is operating correctly.
Install VariantValidator natively on Linux or macOS using the recommended Conda environment.
This guide covers:
- Native installation
- Installing the required databases
- Verifying the installation
- Running the test suite
Install VariantValidator using Docker.
The guide includes both:
- Quick Start — Docker databases with a local VariantValidator installation.
- Full Docker Installation — the complete VariantValidator software stack running in Docker.
Guidance for installing VariantValidator on Windows using Windows Subsystem for Linux (WSL2) or Docker Desktop.
Configure VariantValidator using the interactive configuration utility.
Topics include:
- Running the configuration utility
- Configuring database connections
- Configuring SeqRepo
- Updating existing configurations
Solutions to common installation and configuration problems, including database connectivity, SeqRepo configuration and dependency issues.
For most users we recommend the following workflow:
- Follow the Quick Start section of the Docker Installation Guide to install the required databases.
- Install VariantValidator locally using the native Installation Guide.
- Configure VariantValidator using the Configuration Guide.
- Verify the installation by running the VariantValidator test suite.
- Continue to the User Manual to begin using VariantValidator.