Introduction to Envoy

Envoy is an on-prem deployable ETL framework built with Bun and TypeScript. It executes YAML-defined tasks as Node.js Stream pipelines and orchestrates them through a web UI, a REST API, and a CLI. Tasks declare typed connector slots instead of credentials, so the same YAML runs unchanged across environments — only the connector configurations differ.

Choose your track

The documentation serves two readers. Pick the track that matches your work:

• Operators use the web UI to create Jobs from Job Templates, run and monitor them, and manage Connectors. Start with Quickstart: run your first job and continue with the Home dashboard.
• Implementers author task and job template YAML, write JSONata, and work with the CLI and API. Start with Quickstart: build your first task and continue with Task anatomy and authoring workflow.

The three-layer model

Envoy separates portable pipeline logic from deployment-specific configuration across three layers. A Task is one YAML pipeline with typed connector slots and no credentials. A Job Template composes tasks into a DAG and wires each task's slots to template-level connector names through connector_mapping. A Job instantiates a template by binding real, stored Connectors to those names; each execution of a Job is a Job Run. Read Tasks, jobs, and templates for the full model.

How the documentation is organized

• Getting Started — install Envoy, complete first-time setup, and follow one of three quickstarts (operator, implementer, CLI).
• Using Envoy — operator guides for every screen of the web UI, from Jobs and Job Runs to Data Explorer and Dashboards.
• Building Pipelines — implementer guides for authoring tasks, job templates, JSONata, and migrations.
• Task, Job & Dashboard, Connector, CLI, and API references — exhaustive YAML schemas, step types, connector methods, CLI flags, and REST endpoints.
• Deployment, Security, Operations, and Troubleshooting — running Envoy in production: Docker and Azure topologies, server configuration, hardening, observability, and common errors.

Installation is not covered here — see Installation.

Related

• Architecture — the control plane, executor, and streaming runtime
• Tasks, jobs, and templates — the three-layer model in depth
• Glossary — every product term in one table