Skip to Content
OpenFactory Documentation

OpenFactory Documentation

OpenFactory provides browser-based Linux evaluation, custom image recipes and builds, artifact inspection, VM testing, and related deployment workflows. The exact features available to an account or self-hosted console depend on the deployed release, plan, feature flags, and connected infrastructure.

Start with a Task

GoalDocumentation path
Create and verify a custom imageYour First Build
Understand normalized recipe JSONRecipe Schema
Configure build featuresBuilding operating systems
Boot and inspect a VMVM Management
Define post-build evidenceTesting
Connect an MCP clientMCP Integration
Evaluate the local KVM consoleSelf-Hosted VM Console
Understand collaboration scopeRoles and Permission Scope

Evidence Model

OpenFactory exposes several states that should not be collapsed into one “success” label:

  1. Recipe validation checks the recognized configuration shape and explicit request coverage.
  2. Build completion means an image artifact reached its finalization path.
  3. Test completion records the outcome of selected guest assertions.
  4. Certification or policy status, where present, applies only to the named evidence contract.
  5. Physical or production qualification remains a separate activity unless the exact hardware, topology, failure modes, and release were tested.

Use the narrowest supported claim. A package in a recipe is not proof it was installed; an installed package is not proof its service is healthy; a VM boot is not proof an installer or physical device works.

Hosted and Self-Hosted Boundaries

The hosted service contains the image-building and conversation workflows. The checked-in self-hosted Compose deployment is a privileged, single-host KVM console for evaluation. It disables hosted builds, conversations, scheduling, and policy-document workflows and does not by itself establish production or air-gapped operation.

For private production deployment, use release-specific architecture, identity, persistence, backup, upgrade, and support documentation agreed with OpenFactory. Do not substitute a marketing capability list or the evaluation Compose file for that runbook.

How to Read These Docs

  • Commands state their working context and expected result where practical.
  • Security, compliance, availability, and compatibility claims include their evidence boundary.
  • If the UI and a static page disagree, preserve the build or run ID and check the current API/state before repeating a destructive action.
  • Report stale documentation with the page URL, product release or commit, timestamp, and observed result.

Continue with Getting Started.