OpenFrame is on your phone now! · iOS and Android apps are live. Get alerts and handle tickets on the go!

OpenFrame Documentation

Deployment guides, the CLI reference, architecture and admin guides for OpenFrame

OpenFrame OSS Tenant — Documentation

Welcome to the documentation for OpenFrame OSS Tenant, the open-source multi-service, multi-tenant foundation of the OpenFrame platform. This index provides navigation to all available documentation sections.

🚀 Getting Started

New to OpenFrame OSS Tenant? Start here.

Guide	Description
Introduction	What is OpenFrame OSS Tenant? Key features and architecture overview
Prerequisites	Required tools, system requirements, and toolchain setup
Quick Start	Clone, build, and run the platform in a few steps
First Steps	What to explore and configure after your first setup

🛠️ Development

Guides for engineers building with or contributing to OpenFrame OSS Tenant.

Guide	Description
Development Overview	Technology stack, shared libraries, and navigation to all dev guides
Environment Setup	IDE recommendations, extensions, and toolchain configuration
Local Development	Clone, run, debug, and develop services locally
Architecture Overview	High-level diagrams, component relationships, and data flows
Testing Overview	Test structure, running tests, and writing new tests
Security Guidelines	Auth patterns, secrets management, and input validation
Contributing Guidelines	Code style, branch naming, PR process, and commit format

📖 Reference Architecture

Technical reference documentation generated from source code analysis.

Document	Description
Architecture Overview	Complete component documentation, data flows, CLI reference, and key file index

📊 Architecture Diagrams

Visual documentation of the platform architecture and data flows.

Diagrams are available in Mermaid format (.mmd) and can be rendered in any Mermaid-compatible viewer:

Diagram	Description
High-Level System Architecture	Full platform overview: clients, gateway, services, data layer
Service Dependency Graph	How frontend, backend, and agent components depend on each other
Multi-Tenant OAuth2 Security Flow	JWT issuance, gateway validation, and tenant isolation sequence
Agent Registration and Authentication	Rust agent registration, token exchange, and NATS subscription sequence

🔧 CLI Tools

The OpenFrame CLI tools are maintained in a separate external repository:

Resource	Link
Repository	flamingo-stack/openframe-cli
Installation	Installation Guide
Documentation	CLI Documentation

Note: CLI tools are not located in this repository. Always refer to the external repository for installation and usage.

🤝 Community

All support, feature requests, and development discussions happen in the OpenMSP Slack community — GitHub Issues and GitHub Discussions are not used.

OpenMSP Community: https://www.openmsp.ai/
Join Slack: Invite Link
OpenFrame: https://openframe.ai
Flamingo: https://flamingo.run

📖 Quick Links

Project README — Main project overview and quick start
Contributing — How to contribute to this project
License — License information
Releases — Release notes and downloads

Documentation generated by 🦩 Flamingo AI Technical Writer

Frequently Asked Questions

knowledge-base

MSP AI Agents

How Much Can AI Agents Save an MSP?

On a five-person desk, reported deployments show $78,000 to $130,000 in annual direct labor savings, roughly 30% fewer escalations, and 15% to 20% better SLA compliance. Broader MSP adoption data adds ticket handling time cut by 45% and five to 12 points of margin, all from reclaimed capacity rather than headcount cuts.

Still deciding?

Mingo answers from our docs and customer stories.