Documentation

Swarm docs

Everything you need to deploy, configure, and operate your private AI mesh.

Overview

Getting started

Deploy your first Swarm mesh in minutes.

Architecture

How the components of Swarm fit together.

Aligner

Aligner setup

Deploy an Aligner node to index your local files.

Security model

How Swarm controls access to sensitive data.

Orchestrator

Orchestrator setup

Deploy and start the Orchestrator on your main machine.

Configuration reference

All Orchestrator configuration options.

API reference

HTTP and WebSocket API for the Orchestrator.

Web UI

Web UI overview

The browser-based interface for querying your Swarm mesh.

Chat interface

Using the Swarm chat and mesh canvas.