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, OpenRouter, NVIDIA NIM, MiniMax, Ant Ling, or custom endpoints
Slack Workspace (Optional)
For real-time notifications
Installation
Clone the Repository
Start by cloning the Akmatori repository from GitHub:
git clone https://github.com/akmatori/akmatori.git
cd akmatoriStart the Services
Launch all services using Docker Compose (first run builds containers, takes 3-5 minutes):
docker compose up -dThis 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.
.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:
http://localhost:8080On 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-5.5, GPT-5.4, GPT-5.3 Codex)
- Anthropic (Claude Opus 4.8, Sonnet 4.6, Haiku)
- Google (Gemini 3 Pro Preview, Gemini 2.5 Pro, Flash)
- OpenRouter (Multi-provider gateway)
- NVIDIA NIM (Llama and other hosted open models)
- MiniMax (MiniMax-M3 with adaptive thinking support)
- Ant Ling (Ling-2.6-1T)
- Custom (OpenAI-compatible endpoint)
- Custom/On-Prem (Ollama, vLLM, etc.)