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

Knowledge Hub

Comprehensive guides and references for the OpenFrame platform

Prerequisites

Before working with OpenFrame OSS Tenant, ensure your development environment meets the following requirements.

Required Software

Backend (Java / Maven)

Tool	Minimum Version	Notes
JDK (Java Development Kit)	21	OpenJDK 21 recommended (matches `<java.version>21</java.version>` in pom.xml)
Apache Maven	3.9+	Used for building all Spring Boot services

Frontend / Desktop Client

Tool	Minimum Version	Notes
Node.js	20 LTS	Required for the `openframe-chat` React app
npm	9+	Comes bundled with Node.js
Rust	1.78+ (stable)	Required for `openframe-client` (Rust agent) and `openframe-chat` (Tauri backend)
Tauri CLI	2.x	Bundled via `@tauri-apps/cli` devDependency in `openframe-chat`

Infrastructure / Data Services

Service	Notes
MongoDB	Primary transactional datastore for all services
Apache Kafka	Event streaming for the Stream Service
NATS / JetStream	Agent-to-platform messaging (used by openframe-client and Client Service)
Redis	Session cache and rate limiting
Apache Cassandra	Time-series log and command result storage
Apache Pinot	Real-time analytics queries

Note: For local development, the manifests directory contains Kubernetes manifests and initialization scripts for these data services. See the Local Development guide for environment setup details.

System Requirements

Requirement	Minimum	Recommended
CPU	4 cores	8+ cores
RAM	8 GB	16+ GB
Disk	20 GB free	40+ GB SSD
OS	Linux / macOS / Windows 10+	Linux (Ubuntu 22.04) or macOS 14+

Running all services locally is resource-intensive. For development, it is common to run infrastructure services (Kafka, MongoDB, NATS, Redis, Cassandra, Pinot) via container orchestration and only run the specific Spring Boot service you are working on locally.

Rust Toolchain Setup

The openframe-client (Rust agent) and openframe-chat (Tauri) require a working Rust toolchain.

# Install rustup (Rust toolchain installer)
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

# Install the stable toolchain
rustup toolchain install stable
rustup default stable

# Verify
rustc --version
cargo --version

For cross-compilation targets (building the agent for other platforms):

# macOS ARM → macOS Intel
rustup target add x86_64-apple-darwin

# Linux x86_64
rustup target add x86_64-unknown-linux-gnu

# Windows x86_64
rustup target add x86_64-pc-windows-msvc

Tauri Prerequisites (openframe-chat)

Tauri requires native system libraries for the WebView. Follow the official Tauri prerequisites guide for your OS.

Linux (Ubuntu/Debian)

sudo apt-get update
sudo apt-get install -y \
  libwebkit2gtk-4.1-dev \
  build-essential \
  curl \
  wget \
  file \
  libxdo-dev \
  libssl-dev \
  libayatana-appindicator3-dev \
  librsvg2-dev

macOS

xcode-select --install

Windows

Install the Microsoft Visual C++ Build Tools and WebView2.

Account and Access Requirements

Requirement	Details
GitHub Account	To clone the repository and access releases
OpenMSP Community (Slack)	For support, announcements, and discussion — join here

Key Environment Variables

The following environment variables are commonly used across the platform. Specific values depend on your deployment configuration.

Variable	Used By	Purpose
`OPENFRAME_DEV_MODE`	openframe-client	Set to `1` to use user-local directories and disable TLS cert verification for local dev
`SPRING_DATA_MONGODB_URI`	All Spring Boot services	MongoDB connection string
`SPRING_KAFKA_BOOTSTRAP_SERVERS`	API, Stream services	Kafka broker addresses
`SPRING_DATA_REDIS_HOST`	Gateway, Management	Redis host
`NATS_URL`	Client Service	NATS server connection URL

Refer to each service's application.yml for the full list of supported properties.

Verification Commands

Run these to confirm your environment is ready:

# Java
java -version
# Expected: openjdk version "21.x.x"

# Maven
mvn -version
# Expected: Apache Maven 3.x.x

# Node.js
node -version
# Expected: v20.x.x or higher

# Rust
rustc --version
# Expected: rustc 1.78.x (stable)

# Cargo
cargo --version
# Expected: cargo 1.78.x

# Tauri CLI (install first if missing)
npx @tauri-apps/cli --version
# Expected: tauri-cli x.x.x

Next Steps

Once your environment is ready, continue with:

Quick Start — Clone the repository and run your first build
First Steps — Configure and explore the platform after setup

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.

Prerequisites

Before working with OpenFrame OSS Tenant, ensure your development environment meets the following requirements.

Required Software

Backend (Java / Maven)

Tool	Minimum Version	Notes
JDK (Java Development Kit)	21	OpenJDK 21 recommended (matches `<java.version>21</java.version>` in pom.xml)
Apache Maven	3.9+	Used for building all Spring Boot services

Frontend / Desktop Client

Tool	Minimum Version	Notes
Node.js	20 LTS	Required for the `openframe-chat` React app
npm	9+	Comes bundled with Node.js
Rust	1.78+ (stable)	Required for `openframe-client` (Rust agent) and `openframe-chat` (Tauri backend)
Tauri CLI	2.x	Bundled via `@tauri-apps/cli` devDependency in `openframe-chat`

Infrastructure / Data Services

Service	Notes
MongoDB	Primary transactional datastore for all services
Apache Kafka	Event streaming for the Stream Service
NATS / JetStream	Agent-to-platform messaging (used by openframe-client and Client Service)
Redis	Session cache and rate limiting
Apache Cassandra	Time-series log and command result storage
Apache Pinot	Real-time analytics queries

Note: For local development, the manifests directory contains Kubernetes manifests and initialization scripts for these data services. See the Local Development guide for environment setup details.

System Requirements

Requirement	Minimum	Recommended
CPU	4 cores	8+ cores
RAM	8 GB	16+ GB
Disk	20 GB free	40+ GB SSD
OS	Linux / macOS / Windows 10+	Linux (Ubuntu 22.04) or macOS 14+

Running all services locally is resource-intensive. For development, it is common to run infrastructure services (Kafka, MongoDB, NATS, Redis, Cassandra, Pinot) via container orchestration and only run the specific Spring Boot service you are working on locally.

Rust Toolchain Setup

The openframe-client (Rust agent) and openframe-chat (Tauri) require a working Rust toolchain.

# Install rustup (Rust toolchain installer)
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

# Install the stable toolchain
rustup toolchain install stable
rustup default stable

# Verify
rustc --version
cargo --version

For cross-compilation targets (building the agent for other platforms):

# macOS ARM → macOS Intel
rustup target add x86_64-apple-darwin

# Linux x86_64
rustup target add x86_64-unknown-linux-gnu

# Windows x86_64
rustup target add x86_64-pc-windows-msvc

Tauri Prerequisites (openframe-chat)

Tauri requires native system libraries for the WebView. Follow the official Tauri prerequisites guide for your OS.

Linux (Ubuntu/Debian)

sudo apt-get update
sudo apt-get install -y \
  libwebkit2gtk-4.1-dev \
  build-essential \
  curl \
  wget \
  file \
  libxdo-dev \
  libssl-dev \
  libayatana-appindicator3-dev \
  librsvg2-dev

macOS

xcode-select --install

Windows

Install the Microsoft Visual C++ Build Tools and WebView2.

Account and Access Requirements

Requirement	Details
GitHub Account	To clone the repository and access releases
OpenMSP Community (Slack)	For support, announcements, and discussion — join here

Key Environment Variables

The following environment variables are commonly used across the platform. Specific values depend on your deployment configuration.

Variable	Used By	Purpose
`OPENFRAME_DEV_MODE`	openframe-client	Set to `1` to use user-local directories and disable TLS cert verification for local dev
`SPRING_DATA_MONGODB_URI`	All Spring Boot services	MongoDB connection string
`SPRING_KAFKA_BOOTSTRAP_SERVERS`	API, Stream services	Kafka broker addresses
`SPRING_DATA_REDIS_HOST`	Gateway, Management	Redis host
`NATS_URL`	Client Service	NATS server connection URL

Refer to each service's application.yml for the full list of supported properties.

Verification Commands

Run these to confirm your environment is ready:

# Java
java -version
# Expected: openjdk version "21.x.x"

# Maven
mvn -version
# Expected: Apache Maven 3.x.x

# Node.js
node -version
# Expected: v20.x.x or higher

# Rust
rustc --version
# Expected: rustc 1.78.x (stable)

# Cargo
cargo --version
# Expected: cargo 1.78.x

# Tauri CLI (install first if missing)
npx @tauri-apps/cli --version
# Expected: tauri-cli x.x.x

Next Steps

Once your environment is ready, continue with:

Quick Start — Clone the repository and run your first build
First Steps — Configure and explore the platform after setup

Knowledge Hub

Prerequisites

Required Software

Backend (Java / Maven)

Frontend / Desktop Client

Infrastructure / Data Services

System Requirements

Rust Toolchain Setup

Tauri Prerequisites (openframe-chat)

Linux (Ubuntu/Debian)

macOS

Windows

Account and Access Requirements

Key Environment Variables

Verification Commands

Next Steps

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?

Prerequisites

Required Software

Backend (Java / Maven)

Frontend / Desktop Client

Infrastructure / Data Services

System Requirements

Rust Toolchain Setup

Tauri Prerequisites (openframe-chat)

Linux (Ubuntu/Debian)

macOS

Windows

Account and Access Requirements

Key Environment Variables

Verification Commands

Next Steps

Ready to Break Free?