Documentation Scope
Mach5 One is an edition of Mach5 packaged as a single-node server. Many features available through Mach5 One are common Mach5 features, not Mach5 One-only features.
Use the docs by scope:
| Scope | What it covers |
|---|---|
| Common Mach5 docs | Product concepts and APIs shared by Mach5 One and Mach5 Enterprise |
| Mach5 One docs | Installing, configuring, starting, connecting to, and troubleshooting the single-node server |
| Mach5 Enterprise docs | Multi-node deployment, scale, operations, high availability, governance, and enterprise security |
Common Mach5 features
These concepts and APIs are shared across Mach5 editions:
- Namespaces
- Indexes
- Warehouses
- Stores
- Connections
- Pipelines
- Data Explorer
- SQL and query workflows
- OpenAPI-described HTTP APIs under
/apis - MCP workflows
- Apps and packaged workflows, when compatible
Use common Mach5 documentation for feature-level usage.
Mach5 One-specific docs
The Mach5 One docs describe the single-node runtime experience:
- Installing the
mach5-onebinary - Creating local config with
mach5-one init - Starting the server with
mach5-one start - Configuring local ports, data directory, UI assets, logging, and local secrets
- Connecting to the local HTTP API, Data Explorer, MCP endpoint, and PostgreSQL-compatible endpoint
- Troubleshooting local runtime issues
- Filing runtime-specific issues
Enterprise-specific docs
Enterprise docs cover topics outside the Mach5 One runtime scope:
- Multi-node deployment
- Production operations
- High availability
- Scaling ingest and query workloads
- Enterprise authentication and authorization
- Governance and compliance controls
- Managed or supported production environments
How to read Mach5 One docs
When a Mach5 One page mentions indexes, warehouses, pipelines, Data Explorer, MCP, or query workflows, it is describing how to reach those Mach5 features through the local Mach5 One server.
For feature semantics themselves, use common Mach5 documentation.