OpenFrame Gen1 is Here · Our AI platform for autonomous IT is out of beta.

Knowledge Hub

Comprehensive guides and references for the OpenFrame platform

First Steps

After cloning and building OpenFrame OSS Tenant, here are the first 5 things to do to understand and work with the platform.

1. Understand the Project Structure

OpenFrame OSS Tenant is a polyglot monorepo. Familiarize yourself with the key directories:

openframe-oss-tenant/
├── openframe/services/          # Java/Spring Boot microservices
│   ├── openframe-api/           # GraphQL + REST API (port 8080)
│   ├── openframe-gateway/       # Spring Cloud Gateway (port 8081)
│   ├── openframe-authorization-server/  # OAuth2/OIDC (port 8082)
│   ├── openframe-external-api/  # Public REST API (port 8083)
│   ├── openframe-client/        # Agent lifecycle service (port 8084)
│   ├── openframe-stream/        # Kafka Streams (port 8085)
│   └── openframe-management/    # Platform management service
├── clients/
│   ├── openframe-client/        # Rust endpoint agent
│   └── openframe-chat/          # Tauri + React desktop app (Fae)
├── manifests/                   # Kubernetes manifests for infrastructure
└── pom.xml                      # Root Maven POM

Each Spring Boot service has its own src/main/resources/application.yml for configuration.

2. Explore the Reference Architecture

The platform architecture documentation describes how all components interconnect. Read it to understand the request lifecycle:

All client traffic flows through the Gateway Service (port 8081)
The API Service (port 8080) handles GraphQL queries and REST endpoints, powered by Netflix DGS
The Authorization Server (port 8082) issues multi-tenant OAuth2 JWT tokens
The openframe-client Rust agent communicates via NATS JetStream — never directly via HTTP
The Stream Service consumes Kafka events and writes to Cassandra and Apache Pinot

See the Architecture Overview for diagrams.

3. Run the Rust Agent Doctor

After building the openframe-client Rust agent, run the built-in diagnostics to verify your local environment:

cd clients/openframe-client
cargo build
./target/debug/openframe-client doctor

The doctor command runs environment health checks against the agent configuration and reports any missing dependencies or configuration issues.

4. Explore the openframe-chat Desktop App

The openframe-chat Tauri application is the end-client AI interface (Fae). To run it in development mode:

cd clients/openframe-chat
npm install
npm run tauri dev

Key areas to explore in the codebase:

Path	Purpose
`src/App.tsx`	Root React component — provider tree setup
`src/views/ChatView.tsx`	Main chat interface
`src/hooks/`	React Query hooks for API interactions
`src/services/`	GraphQL and REST API service clients
`src-tauri/src/nats_bridge/`	Rust NATS bridge for streaming AI responses
`src-tauri/src/token_decryption_service.rs`	AES-256-GCM token decryption

5. Review the Configuration Scripts

The repository includes initialization scripts for development infrastructure:

Script	Purpose
`clients/openframe-client/scripts/setup_dev_init_config.sh`	Sets up development initialization config for the Rust agent
`manifests/datasources/mongodb/scripts/readiness-command.sh`	MongoDB readiness probe
`manifests/datasources/mongodb-meshcentral/scripts/meshcentral-mongodb-init.sh`	Initializes MongoDB for MeshCentral integration

To set up the Rust agent for local development:

cd clients/openframe-client
bash scripts/setup_dev_init_config.sh

Common Initial Configuration

Spring Boot Services

Each Spring Boot service reads configuration from src/main/resources/application.yml. Key properties to configure for local development:

spring:
  data:
    mongodb:
      uri: mongodb://localhost:27017/openframe
  kafka:
    bootstrap-servers: localhost:9092

# Service-specific NATS configuration (Client Service)
nats:
  url: nats://localhost:4222

Rust Agent (openframe-client)

The Rust agent reads its configuration from a platform-specific directory. For local development, set OPENFRAME_DEV_MODE=1 to use a user-local config directory:

export OPENFRAME_DEV_MODE=1

The agent can be installed as a system service (requires admin/root):

sudo ./target/release/openframe-client install \
  --serverUrl https://your-openframe-instance.example.com \
  --initialKey YOUR_INITIAL_KEY \
  --orgId YOUR_ORG_ID

Note: Replace the server URL, initial key, and org ID values with those from your running OpenFrame instance. Refer to your environment configuration for these values.

Where to Get Help

OpenFrame OSS Tenant is community-supported through the OpenMSP Slack workspace. This is the primary place for questions, feature requests, and announcements.

Join OpenMSP Slack: https://www.openmsp.ai/
Direct invite: Join Slack
OpenFrame Website: https://openframe.ai
Flamingo Platform: https://flamingo.run

Exploring Key Features

Once running, key features to explore:

Feature	How to Access
GraphQL API	API Service at port 8080 — use a GraphQL client like GraphiQL or Insomnia
AI Chat (Fae)	Run `openframe-chat` via `npm run tauri dev`
Agent Registration	Use `openframe-client install` with a valid initial key
OAuth2 Login	Authorization Server at port 8082 handles tenant-scoped login
Multi-Tenant Isolation	All API queries are automatically scoped by JWT `tenant_id` claim
Script Execution (RMM)	GraphQL mutations on the API Service dispatch scripts via NATS

Frequently Asked Questions

About OpenFrame

What's included in OpenFrame? Does it integrate with my existing tools?

OpenFrame isn't built to plug into your stack. It replaces it. Instead of duct-taping a dozen tools together (RMM, MDM, SIEM, patching, remote access, each its own login and bill), we bundle it into one unified platform: RMM, MDM, monitoring, automation, remote access, patch management, security monitoring, and ticketing, plus built-in AI copilots. So "does it integrate with X?" usually means: you won't need X anymore.

How is OpenFrame different from other vendors?

Most platforms give you one piece and expect you to bolt the rest on. OpenFrame unifies the whole stack in one place, with AI copilots built in. Fewer logins, fewer bills, less duct tape.

Where is my data hosted?

In the cloud, on US soil. Your data stays stateside.

Is OpenFrame for MSPs or MSSPs?

Both. It's built for MSPs and MSSPs alike.

MSP AI Agents

Can AI Agents Really Close Tickets Without a Technician?

Yes. In production MSP shops today, 10% to 25% of tickets close before a human opens them. Thread alone has processed 173 million tickets across 750-plus MSP partners at 96% triage accuracy, handing back 490,000-plus technician hours. Agents own the low-risk, high-volume work (password resets, MFA enrollment, known installs, onboarding and offboarding) and flag anything that touches production data or needs judgment for a human to take.

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.

First Steps

After cloning and building OpenFrame OSS Tenant, here are the first 5 things to do to understand and work with the platform.

1. Understand the Project Structure

OpenFrame OSS Tenant is a polyglot monorepo. Familiarize yourself with the key directories:

openframe-oss-tenant/
├── openframe/services/          # Java/Spring Boot microservices
│   ├── openframe-api/           # GraphQL + REST API (port 8080)
│   ├── openframe-gateway/       # Spring Cloud Gateway (port 8081)
│   ├── openframe-authorization-server/  # OAuth2/OIDC (port 8082)
│   ├── openframe-external-api/  # Public REST API (port 8083)
│   ├── openframe-client/        # Agent lifecycle service (port 8084)
│   ├── openframe-stream/        # Kafka Streams (port 8085)
│   └── openframe-management/    # Platform management service
├── clients/
│   ├── openframe-client/        # Rust endpoint agent
│   └── openframe-chat/          # Tauri + React desktop app (Fae)
├── manifests/                   # Kubernetes manifests for infrastructure
└── pom.xml                      # Root Maven POM

Each Spring Boot service has its own src/main/resources/application.yml for configuration.

2. Explore the Reference Architecture

The platform architecture documentation describes how all components interconnect. Read it to understand the request lifecycle:

All client traffic flows through the Gateway Service (port 8081)
The API Service (port 8080) handles GraphQL queries and REST endpoints, powered by Netflix DGS
The Authorization Server (port 8082) issues multi-tenant OAuth2 JWT tokens
The openframe-client Rust agent communicates via NATS JetStream — never directly via HTTP
The Stream Service consumes Kafka events and writes to Cassandra and Apache Pinot

See the Architecture Overview for diagrams.

3. Run the Rust Agent Doctor

After building the openframe-client Rust agent, run the built-in diagnostics to verify your local environment:

cd clients/openframe-client
cargo build
./target/debug/openframe-client doctor

The doctor command runs environment health checks against the agent configuration and reports any missing dependencies or configuration issues.

4. Explore the openframe-chat Desktop App

The openframe-chat Tauri application is the end-client AI interface (Fae). To run it in development mode:

cd clients/openframe-chat
npm install
npm run tauri dev

Key areas to explore in the codebase:

Path	Purpose
`src/App.tsx`	Root React component — provider tree setup
`src/views/ChatView.tsx`	Main chat interface
`src/hooks/`	React Query hooks for API interactions
`src/services/`	GraphQL and REST API service clients
`src-tauri/src/nats_bridge/`	Rust NATS bridge for streaming AI responses
`src-tauri/src/token_decryption_service.rs`	AES-256-GCM token decryption

5. Review the Configuration Scripts

The repository includes initialization scripts for development infrastructure:

Script	Purpose
`clients/openframe-client/scripts/setup_dev_init_config.sh`	Sets up development initialization config for the Rust agent
`manifests/datasources/mongodb/scripts/readiness-command.sh`	MongoDB readiness probe
`manifests/datasources/mongodb-meshcentral/scripts/meshcentral-mongodb-init.sh`	Initializes MongoDB for MeshCentral integration

To set up the Rust agent for local development:

cd clients/openframe-client
bash scripts/setup_dev_init_config.sh

Common Initial Configuration

Spring Boot Services

Each Spring Boot service reads configuration from src/main/resources/application.yml. Key properties to configure for local development:

spring:
  data:
    mongodb:
      uri: mongodb://localhost:27017/openframe
  kafka:
    bootstrap-servers: localhost:9092

# Service-specific NATS configuration (Client Service)
nats:
  url: nats://localhost:4222

Rust Agent (openframe-client)

The Rust agent reads its configuration from a platform-specific directory. For local development, set OPENFRAME_DEV_MODE=1 to use a user-local config directory:

export OPENFRAME_DEV_MODE=1

The agent can be installed as a system service (requires admin/root):

sudo ./target/release/openframe-client install \
  --serverUrl https://your-openframe-instance.example.com \
  --initialKey YOUR_INITIAL_KEY \
  --orgId YOUR_ORG_ID

Note: Replace the server URL, initial key, and org ID values with those from your running OpenFrame instance. Refer to your environment configuration for these values.

Where to Get Help

OpenFrame OSS Tenant is community-supported through the OpenMSP Slack workspace. This is the primary place for questions, feature requests, and announcements.

Join OpenMSP Slack: https://www.openmsp.ai/
Direct invite: Join Slack
OpenFrame Website: https://openframe.ai
Flamingo Platform: https://flamingo.run

Exploring Key Features

Once running, key features to explore:

Feature	How to Access
GraphQL API	API Service at port 8080 — use a GraphQL client like GraphiQL or Insomnia
AI Chat (Fae)	Run `openframe-chat` via `npm run tauri dev`
Agent Registration	Use `openframe-client install` with a valid initial key
OAuth2 Login	Authorization Server at port 8082 handles tenant-scoped login
Multi-Tenant Isolation	All API queries are automatically scoped by JWT `tenant_id` claim
Script Execution (RMM)	GraphQL mutations on the API Service dispatch scripts via NATS

Knowledge Hub

First Steps

1. Understand the Project Structure

2. Explore the Reference Architecture

3. Run the Rust Agent Doctor

4. Explore the openframe-chat Desktop App

5. Review the Configuration Scripts

Common Initial Configuration

Spring Boot Services

Rust Agent (openframe-client)

Where to Get Help

Exploring Key Features

Frequently Asked Questions

About OpenFrame

What's included in OpenFrame? Does it integrate with my existing tools?

How is OpenFrame different from other vendors?

Where is my data hosted?

Is OpenFrame for MSPs or MSSPs?

MSP AI Agents

Can AI Agents Really Close Tickets Without a Technician?

How Much Can AI Agents Save an MSP?

First Steps

1. Understand the Project Structure

2. Explore the Reference Architecture

3. Run the Rust Agent Doctor

4. Explore the openframe-chat Desktop App

5. Review the Configuration Scripts

Common Initial Configuration

Spring Boot Services

Rust Agent (openframe-client)

Where to Get Help

Exploring Key Features

Ready to Break Free?