flowforge/node-red

FlowFuse Node-RED 容器文档

1. 镜像概述和主要用途

1.1 概述

FlowFuse Node-RED 容器是用于 FlowFuse Stacks 的基础容器镜像，专为 Kubernetes 和 Docker Compose 环境设计。该镜像基于最新版 Node-RED 构建，并集成了 FlowFuse 平台专用的启动器模块，实现 Node-RED 与 FlowFuse 平台的深度协同。

1.2 主要用途

• 作为 FlowFuse Stacks 的核心组件，支持在 Kubernetes 或 Docker Compose 环境中部署和运行 Node-RED 实例
• 提供 Node-RED 与 FlowFuse 平台的集成能力，实现实例生命周期管理、配置同步、资源监控等平台功能

2. 核心功能和特性

2.1 基础功能

• 基于最新 Node-RED：镜像构建自官方最新版 Node-RED，确保 Node-RED 核心功能及安全性更新
• FlowFuse 启动器集成：内置 FlowFuse 平台专用启动器模块，负责 Node-RED 与 FlowFuse 平台的通信和协同

2.2 平台集成特性

• 实例管理：支持通过 FlowFuse 平台控制 Node-RED 实例的启动、停止、重启
• 配置同步：自动从 FlowFuse 平台同步 Node-RED 实例配置（如流数据、插件列表、安全策略等）
• 资源监控：向 FlowFuse 平台上报实例资源使用情况（CPU、内存、网络等）

3. 使用场景和适用范围

3.1 适用场景

• FlowFuse 平台用户：需在 FlowFuse 平台上部署和管理 Node-RED 实例的用户
• Kubernetes 环境：用于 FlowFuse Stacks 在 Kubernetes 集群中的规模化部署
• Docker Compose 环境：适用于开发、测试或小规模生产环境的 FlowFuse Stacks 部署

3.2 适用范围

• 需通过 FlowFuse 平台统一管理多个 Node-RED 实例的场景
• 需实现 Node-RED 实例与 FlowFuse 平台功能（如团队协作、版本控制、权限管理）集成的场景

4. 使用方法和配置说明

4.1 环境要求

• Docker Engine 20.10+ 或 Kubernetes 1.21+
• 网络连通性：容器需能访问 FlowFuse 平台服务（如 API 端点、数据库等）

4.2 Docker 部署示例

4.2.1 docker run 命令

通过以下命令快速启动容器（需替换环境变量为实际值）：

bash
docker run -d \
  --name flowfuse-nodered \
  -p 1880:1880 \  # Node-RED 默认端口
  -e FLOWFUSE_PLATFORM_URL="https://your-flowfuse-platform.com" \  # FlowFuse 平台 URL
  -e FLOWFUSE_INSTANCE_ID="your-instance-id" \  # FlowFuse 平台分配的实例 ID
  -e FLOWFUSE_API_KEY="your-api-key" \  # 访问 FlowFuse 平台的 API 密钥
  flowfuse/node-red:latest

4.2.2 Docker Compose 配置

创建 docker-compose.yml 文件，示例配置如下：

yaml
version: '3.8'
services:
  flowfuse-nodered:
    image: flowfuse/node-red:latest
    container_name: flowfuse-nodered
    ports:
      - "1880:1880"
    environment:
      - FLOWFUSE_PLATFORM_URL=https://your-flowfuse-platform.com  # FlowFuse 平台 URL
      - FLOWFUSE_INSTANCE_ID=your-instance-id  # FlowFuse 实例 ID
      - FLOWFUSE_API_KEY=your-api-key  # FlowFuse API 密钥
      - NODE_RED_SETTINGS=/data/settings.js  # Node-RED 配置文件路径（默认）
    volumes:
      - ./nodered-data:/data  # 持久化 Node-RED 数据（可选）
    restart: unless-stopped

5. 配置参数（环境变量）

以下为容器运行时常用环境变量，用于配置 Node-RED 及与 FlowFuse 平台的集成：

6. 注意事项

• 容器需确保与 FlowFuse 平台网络连通，否则实例无法注册或同步配置
• 持久化数据卷（如 /data）建议挂载，避免容器重启后 Node-RED 流数据及配置丢失
• 环境变量 FLOWFUSE_API_KEY 需妥善保管，避免泄露导致实例被未授权访问
• 镜像版本需与 FlowFuse 平台版本匹配，具体兼容性信息请参考 FlowFuse 官方文档

7. 版本信息

• 基础镜像：最新版 Node-RED（具体版本可通过 docker inspect flowfuse/node-red:latest 查看）
• 启动器模块：与 FlowFuse 平台版本同步更新

（注：详细版本历史及更新日志请参考 FlowFuse 官方发布记录）