MeshFlows Documentation

MeshFlows is a workflow orchestration and integration platform built for Kubernetes and local development.

Start Here

Platform Operator Path

1. Engine Overview
2. Prerequisites
3. Kubernetes Deployment
4. Operations

Workflow Developer Path

1. Flows Overview
2. First Workflow
3. Connections
4. Deployment

Troubleshooting Path

1. Observability
2. Orchestrator API
3. Error Handling

Components

Engine

Backend services for execution, APIs, data transformation, storage, scheduling, and security.

• Engine Overview
• Engine Technical Reference

Flows

Workflow artifacts and runtime configuration.

• Flows Overview
• Flows Technical Reference

Quick Actions

Run Locally

cd engine
docker-compose up -d

Validate Workflow Runtime Health

curl http://localhost:8080/v1/status
curl http://localhost:8083/readyz

Execute a Workflow

curl -X POST http://localhost:8080/v1/run/demo \
    -H "Content-Type: application/json" \
    -d '{"xml":"<root/>"}'

Documentation Map

• Engine How-to: deployment, secrets, and operations.
• Engine Reference: architecture, APIs, observability, security.
• Flows How-to: authoring, scheduling, deployment, testing.
• Flows Reference: YAML schema, step types, context, policies.

Support

• Issues: Forgejo Issues
• Contributions: documentation and workflow examples are welcome.

Last updated: April 2026