Skip to content

Getting Started

This section walks you through setting up Verity on your local machine, configuring the platform, and building your first custom connector.

Learning Path

graph LR
    A["<b>Quick Start</b><br/>Install & run locally"] --> B["<b>Configuration</b><br/>Environment variables<br/>& service tuning"]
    B --> C["<b>First Connector</b><br/>Build a custom<br/>platform integration"]

    style A fill:#7c4dff,color:#fff,stroke:none
    style B fill:#536dfe,color:#fff,stroke:none
    style C fill:#40c4ff,color:#000,stroke:none

Sections

  • Quick Start

    Get Verity running locally in under 10 minutes. Clone the repo, spin up 19 containers with Docker Compose, seed sample data, and verify the API and dashboard are working.

    You'll learn: Docker Compose setup · service health checks · seeding test data · basic API verification

    Quick Start

  • Configuration

    Complete reference for every environment variable in the platform. Covers shared infrastructure settings, per-service configuration with pydantic-settings, and authentication setup for development and production.

    You'll learn: Environment variable prefixes · database connection strings · Kafka & Redis config · Azure AD auth setup

    Configuration

  • First Connector

    Step-by-step tutorial for building a custom platform connector using the Verity SDK. Subclass BaseConnector, implement the required methods, and watch your events flow through the processing pipeline.

    You'll learn: Connector SDK · RawEvent & PermissionSnapshot dataclasses · Kafka publishing · checkpointing

    First Connector

Prerequisites at a Glance

Before you begin, make sure you have:

Requirement Minimum Version Purpose
Docker 24.0+ Container runtime for all services
Docker Compose v2.20+ Multi-container orchestration
Python 3.12+ SDK development and seed scripts
Node.js 20+ Frontend development (optional)
Git 2.40+ Source control

Hardware Recommendations

Verity runs 19 containers locally. We recommend at least 8 GB of RAM allocated to Docker and 20 GB of free disk space for container images and persistent volumes.