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

OpenAI API Key

Required for AI-powered incident analysis

Slack Workspace (Optional)

For real-time notifications

Installation

1

Clone the Repository

Start by cloning the Akmatori repository from GitHub:

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

Configure Environment

Copy the example environment file and configure your settings:

bash
cp .env.example .env
# Edit .env with your configuration
You'll need to set your OpenAI API key and optionally your Slack tokens in the .env file.
3

Start the Services

Launch all services using Docker Compose:

bash
docker compose up -d

This will start all required containers: PostgreSQL, API server, MCP Gateway, Codex worker, and the web UI.

4

Access the Dashboard

Open your browser and navigate to:

text
http://localhost:8080

You should see the Akmatori dashboard. The default admin password is set in your .env file.

Next Steps