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.
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 |
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 |
Technical reference documentation generated from source code analysis.
| Document | Description |
|---|---|
| Architecture Overview | Complete component documentation, data flows, CLI reference, and key file index |
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 |
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.
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
- 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