Skip to main content

​
Prerequisites

Before you begin, ensure you have the following installed:
  • Docker and Docker Compose plugin
  • A .env file in the project root (use .env.example as a template)

​
Setup Steps

1

Prepare Environment File

Copy the example environment file and configure your secrets:
cp .env.example .env
Edit .env with your actual credentials. See Environment Setup for detailed configuration options.
2

Choose Your Mode

LatentGEO supports two Docker Compose modes:
Best for: Production deployments, testing production builds
  • Backend and worker without code mounts
  • Frontend in production mode
  • Server-side API URL: http://backend:8000
  • Browser API URL: http://localhost:8000
docker compose up --build -d
3

Verify Services

Check that all services are running:
docker compose ps
Test the backend health endpoint:
curl http://localhost:8000/health
You should receive a successful response indicating the backend is ready.
4

Access the Platform

Open your browser and navigate to the following URLs:The API documentation provides an interactive interface to explore all available endpoints.

​
Real-time Features

LatentGEO includes sophisticated real-time monitoring out of the box:
  • The UI consumes GET /api/v1/sse/audits/{audit_id}/progress via a Next.js proxy
  • SSE uses Redis as the primary event source
  • If Redis doesn’t deliver events, a controlled database fallback activates
  • If SSE fails entirely, the frontend automatically falls back to polling

​
Troubleshooting SSE

If real-time updates aren’t working as expected:
Validate that Redis is running and accessible:
docker compose logs -f redis
Look for connection errors or startup issues.
Monitor backend logs for SSE-related messages:
docker compose logs -f backend
Look for SSE connection attempts and any error messages.
Confirm these environment variables are set correctly:
  • SSE_SOURCE=redis
  • SSE_FALLBACK_DB_INTERVAL_SECONDS=10
  • SSE_HEARTBEAT_SECONDS=30
  • SSE_RETRY_MS=5000
See Environment Setup for details.

​
SSE vs Webhooks

LatentGEO uses two complementary real-time mechanisms:
  • SSE: Real-time dashboard updates showing audit progress as it happens
  • Webhooks: External integrations accessible via /api/v1/webhooks/* for automations
These are not mutually exclusive. SSE solves real-time UX; webhooks solve external automation needs.

​
Next Steps

Environment Setup

Learn about all configuration options and environment variables

API Documentation

Explore the interactive API documentation (after starting services)

Build docs developers (and LLMs) love

Get started for freeTalk to us