Installation Guide

Deploy Clovar with Docker Compose

Five containers. Zero configuration. The complete AI workforce platform running on your infrastructure in under five minutes.

01

Prerequisites

You'll need the following installed on your machine:

  • Docker Desktop (or Docker Engine + Compose plugin on Linux)
  • Git to clone the repository
  • At least 8 GB RAM allocated to Docker (SQL Server requirement)
  • An Anthropic or OpenAI API key (for agent reasoning and embeddings)
02

Clone the repository

Coming soon.

03

Create your environment file

Create a .env file in the platform/ directory:

# SQL Server passwords (choose strong passwords)
SQL_SA_PASSWORD=YourStrong!Passw0rd
DB_PASSWORD=YourStrong!Passw0rd

# Optional: set your instance URL
CLOVAR_BASE_URL=http://localhost:5001

The SA password must meet SQL Server complexity requirements: at least 8 characters with uppercase, lowercase, digits, and symbols.

04

Start the stack

docker compose up -d

This starts all five services:

clovar-api REST API, Swagger, SignalR, Hangfire jobs
localhost:5002
clovar-web MVC dashboard with Tailwind CSS
localhost:5001
sqlserver SQL Server 2022 with graph tables
localhost:1433
redis Cache, pub/sub, rate limiting
internal
qdrant Vector search with 1536d embeddings
internal

First run takes 2-3 minutes while SQL Server initializes the schema and seed data. Watch progress with docker compose logs -f sqlserver

05
06

Configure your AI provider key

On first launch, the setup wizard guides you through:

  • Creating your first business (tenant)
  • Adding your Anthropic or OpenAI API key (BYOK — you pay the AI provider directly)
  • Creating your first department
  • Deploying your first agent

A master API key is auto-generated on first run and saved to state/bootstrap-master-key.txt inside the API container. Use this for initial device pairing.

07

What's included in Community edition

No license key required. Community edition gives you:

6 agents
3 departments
10 workflows
1 knowledge collection
All 17 tool categories
Graph + vector memory
Cost tracking & budgets
14 background jobs

Need more? View pricing for Professional and Enterprise editions.

Need help getting set up?

If you run into issues or need guidance configuring the platform for your use case, get in touch. We offer implementation consulting for Professional and Enterprise customers.