Quick Setup: Docker Compose

Prerequisites

Docker Compose

Steps

AnyVar provides a ready-to-use Docker Compose configuration that launches all required services: SeqRepo, UTA, the AnyVar database, and the AnyVar REST service itself. This is the fastest way to get a fully functional instance running for local development or evaluation.

Clone the AnyVar repository (optionally switching to a release tag), and enter the directory:

% git clone https://github.com/biocommons/anyvar
% cd anyvar

Create all required volumes:

% docker volume create seqrepo_vol
% docker volume create uta_vol
% docker volume create anyvar_vol

Download uta_20241220.pgd.gz from https://dl.biocommons.org/uta/ using a web browser and move it to the root of the repository.

Then, launch the application:

% docker compose up

This will:

pull the necessary images,
start SeqRepo (or use your local SeqRepo if configured),
start UTA and AnyVar’s PostgreSQL database,
and launch AnyVar REST service.

Once the containers are running, visit http://127.0.0.1:8010/docs to view the interactive Swagger UI and confirm the service is responding.

See REST API usage for supported server functions and endpoints, and Configuring Docker Compose for more configuration information.