flowforge/file-server

FlowFuse File Server 容器文档

镜像概述和主要用途

FlowFuse File Server容器是为FlowFuse平台提供文件存储支持的后端服务，主要用于替代Node-RED原生文件节点，为基于FlowFuse的应用提供可靠的文件存储解决方案。

核心功能和特性

• 后端支持：为FlowFuse替代Node-RED文件节点提供底层存储支持，实现文件的上传、下载和管理功能。
• 多存储方式：支持通过挂载本地卷（本地文件系统）或S3兼容对象存储桶两种方式存储文件，满足不同部署环境的存储需求。
• 灵活配置：通过外部配置文件自定义存储参数，适配本地存储或云存储场景。

使用场景和适用范围

适用于采用FlowFuse平台构建应用，且需要替代Node-RED原生文件节点进行文件管理的场景。尤其适合以下情况：

• 需要将文件存储在本地服务器（通过挂载卷）的私有化部署场景。
• 需要将文件存储在云对象存储（如AWS S3、MinIO等S3兼容服务）的云部署场景。

使用方法和配置说明

配置文件要求

容器通过挂载外部配置文件flowforge-storage.yml进行存储参数配置，配置文件需挂载至容器内固定路径：
/usr/src/flowforge-file-server/etc/flowforge-storage.yml

配置文件内容示例

配置文件需根据存储类型（本地卷或S3）定义参数，以下为两种存储方式的基础配置示例：

1. 本地卷存储配置（示例）

yaml
storage:
  type: local
  path: /data/files  # 容器内文件存储路径（需配合外部卷挂载）

2. S3存储桶配置（示例）

yaml
storage:
  type: s3
  bucket: my-flowfuse-files  # S3存储桶名称
  endpoint: https://s3.example.com  # S3服务端点（如AWS S3无需指定，其他兼容服务需填写）
  accessKeyId: "your-access-key"  # S3访问密钥ID
  secretAccessKey: "your-secret-key"  # S3密钥
  region: "us-east-1"  # S3区域（如适用）

容器部署示例

1. 使用本地卷存储的部署命令

通过docker run启动容器，挂载本地配置文件和数据卷：

bash
docker run -d \
  --name flowfuse-file-server \
  -v /host/path/to/flowforge-storage.yml:/usr/src/flowforge-file-server/etc/flowforge-storage.yml \  # 挂载配置文件
  -v /host/local-storage-path:/data/files \  # 挂载本地数据卷（需与配置文件中path一致）
  flowfuse/file-server:latest

2. 使用S3存储的部署命令

仅需挂载配置文件（S3存储无需本地卷，存储路径由S3服务管理）：

bash
docker run -d \
  --name flowfuse-file-server \
  -v /host/path/to/flowforge-storage.yml:/usr/src/flowforge-file-server/etc/flowforge-storage.yml \  # 挂载S3配置文件
  flowfuse/file-server:latest

注意事项

• 配置文件必须正确挂载，否则容器可能无法启动或无法正常存储文件。
• S3存储配置需确保容器网络可访问S3服务端点，且访问密钥具有存储桶的读写权限。
• 本地卷存储时，需确保宿主机挂载目录有足够权限（容器内进程需读写权限）。