安装

Docker Compose（最快设置）

要求： Docker Desktop

这是启动 ByteChef 的最快方式。从仓库下载 docker-compose.yml 文件：

curl -O https://raw.githubusercontent.com/bytechefhq/bytechef/master/docker-compose.yml
docker compose -f docker-compose.yml up

PostgreSQL 数据库和 ByteChef 容器都会自动启动。

Docker（手动设置）

如果您的环境不支持 Docker Compose，请按照以下步骤操作：

1. 创建 Docker 网络

docker network create -d bridge bytechef_network

2. 启动 PostgreSQL 容器

docker run --name postgres -d -p 5432:5432 \
    --env POSTGRES_USER=postgres \
    --env POSTGRES_PASSWORD=postgres \
    --hostname postgres \
    --network bytechef_network \
    -v /opt/postgre/data:/var/lib/postgresql/data \
    postgres:15-alpine

3. 启动 ByteChef 容器

docker run --name bytechef -it -p 8080:8080 \
    --env BYTECHEF_DATASOURCE_URL=jdbc:postgresql://postgres:5432/bytechef \
    --env BYTECHEF_DATASOURCE_USERNAME=postgres \
    --env BYTECHEF_DATASOURCE_PASSWORD=postgres \
    --env BYTECHEF_SECURITY_REMEMBER_ME_KEY=e48612ba1fd46fa7089fe9f5085d8d164b53ffb2 \
    --network bytechef_network \
    docker.bytechef.io/bytechef/bytechef:latest

注意： 使用 -d 标志代替 -it 可以在分离模式下运行。

特性

• 可视化工作流编辑器：通过拖放组件构建和可视化工作流
• 事件驱动与定时工作流：通过简单的触发器定义实现实时事件驱动的工作流自动化
• 多种流程控制：使用条件、开关、循环、遍历、并行等
• 内置代码编辑器：用 JSON 编写工作流定义，并可在 Java、JavaScript、Python 和 Ruby 中编写代码块
• 200 多个内置组件：从任何数据库、SaaS 应用程序、内部 API 或云存储中提取数据
• 可扩展：用 Java、JavaScript、Python 或 Ruby 开发自定义连接器
• AI 就绪：内置 AI 组件，可运行多种 AI 模型和算法
• 开发者友好：将工作流暴露为 API；平台会处理身份验证
• 版本控制友好：可直接从 ByteChef UI 将工作流推送到 Git
• 自托管：可在本地安装，完全掌控执行和数据

---

使用 ByteChef 自托管实例入门

1. 使用 Docker Compose 启动 ByteChef：

   curl -O https://raw.githubusercontent.com/bytechefhq/bytechef/master/docker-compose.yml
   docker compose -f docker-compose.yml up
   

2. 打开 http://localhost:8080/login

3. 单击 创建账户 设置您的用户

4. 使用您的凭据登录

什么是 ByteChef？

ByteChef 是一个 开源、低代码、可扩展 的 API 集成和工作流自动化平台，可帮助您：

作为自动化解决方案：集成并构建跨 SaaS 应用程序、内部 API 和数据库的自动化工作流。

作为嵌入式解决方案：直接将集成构建到您的 SaaS 产品中，让您的客户能够将其使用的应用程序与您的产品连接起来。

创建您的第一个工作流

使用 UI 编辑器

1. 导航到 项目 部分
2. 单击 新建项目
3. 填写必要的凭据
4. 在项目中创建一个新的工作流
5. 添加触发器和您想要使用的组件
6. 连接它们以定义您的工作流逻辑
7. 在属性面板中配置每个组件的参数
8. 测试您的工作流
9. 部署

贡献

ByteChef 是根据 Apache 许可证 v2.0 开源发布的。如果您想为该软件做出贡献，请阅读 贡献指南，开始参与。

路线图

查看我们的 公开路线图，了解我们接下来的工作内容。

---

许可证

ByteChef 根据 Apache 许可证 v2.0 发布。

版权所有 2025 ByteChef

根据 Apache 许可证第 2.0 版（“许可证”）授权；
除非符合许可证规定，否则不得使用此文件。

---

贡献者

---

致谢

ByteChef 最初是基于 Piper 分支开发的，Piper 是一个开源的分布式工作流引擎。

ByteChef 快速上手指南

ByteChef 是一款开源、低代码、可扩展的 API 集成与工作流自动化平台。支持可视化编排、事件驱动触发、多语言代码扩展（Java/JS/Python/Ruby）以及内置 AI 组件，适合构建自动化流程或作为嵌入式集成解决方案。

环境准备

在开始之前，请确保您的开发环境满足以下要求：

• 操作系统：Linux, macOS 或 Windows
• 核心依赖：Docker Desktop (推荐) 或 Docker Engine + Docker Compose
• 网络要求：能够访问 Docker Hub 或配置了国内镜像加速器的 Docker 环境
  • 提示：国内用户建议配置 Docker 镜像加速器（如阿里云、腾讯云等）以提升拉取速度。

安装步骤

推荐使用 Docker Compose 方式进行一键部署，这是最快捷的安装方式。它会自动启动 PostgreSQL 数据库和 ByteChef 应用容器。

1. 下载配置文件

在终端中执行以下命令，从官方仓库下载 docker-compose.yml 文件：

curl -O https://raw.githubusercontent.com/bytechefhq/bytechef/master/docker-compose.yml

2. 启动服务

运行以下命令启动所有容器：

docker compose -f docker-compose.yml up

注意：首次运行时，Docker 会自动拉取 postgres:15-alpine 和 bytechef/bytechef:latest 镜像。启动完成后，您将看到日志输出，表示服务正在运行。

(可选) 若需后台运行，请使用 docker compose -f docker-compose.yml up -d

基本使用

安装完成后，按照以下步骤创建并运行您的第一个工作流。

1. 访问平台

打开浏览器，访问本地地址： http://localhost:8080/login

2. 创建账户

点击页面上的 Create Account 按钮，填写相关信息以初始化管理员账户，随后使用凭据登录。

3. 创建第一个工作流

登录后，通过可视化编辑器构建自动化流程：

1. 进入左侧导航栏的 Projects 部分。
2. 点击 New Project 创建新项目，填写必要的项目信息。
3. 在项目内部，点击创建新的 Workflow。
4. 添加触发器 (Trigger)：从组件库中选择触发方式（如定时任务、Webhook 接收等）。
5. 添加动作组件：拖拽所需的组件（如数据库查询、HTTP 请求、AI 模型调用等）到画布。
6. 连接逻辑：将触发器与动作组件连线，定义执行顺序；利用条件判断、循环等控制流组件完善逻辑。
7. 配置参数：选中每个组件，在右侧属性面板配置具体参数（如 API Key、SQL 语句、Prompt 等）。
8. 测试运行：点击测试按钮验证工作流逻辑是否符合预期。
9. 部署：确认无误后，点击部署使工作流正式生效。

现在，您已经成功使用 ByteChef 构建了第一个自动化工作流。您可以继续探索其 200+ 内置组件或通过代码块编写自定义逻辑。