getting started

Quick Start

The fastest way to get Synkora running is the interactive installer. It handles prerequisite checks, environment generation, service startup, migrations, and initial seeding.

Quick Start

The fastest way to get Synkora running is the interactive installer. It handles prerequisite checks, environment generation, service startup, migrations, and initial seeding.

Recommended Path

curl -fsSL https://raw.githubusercontent.com/getsynkora/synkora-ai/main/get.sh | bash

By default, this installs into ~/synkora-ai.

To choose a custom directory:

curl -fsSL https://raw.githubusercontent.com/getsynkora/synkora-ai/main/get.sh | \
  SYNKORA_INSTALL_DIR=~/my-synkora bash

For non-interactive installs:

curl -fsSL https://raw.githubusercontent.com/getsynkora/synkora-ai/main/get.sh | \
  SYNKORA_ADMIN_EMAIL=admin@example.com \
  SYNKORA_ADMIN_PASSWORD=change-me-now \
  SYNKORA_LLM_PROVIDER=openai \
  SYNKORA_LLM_API_KEY=sk-... \
  bash -s -- --non-interactive

What the Installer Does

Checks machine resources and port conflicts
Verifies Docker, Docker Compose, Node.js, pnpm, and openssl
Generates .env files and secrets
Starts the full Docker stack
Runs migrations and seeds platform data
Creates the initial admin user

Manual Docker Compose Setup

If you prefer to bring the stack up yourself:

cp api/.env.example api/.env
cp web/.env.example web/.env.local

docker compose up -d

docker compose exec api alembic upgrade head
docker compose exec api python create_super_admin.py
docker compose exec api python seed_platform_config.py

Default Local URLs

Web app: http://localhost:3005
API: http://localhost:5001
OpenAPI docs: http://localhost:5001/docs
Langfuse: http://localhost:3001
MinIO console: http://localhost:9001

What To Do Next

Welcome

Installation