Introduction

Getting Started with Flow

Flow is a distributed workflow engine. It is comprised of three major components: the Flow server, workflows, and processors. The Flow server is responsible for managing workflows and their input and output as well as orchestrating the processors. A workflow is a unit of work to be processed. Workflows can be anything ranging from task automation such as a notification or billing service to a content generation pipeline and can have inputs such as a file archive or another workflow's output. To facilitate workflow customization they also support user provided parameters. Processors then receive the workflow definition along with any input and process the workflow. Workflow status, output, and artifacts are all managed by the Flow server.

To get a local instance up and running to check out see the Quick Start.

To learn more about the concepts and components of Flow, see Concepts.

Contributing

Flow is open source and licensed under the Apache 2.0 license. Anyone and everyone is welcome to participate and contribute to Flow and the related projects. To get started contributing, visit the project on GitHub.

Help

If you get stuck don't worry! We are here to help! Visit us on Discord for live help and discussion.