English | 繁體中文 | 简体中文 | 日本語 | 한국어

可视化构建 AI Agent

📚 目录

• ⚡ 快速开始
• 🐳 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 在一个单一的 mono repo 中包含 3 个不同的模块。

• server: 提供 API 逻辑的 Node 后端
• 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
   

   如果运行上述 build 脚本时出现 Exit code 134 (JavaScript heap out of memory) 错误，请尝试增加 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 文档。

🌐 自托管

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

• AWS
• Azure
• Digital Ocean
• GCP
• 阿里云 (Alibaba Cloud)
• 其他
  • Railway
  • Northflank