Amurg Documentation

Amurg is a self-hosted control plane for deploying, managing, and interacting with AI agents through a mobile-friendly chat UI. It consists of three components — a Hub that handles authentication, routing, and persistence; a Runtime that spawns and manages agent processes; and a UI that provides the browser-based chat interface.

This documentation covers everything you need to configure, deploy, and extend Amurg. Choose a topic below to get started.

Installation

One-line install script, interactive setup wizards, CLI reference, and build-from-source instructions.

Configuration

Hub and runtime JSON config reference. Server settings, auth, storage, session behavior, and agent definitions.

Adapters

All 8 adapter profiles with config fields, capability tables, and example JSON for each.

API Reference

HTTP endpoints, request and response schemas, authentication headers, and error codes.

WebSocket Protocol

Real-time message types, envelope format, session lifecycle, and bidirectional flows.

Voice Input

Voice dictation with browser Web Speech API or a local Whisper server. Hold-to-talk, tap-to-toggle, edit before send.

Deployment

Docker Compose setup, production configuration, reverse proxy, TLS, and monitoring.

Security

Authentication providers, JWT tokens, agent authorization, permission modes, and audit logging.

Getting Started

The fastest way to get started is the one-line install script and interactive setup wizard:

curl -fsSL https://raw.githubusercontent.com/amurg-ai/amurg/main/scripts/install.sh | sh
amurg-runtime init
amurg-runtime run

See the Installation page for the full walkthrough, hub install, and CLI reference. For Docker-based deployments, see Deployment. For config file details, see Configuration.