Getting Started

Quick Start Guide

Get Akmatori up and running in minutes. This guide covers installation, initial configuration, and connecting your first alert source.

Prerequisites

Docker & Docker Compose

Docker 20.10+ and Docker Compose v2

LLM API Key

OpenAI, Anthropic, Google, or OpenRouter (configured in web UI)

Slack Workspace (Optional)

For real-time notifications

Installation

Clone the Repository

Start by cloning the Akmatori repository from GitHub:

bash

git clone https://github.com/akmatori/akmatori.git
cd akmatori

Start the Services

Launch all services using Docker Compose (first run builds containers, takes 3-5 minutes):

bash

docker compose up -d

This will start all required containers: PostgreSQL, API server, MCP Gateway, Agent Worker, and the web UI. All secrets (database password, JWT secret) are auto-generated on first run.

No .env file is required. Copy .env.example only if you need to customize ports or override auto-generated secrets.

Complete Setup Wizard

Open your browser and navigate to:

text

http://localhost:8080

On first access, you'll see a setup wizard. Create your admin password (minimum 8 characters) to complete the setup.

Configure LLM Provider

After logging in, go to Settings → LLM Provider and configure your preferred AI provider:

OpenAI (GPT-4o, o1, o3)
Anthropic (Claude 3.5 Sonnet, Claude 3 Opus)
Google (Gemini 2.0, Gemini 1.5 Pro)
OpenRouter (100+ models)
Custom/On-Prem (Ollama, vLLM, etc.)

LLM API keys are stored encrypted in the database. No environment variables needed.