Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/content/docs/(getting-started)/architecture.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
---
title: Platform Architecture
description: ByteChef is an open-source, enterprise-ready platform for API integration and workflow automation.
description: "ByteChef Platform Architecture. Learn the infrastructure design and technical components of the ByteChef system in your ByteChef workflows."
---

ByteChef is built on a scalable, modular architecture designed to handle enterprise-grade workflow automation and integrations. The platform provides a flexible foundation that supports multiple deployment models, from cloud-hosted to on-premises deployments.

![Workflow Architecture](/Architecture_Diagram.png)
## System Architecture Overview

The ByteChef platform is composed of several interconnected layers that work together to deliver workflow automation capabilities.
Expand Down
4 changes: 2 additions & 2 deletions docs/content/docs/(getting-started)/glossary.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Glossary
description: Terms used in ByteChef platform.
description: "ByteChef glossary. Quick reference guide for automation terms, workflows, components, triggers, and integration concepts."
---

In this document, you will find a list of terms used in ByteChef's platform. Here are the definitions:
Expand All @@ -17,7 +17,7 @@ Workflows are a series of actions and triggers that automate processes within th

In ByteChef, a component is a modular building block that encapsulates specific functionalities within the platform. Each component is designed to interact with external services or perform particular tasks, making it an essential part of creating workflows.

Components are composed of two main elements: actions and triggers.
Components are composed of two main elements: **Actions** and **Triggers**.

By combining actions and triggers, components enable users to automate complex processes and integrate various services seamlessly. Components are designed to be reusable and extendable, allowing users to customize and expand their workflows according to their needs.

Expand Down
6 changes: 3 additions & 3 deletions docs/content/docs/(getting-started)/introduction.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Introduction
description: This is the documentation for ByteChef, an open-source workflow automation platform that connects your entire tech stack with AI-powered intelligence.
description: "This is the documentation for ByteChef, an open-source workflow automation platform that connects your entire tech stack with AI-powered intelligence."
icon: Album
---

Expand All @@ -21,7 +21,7 @@ This documentation covers everything from setup to usage and development. It's a
Bring the power of ByteChef directly into your product—embed the workflow builder, run automations behind the scenes, and let your users create workflows inside your app.
</Card>

<Card icon={<Blocks />} title='Developer Guide' href='/developer-guide'>
<Card icon={<Blocks />} title='Developer Guide' href='/developer-guide/build-component/initial-setup'>
Get started with building components/connectors, writing custom functions, and extending ByteChef. Everything you need to develop, test, and deploy powerful automations.
</Card>

Expand All @@ -48,4 +48,4 @@ Check out our [roadmap](https://github.com/orgs/bytechefhq/projects/3) to get in

### Contributing

If you'd like to contribute, kindly read our [Contributing Guide](https://github.com/bytechefhq/bytechef/blob/master/CONTRIBUTING.md) to learn and understand about our development process, how to propose bug fixes and improvements, and how to build and test your changes to ByteChef.
If you'd like to contribute, kindly read our [Contributing Guide](https://github.com/bytechefhq/bytechef/blob/master/CONTRIBUTING.md) to learn and understand about our development process, how to propose bug fixes and improvements, and how to build and test your changes to ByteChef.
2 changes: 1 addition & 1 deletion docs/content/docs/(getting-started)/quickstart.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Quick Start"
description: "This guide walks you through the basics of ByteChef in a few minutes. You'll learn how to build a workflow quickly, so no much configuration needed."
description: "Quick Start guide for ByteChef. Learn how to build your first workflow in minutes with Spotify and Slack integration examples."
---

In this tutorial, you'll learn:
Expand Down
1 change: 0 additions & 1 deletion docs/content/docs/(getting-started)/what-is-bytechef.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
title: "What is ByteChef?"
description: "ByteChef is an open-source, enterprise-ready platform for building AI agents, automating workflows, and integrating applications across SaaS, APIs, and databases with flexible deployment."
---

ByteChef is an open-source platform that is designed to help you build AI agents, automate workflows, and integrate applications across your entire tech stack. Whether you're connecting SaaS tools, APIs, or databases, ByteChef provides a flexible, scalable solution for workflow automation.

## Core Capabilities
Expand Down
16 changes: 12 additions & 4 deletions docs/content/docs/automation/build/index.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,16 @@
---
title: "Overview"
description: "An introduction to building and managing projects and workflows in ByteChef."
description: "Building and managing projects and workflows in ByteChef. Organize and structure automation. Learn how to implement this in your ByteChef workflows."
title: Overview
---

In the following steps, we will learn how to build and manage projects and workflows within ByteChef. Projects and
workflows are essential components of automation, enabling you to organize tasks, streamline processes, and enhance
Learn how to build and manage your automation within ByteChef. Projects and workflows are important components of automation, enabling you to organize tasks, streamline processes, and enhance
operational efficiency.

In this section, you will learn everything you need to organize your work and create automated workflows.

## What's Covered
- **[Projects](/automation/build/projects)**: Organize your automation by creating and managing projects. In this guide, you'll learn how to create, edit, duplicate, publish, and delete projects. Apart from that, the guide also includes steps on how to create and import workflows.
- **[Workflows](/automation/build/worklfows)**: Build the automation sequences that do the work. Set up triggers, configure actions, and control how your workflows run.
- **[Universal AI](/automation/build/universal-ai)** - Add AI capabilities to your workflows using AI cimponennts like **AI Text** or **AI Image** for tasks like text generation and image processing.

If you want to understand the necessary terminologies for ByteChef, you can check out the [Glossary](/glossary) for definitions of key concepts.
6 changes: 3 additions & 3 deletions docs/content/docs/automation/build/projects.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Projects"
description: "Learn how to create, manage, and organize projects within ByteChef."
description: "Learn how to create, manage, and organize projects in ByteChef. Learn how to implement this in your ByteChef workflows."
title: Build Projects
---

Every project on ByteChef consists of one or more workflows. Projects help organize and manage workflows, making it
Expand Down Expand Up @@ -79,4 +79,4 @@ easier to group related automation processes together.

<div style={{ position: 'relative', height: 0, width: '100%', overflow: 'hidden', zIndex: 99999, boxSizing: 'border-box', paddingBottom: 'calc(53.02672956% + 32px)' }}>
<iframe src="https://www.guidejar.com/embed/a8FJf631lYiJfSEDeFSn?type=1&controls=on" width="100%" height="100%" style={{ height: '100%', position: 'absolute', inset: 0 }} allowFullScreen frameBorder="0"></iframe>
</div>
</div>
6 changes: 3 additions & 3 deletions docs/content/docs/automation/build/universal-ai.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Universal AI"
description: "Learn how to work with AI Text and AI Image"
description: "Integrate AI capabilities into ByteChef workflows. Use AI for text generation and image processing. Learn how to implement this in your ByteChef workflows."
title: Universal AI
---

This is a guide no using universal AI components like **AI Text** or **AI Image**.
Expand All @@ -22,4 +22,4 @@ After that, you should be able to work with **AI Text** and **AI Image** compone

<div style={{ position: 'relative', height: 0, width: '100%', overflow: 'hidden', zIndex: 99999, boxSizing: 'border-box', paddingBottom: 'calc(53.02672956% + 32px)' }}>
<iframe src="https://www.guidejar.com/embed/3f85c053-7e73-4fd6-b48a-86371a718381?type=1&controls=on" width="100%" height="100%" style={{ height: '100%', position: 'absolute', inset: 0 }} allowFullScreen frameBorder="0"></iframe>
</div>
</div>
6 changes: 3 additions & 3 deletions docs/content/docs/automation/build/workflows.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Workflows"
description: "Learn how to create, edit, and manage workflows effectively."
description: "Learn how to create, edit, and manage workflows in ByteChef. Learn how to implement this in your ByteChef workflows."
title: Workflows
---

## Create Workflow
Expand Down Expand Up @@ -198,4 +198,4 @@ This part of code will look like this:

<div style={{ position: 'relative', height: 0, width: '100%', overflow: 'hidden', zIndex: 99999, boxSizing: 'border-box', paddingBottom: 'calc(53.02672956% + 32px)' }}>
<iframe src="https://www.guidejar.com/embed/hYc7cWhjM3WmFAzwzQLs?type=1&controls=on" width="100%" height="100%" style={{ height: '100%', position: 'absolute', inset: 0 }} allowFullScreen frameBorder="0"></iframe>
</div>
</div>
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,6 @@
title: "API Key Authentication"
description: "Learn how to use API Keys to connect to third-party services in ByteChef"
---

# API Key Authentication

API Key authentication is a simple way to authenticate with many third-party services. An API key is a unique identifier used to authenticate a user, developer, or calling program to an API.

## How it Works
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,6 @@
title: "Basic Authentication"
description: "Learn how to use Basic Authentication to connect to third-party services in ByteChef"
---

# Basic Authentication

Basic Authentication is a simple authentication scheme built into the HTTP protocol. It uses a username and a password to authenticate requests.

## How it Works
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,6 @@
title: "Bearer Authentication"
description: "Learn how to use Bearer Tokens to connect to third-party services in ByteChef"
---

# Bearer Authentication

Bearer Authentication (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens. The name "Bearer authentication" can be understood as "give access to the bearer of this token."

## How it Works
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,6 @@
title: "OAuth 2.0 Authentication"
description: "Learn how to use OAuth 2.0 to connect to third-party services in ByteChef"
---

# OAuth 2.0 Authentication

OAuth 2.0 is the industry-standard protocol for authorization. It allows ByteChef to obtain limited access to user accounts on an HTTP service, such as Google, GitHub, or Salesforce, without requiring your password.

## How it Works
Expand Down
26 changes: 26 additions & 0 deletions docs/content/docs/automation/connect-data/how-to-guides/index.mdx
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

None of the links work

Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
description: "ByteChef How-To Guides. Step-by-step tutorials and best practices for automating workflows and integrations."
title: How-To Guides
---


Follow these step-by-step guides to connect to popular services in ByteChef.

## Popular Integrations

- [Connect to Google Workspace](/automation/connect-data/how-to-guides/google-workspace)
- [Connect to Microsoft 365](/automation/connect-data/how-to-guides/microsoft-365)
- [Connect to Salesforce](/automation/connect-data/how-to-guides/salesforce)
- [Connect to Slack](/automation/connect-data/how-to-guides/slack)
- [Connect to Dropbox](/automation/connect-data/how-to-guides/dropbox)

## Authentication Methods

Learn about different authentication methods:
- [OAuth 2.0 Authentication](/automation/connect-data/how-to-guides/oauth2-authentication)
- [API Key Authentication](/automation/connect-data/how-to-guides/api-key-authentication)
- [Basic Authentication](/automation/connect-data/how-to-guides/basic-authentication)

## Troubleshooting

Having issues with connections? Check out our [troubleshooting guide](/automation/connect-data/how-to-guides/troubleshooting).
11 changes: 11 additions & 0 deletions docs/content/docs/automation/connect-data/how-to-guides/meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"title": "How-To Guides",
"description": "Step-by-step guides for connecting to third-party services",
"pages": [
"index",
"google-workspace",
"microsoft-365",
"salesforce",
"slack"
]
}
4 changes: 3 additions & 1 deletion docs/content/docs/automation/connect-data/meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
"icon": "Link",
"pages": [
"overview",
"how-to-guides/index",
"authentication",
"troubleshooting"]
"troubleshooting"
]
}
4 changes: 3 additions & 1 deletion docs/content/docs/automation/connect-data/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
title: "Overview"
description: "Learn how to connect and manage third-party application connections in ByteChef."
description: "ByteChef Connect Data Overview. Learn how to integrate and manage data sources and connectivity in workflows."
---

ByteChef's Connect Data feature allows you to seamlessly integrate with hundreds of third-party applications and services. This section will guide you through managing these connections to power your automations.
## What are Connections?

Connections in ByteChef are secure links between your ByteChef account and external services. They store authentication details and configuration needed to interact with these services through your workflows.
Expand Down Expand Up @@ -48,3 +49,4 @@ Learn more about [Authentication Methods](/automation/connect-data/authenticatio
- [Authentication](/automation/connect-data/authentication) - Learn about different authentication methods.
- [Troubleshooting](/automation/connect-data/troubleshooting) - Fix common connection errors.
- [Connections Reference](/reference/components) - Detailed reference for all supported connections.

12 changes: 7 additions & 5 deletions docs/content/docs/automation/deploy/index.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
---
title: "Overview"
description: "An introduction to deploying projects and workflows in ByteChef."
description: "An introduction to deploying projects and workflows in ByteChef. Execute automations. Learn how to implement this in your ByteChef workflows."
title: Overview
---
In this section of the documentation, you will learn how to deploy your workflows in ByteChef, so they can run independently without any manual trigger; turning your projects into live and production-ready automation.

In the following steps, we will learn how to deploy projects and workflows within ByteChef. Deployment allows you to
activate your workflows and put your projects into action—enabling you to fully leverage the benefits of automation.
## What's Covered

By deploying, you ensure that your automated processes are live, efficient, and ready to deliver real value.
- **[Deploy Projects](/automation/deploy/projects)**: You will learn how to activate your projects and workflows for production use. We'll also have a deep dive on how to create deployments, manage versions, configure connections, and control workflow execution.

Once your workflows are deployed, you can monitor their performance and execution history in the **[Monitor](/automation/monitor)** section of this documentation.
6 changes: 3 additions & 3 deletions docs/content/docs/automation/deploy/projects.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Projects"
description: "Learn how to deploy projects and workflows in ByteChef."
description: "Learn how to deploy projects and workflows in ByteChef. Learn how to implement this in your ByteChef workflows."
title: Deploy Projects
---

Deploying a project in ByteChef brings your automation to life. Deployment allows workflows to run
Expand Down Expand Up @@ -87,4 +87,4 @@ We put static trigger to our workflow and deployed it for purpose of showing how

<div style={{ position: 'relative', height: 0, width: '100%', overflow: 'hidden', zIndex: 99999, boxSizing: 'border-box', paddingBottom: 'calc(53.02672956% + 32px)' }}>
<iframe src="https://www.guidejar.com/embed/dfd80b36-da00-4401-938a-65ec16903ebd?type=1&controls=on" width="100%" height="100%" style={{ height: '100%', position: 'absolute', inset: 0 }} allowFullScreen frameBorder="0"></iframe>
</div>
</div>
2 changes: 2 additions & 0 deletions docs/content/docs/automation/meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@
"overview",
"quick-start",
"---Connect Data---",
"connect-data/overview",
"connect-data/how-to-guides/index",
"...connect-data",
"---Build Workflows---",
"build/index",
Expand Down
11 changes: 7 additions & 4 deletions docs/content/docs/automation/monitor/index.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
---
title: "Overview"
description: "An introduction to monitoring projects and workflows in ByteChef."
description: "An introduction to monitoring projects and workflows in ByteChef. Learn how to implement this in your ByteChef workflows."
title: Overview
---

The Monitoring section lets you track workflow executions in real time. View detailed input and output data, inspect
In this section of the documentation, you will learn how to track workflow executions in real time. You'll also see how to view detailed input and output data, inspect
each component’s behavior, and filter executions using various criteria to quickly find what you need.

## What's Covered
- **[Projects](/automationn/monitor/projeects)** - View execution history for your deployed workflows. Learn how to filter executions, inspect input and output data, and diagnose failed workflows.

Use the [execution details](/automation/monitor/projects#execution-details---completed) to understand how your workflows are performing and identify any issues that need attention.
6 changes: 3 additions & 3 deletions docs/content/docs/automation/monitor/projects.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Projects"
description: "Learn how to monitor projects and workflows in ByteChef."
description: "Learn how to monitor projects and workflows in ByteChef. Learn how to implement this in your ByteChef workflows."
title: Projects
---

After a project is deployed and executed, its workflow activity appears here—allowing you to review how your automation
Expand Down Expand Up @@ -37,4 +37,4 @@ is performing and explore the details of each execution.

<div style={{ position: 'relative', height: 0, width: '100%', overflow: 'hidden', zIndex: 99999, boxSizing: 'border-box', paddingBottom: 'calc(53.02672956% + 32px)' }}>
<iframe src="https://www.guidejar.com/embed/59a3fe78-0bb5-4c1e-98c9-fcebb845651e?type=1&controls=on" width="100%" height="100%" style={{ height: '100%', position: 'absolute', inset: 0 }} allowFullScreen frameBorder="0"></iframe>
</div>
</div>
6 changes: 3 additions & 3 deletions docs/content/docs/automation/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Introduction
description: Learn the basics of ByteChef Automation and how to create your first workflow.
description: "Automation for ByteChef. Integrate and automate your workflows. Learn how to implement this feature in your automation workflows."
title: Overview
---

import {Callout} from "fumadocs-ui/components/callout";
Expand Down Expand Up @@ -51,4 +51,4 @@ Once you're comfortable with the basics, you can:
- Explore more advanced workflow features like conditional logic and loops
- Connect multiple components to create complex automation processes
- Integrate AI capabilities into your workflows
- Learn about error handling and debugging techniques
- Learn about error handling and debugging techniques
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
description: "Configure Workflow Trigger in ByteChef. Learn to create workflows with triggers, actions, and deploy automations."
title: Configure Workflow Trigger
description: Learn how to create and configure a workflow with a trigger in ByteChef.
---

In this guide, you will learn how to create a workflow in ByteChef and configure it with a trigger. We will walk you
Expand Down Expand Up @@ -160,4 +160,4 @@ component, publish the project, create a deployment, and monitor the workflow ex

<div style={{ position: 'relative', height: 0, width: '100%', overflow: 'hidden', zIndex: 99999, boxSizing: 'border-box', paddingBottom: 'calc(53.02672956% + 32px)' }}>
<iframe src="https://www.guidejar.com/embed/coPV2tDXMJmcpVHubS0J?type=1&controls=on" width="100%" height="100%" style={{ height: '100%', position: 'absolute', inset: 0 }} allowFullScreen frameBorder="0"></iframe>
</div>
</div>
Loading