Deployment Guide

This page describes how to deploy the Data Valuation Engine using Docker Compose. The system includes:

  • Backend API (FastAPI / Uvicorn)

  • Frontend UI (Vue 3 / Vite)

  • MongoDB

  • Keycloak authentication

Prerequisites

  • Docker and Docker Compose installed on the deployment machine

  • A .env file configured (see Configuration)

Deployment with Docker Compose

1. Create the Docker network (first time only)

docker network create experiment-network
If the network already exists, Docker will return an error. That is safe to ignore.

2. Create the .env file

Copy your example and fill in values:

cp .env-example .env

3. Build and start (first deployment)

docker compose up --build -d

4. Start/stop on subsequent runs

# start
docker compose up -d

# stop
docker compose down

5. View logs

docker compose logs -f

Ports and URLs

The exact ports depend on your .env, but typically:

Optional services

MongoDB

If USE_MONGO=true, ensure Mongo variables are set:

  • MONGO_HOST, MONGO_PORT

  • MONGO_INITDB_ROOT_USERNAME, MONGO_INITDB_ROOT_PASSWORD

  • MONGO_INITDB_DATABASE

  • MONGO_CONFIGURATION_STORAGE_COLLECTION, MONGO_CONFIGURATION_STORAGE_DATABASE

Keycloak

If VITE_USE_KEYCLOAK=true, set:

  • VITE_KEYCLOAK_URL, VITE_KEYCLOAK_REALM

  • VITE_KEYCLOAK_CLIENT_ID (and secret if used)

  • Backend KEYCLOAK_CLIENT_ID / KEYCLOAK_CLIENT_SECRET if the backend validates or introspects tokens

See Also