totalplatform/flow

Total.js Flow Docker镜像文档

1. 镜像概述

Total.js Flow是一个基于Total.js后端框架构建的工作流管理工具Docker镜像，旨在提供可视化的工作流设计与执行环境。该镜像封装了Total.js Flow的核心功能，无需复杂的环境配置，可快速部署并集成到各类系统中，实现自动化任务调度、数据处理流程和业务流程管理。

2. 核心功能与特性

• 可视化工作流设计：通过Web界面拖拽组件创建流程，支持流程图实时预览和编辑
• 多类型触发器：支持定时触发、HTTP请求、数据库事件、消息队列等多种触发方式
• 丰富操作节点：内置HTTP请求、数据库操作、文件处理、脚本执行等常用操作组件
• 流程监控与日志：实时查看流程执行状态、历史记录和错误日志
• 轻量级架构：基于Node.js，资源占用低，启动速度快，适合边缘设备和服务器部署
• RESTful API：提供完整API接口，支持外部系统集成和流程远程控制
• 跨平台兼容：Docker化部署，支持Linux、Windows和macOS环境

3. 使用场景

• 自动化运维：服务器监控告警、日志备份、服务自动扩缩容等运维流程
• 业务流程自动化：订单处理、库存管理、客户通知等业务逻辑流程
• 数据处理管道：数据采集、清洗、转换、分析的自动化数据流程
• 集成中间件：连接不同系统（如CRM、ERP、邮件服务）的消息传递与数据同步
• 开发测试辅助：自动化测试执行、构建流程触发、环境部署等开发流程

4. 使用方法

4.1 快速启动

通过以下命令快速启动Total.js Flow容器：

bash
docker run -d \
  --name totaljs-flow \
  -p 8000:8000 \
  -v ./flow-data:/app/data \
  -e TZ=Asia/Shanghai \
  totaljs/flow:latest

参数说明：

• -p 8000:8000：映射容器8000端口到主机，用于Web界面访问
• -v ./flow-data:/app/data：挂载主机目录到容器，持久化存储工作流数据
• -e TZ=Asia/Shanghai：设置时区为上海

4.2 Docker Compose配置

创建docker-compose.yml文件，配置更复杂的部署环境：

yaml
version: '3'
services:
  totaljs-flow:
    image: totaljs/flow:latest
    container_name: totaljs-flow
    restart: always
    ports:
      - "8000:8000"
    volumes:
      - ./flow-data:/app/data
      - ./flow-templates:/app/templates
    environment:
      - TZ=Asia/Shanghai
      - FLOW_PORT=8000
      - FLOW_USER=admin
      - FLOW_PASSWORD=your_secure_password
      - DB_TYPE=sqlite # 支持sqlite/mysql/postgresql
      - LOG_LEVEL=info
    networks:
      - flow-network

networks:
  flow-network:
    driver: bridge

启动服务：

bash
docker-compose up -d

5. 配置参数

5.1 环境变量

5.2 数据持久化

为避免容器重启后数据丢失，需挂载以下目录：

• /app/data：存储工作流定义、执行日志、配置文件等核心数据
• /app/templates：自定义工作流节点模板目录（可选）

示例挂载命令：

bash
-v /host/path/to/flow-data:/app/data

6. 访问与使用

1. 容器启动后，通过浏览器访问 http://<主机IP>:8000
2. 使用配置的管理员账号（默认admin/admin）登录系统
3. 在Web界面中：
   • 通过左侧组件面板拖拽节点到画布创建工作流
   • 配置节点参数（如触发器条件、操作详情）
   • 连接节点形成完整流程并保存
   • 点击"执行"按钮启动工作流，在"监控"页查看运行状态和日志

7. 注意事项

• 首次登录后建议立即修改默认密码（FLOW_PASSWORD环境变量或在系统设置中修改）
• 生产环境中推荐使用MySQL/PostgreSQL替代默认SQLite数据库以提高性能和可靠性
• 若需通过HTTPS访问，可结合Nginx等反向代理配置SSL证书
• 定期备份/app/data目录以防止数据丢失