Mimir

Fleet management control plane for Sindri environments.

Mimir provides a web dashboard and REST/WebSocket API for orchestrating, administering, and observing Sindri-managed instances across providers.

Architecture

Browser ──► Mimir Web (React 19) ──► Mimir API (Hono) ──► TimescaleDB + Redis
▲
│ WebSocket
│
Draupnir Agent (per instance)

Quick Start

# Prerequisites: Node.js 24+, pnpm 10+, Docker# Install dependencies
make install
# Start infrastructure (postgres + redis)
make infra-up
# Run database migrations
make db-migrate
# Seed demo data
make db-seed
# Start development servers
make dev

Open http://localhost:5173 in your browser.

Docker Compose (full stack)

make stack-up

Project Structure

mimir/
apps/
api/ # Node.js/TypeScript backend (Hono + Prisma + WebSocket)
web/ # React 19 frontend (Vite + TanStack Router)
packages/
shared/ # Shared TypeScript types
ui/ # UI component library
protocol/ # WebSocket protocol contract definitions
docs/ # Architecture, API spec, database schema

CI

make ci # format-check, lint, typecheck, test, build

Documentation

• Getting Started — prerequisites, setup, environment variables
• Architecture — system design, tech stack, data flow
• API Reference — REST endpoints, auth, pagination
• WebSocket Protocol — real-time channels, envelope format
• Database Schema — models, enumerations, TimescaleDB notes
• Versioning — Sindri CLI version tracking and compatibility
• Maintainer Guide — local Sindri CLI workflows, Make targets
• Contributing — development workflow, code style, testing
• Security — vulnerability reporting, RBAC, API key security
• Troubleshooting — common issues and solutions
• Release Process — tagging, versioning, Docker images
• Changelog — release history

Related Projects

• sindri — CLI tool + extension ecosystem
• draupnir — Per-instance agent extension

License

MIT