以可视化方式构建 AI 助手

📚 目录

• ⚡ 快速入门
• 🐳 Docker
• 👨‍💻 开发者
• 🌱 环境变量
• 📖 文档
• 🌐 自托管
• ☁️ Flowise Cloud
• 🙋 支持
• 🙌 贡献
• 📄 许可证

⚡快速入门

下载并安装 NodeJS >= 18.15.0

1. 安装 Flowise

   npm install -g flowise
   

2. 启动 Flowise

   npx flowise start
   

3. 打开 http://localhost:3000

🐳 Docker

Docker Compose

1. 克隆 Flowise 项目
2. 进入项目根目录下的 docker 文件夹
3. 复制 .env.example 文件，粘贴到同一位置并重命名为 .env
4. docker compose up -d
5. 打开 http://localhost:3000
6. 可以通过 docker compose stop 停止容器

Docker 镜像

1. 在本地构建镜像：

   docker build --no-cache -t flowise .
   

2. 运行镜像：

   docker run -d --name flowise -p 3000:3000 flowise
   

3. 停止镜像：

   docker stop flowise
   

👨‍💻 开发者

Flowise 在一个单一的 monorepo 中包含 3 个不同的模块。

• server: 提供 API 逻辑的 Node.js 后端
• ui: React 前端
• components: 第三方节点集成
• api-documentation: 由 express 自动生成的 swagger-ui API 文档

前提条件

• 安装 PNPM

  npm i -g pnpm
  

设置

1. 克隆仓库：

   git clone https://github.com/FlowiseAI/Flowise.git
   

2. 进入仓库文件夹：

   cd Flowise
   

3. 安装所有模块的所有依赖项：

   pnpm install
   

4. 构建所有代码：

   pnpm build
   

   退出码 134（JavaScript 堆内存不足）

   如果在运行上述 `build` 脚本时遇到此错误，请尝试增加 Node.js 的堆大小并再次运行脚本：

   # macOS / Linux / Git Bash
   export NODE_OPTIONS="--max-old-space-size=4096"
   
   # Windows PowerShell
   $env:NODE_OPTIONS="--max-old-space-size=4096"
   
   # Windows CMD
   set NODE_OPTIONS=--max-old-space-size=4096
   

   然后再次运行：

   pnpm build
   

5. 启动应用：

   pnpm start
   

   现在您可以在 http://localhost:3000 访问该应用

6. 对于开发构建：

   • 在 packages/ui 中创建 .env 文件，并指定 VITE_PORT（参考 .env.example）

   • 在 packages/server 中创建 .env 文件，并指定 PORT（参考 .env.example）

   • 运行：

     pnpm dev
     

   任何代码更改都会自动重新加载位于 http://localhost:8080 的应用

🌱 环境变量

Flowise 支持不同的环境变量来配置您的实例。您可以在 packages/server 文件夹内的 .env 文件中指定以下变量。更多信息请参阅 这里

📖 文档

您可以在这里查看 Flowise 文档 https://docs.flowiseai.com/

🌐 自托管

将 Flowise 自托管部署到您现有的基础设施中，我们支持多种 部署方式

• AWS

• Azure

• Digital Ocean

• GCP

• 阿里云

• 其他

  • Railway

    

  • Northflank

    

  • Render

    

  • HuggingFace Spaces

    

  • Elestio

    

  • Sealos

    

  • RepoCloud

    

☁️ Flowise Cloud

开始使用 Flowise Cloud。

🙋 支持

欢迎在讨论区中提出任何问题、反馈问题或请求新功能。

🙌 贡献

感谢以下优秀的贡献者：

请参阅贡献指南。如果您有任何疑问或遇到问题，请通过Discord与我们联系。

📄 许可证

本仓库中的源代码根据Apache许可证2.0版提供。

Flowise 快速上手指南

Flowise 是一款可视化的 AI 应用构建工具，允许用户通过拖拽组件的方式快速搭建 LLM 代理和工作流。

环境准备

在开始之前，请确保您的系统满足以下要求：

• 操作系统：Windows, macOS, 或 Linux
• Node.js：版本需 >= 18.15.0
  • 下载地址：https://nodejs.org/
  • 国内用户建议：如下载缓慢，可使用 Node.js 国内镜像 或通过 nvm 管理版本。
• 包管理器（可选但推荐）：
  • 普通安装仅需 npm（随 Node.js 自动安装）。
  • 若需二次开发，建议安装 pnpm：

    npm install -g pnpm
    

  • 加速提示：国内用户可配置 npm/pnpm 使用淘宝镜像源以提升安装速度：

    npm config set registry https://registry.npmmirror.com
    

安装步骤

您可以选择以下任意一种方式进行安装：

方式一：NPM 全局安装（最简单）

适合快速体验和使用。

1. 安装 Flowise

   npm install -g flowise
   

2. 启动服务

   npx flowise start
   

3. 访问界面 打开浏览器访问：http://localhost:3000

---

方式二：Docker 部署（推荐生产环境）

适合希望隔离环境或使用容器化部署的用户。

1. 克隆项目并配置环境变量

   git clone https://github.com/FlowiseAI/Flowise.git
   cd Flowise/docker
   cp .env.example .env
   

2. 启动容器

   docker compose up -d
   

3. 访问界面 打开浏览器访问：http://localhost:3000

   停止服务命令：docker compose stop

---

方式三：开发者源码安装

适合需要修改源码或贡献代码的开发者。

1. 克隆仓库

   git clone https://github.com/FlowiseAI/Flowise.git
   cd Flowise
   

2. 安装依赖

   pnpm install
   

3. 构建项目 注意：若遇到内存不足错误（Exit code 134），请先执行 export NODE_OPTIONS="--max-old-space-size=4096" (Windows 请使用对应 PowerShell 或 CMD 命令)。

   pnpm build
   

4. 启动开发服务

   pnpm start
   

   访问：http://localhost:3000

   若需热重载开发模式，请在 packages/ui 和 packages/server 下分别创建 .env 文件配置端口后，运行 pnpm dev，访问地址通常为 http://localhost:8080。

基本使用

安装启动成功后，您将进入 Flowise 的可视化操作界面：

1. 创建新流程：点击界面上的 "Add New" 按钮创建一个空白画布。
2. 添加组件：
   • 在左侧侧边栏浏览可用的节点（Nodes），例如 Chat Models (大模型), Prompts (提示词), Chains (链) 等。
   • 将所需的组件拖拽至画布中。
3. 连接节点：
   • 鼠标悬停在组件的输出点（右侧圆点），拖动连线至另一个组件的输入点（左侧圆点），建立数据流。
   • 例如：将 Chat Model 连接到 LLM Chain。
4. 配置参数：点击画布中的组件，在右侧面板填写 API Key、模型名称、提示词模板等具体参数。
5. 测试运行：
   • 点击右上角的 "Save" 保存流程。
   • 点击 "Play" 按钮，在弹出的聊天窗口中输入问题进行实时测试。
6. 集成使用：测试无误后，可点击 "Embed" 获取 API 端点或嵌入代码，将其集成到您的现有应用中。