Deployment

MindRoom can be deployed in various ways depending on your needs.

Deployment Options

Method	Best For
Full Stack (Docker Compose)	All-in-one: backend + frontend + Matrix (Synapse) + Element
Docker (single container)	Backend-only or when you already have Matrix
Kubernetes	Multi-tenant SaaS, production
Direct	Development, simple setups

Quick Start

Full Stack (recommended)

git clone https://github.com/mindroom-ai/mindroom-stack
cd mindroom-stack
cp .env.example .env
$EDITOR .env  # add at least one AI provider key

docker compose up -d

Direct (Development)

mindroom run --storage-path ./mindroom_data

The config file path is set via MINDROOM_CONFIG_PATH (defaults to ./config.yaml).

Docker (single container)

docker run -d \
  --name mindroom-backend \
  -p 8765:8765 \
  -v ./config.yaml:/app/config.yaml:ro \
  -v ./mindroom_data:/app/mindroom_data \
  --env-file .env \
  ghcr.io/basnijholt/mindroom-backend:latest

See the Docker deployment guide for full setup including the frontend.

Kubernetes

See the Kubernetes deployment guide for Helm chart configuration.

Required Configuration

Full stack:

# .env in the full stack repo
ANTHROPIC_API_KEY=sk-ant-...
# Add other providers as needed

Direct and single-container deployments:

Matrix homeserver - Set MATRIX_HOMESERVER (must allow open registration for agent accounts)
AI provider keys - At least one of ANTHROPIC_API_KEY, OPENAI_API_KEY, etc.
Persistent storage - Mount mindroom_data/ to persist agent state

See the Docker guide for the complete environment variable reference.