FUXA 开源项目安装与使用教程

FUXA 开源项目安装与使用教程

FUXAWeb-based Process Visualization (SCADA/HMI/Dashboard) software项目地址:https://gitcode.com/gh_mirrors/fu/FUXA

1. 项目目录结构及介绍

FUXA 的目录结构如下：

• app: 包含前端应用代码，主要用于Web界面。
• client: 客户端相关代码，如ODBC连接等。
• screenshots: 存放项目截图或示例图片资源。
• server: 后端服务代码，处理数据通信和逻辑。
• .gitignore: Git 忽略文件列表。
• Dockerfile: Docker 镜像构建文件。
• LICENSE: 项目许可证信息。
• README.md: 项目说明文档。
• SECURITY.md: 项目安全政策。
• compose.yml: Docker Compose 配置文件。

这些目录和文件构成了FUXA的核心组件，其中app和server是关键部分，分别负责前端展示和后端服务器功能。

2. 项目启动文件介绍

Docker 方式启动

• docker pull frangoteam/fuxa:latest: 拉取最新的FUXA Docker镜像。
• docker run -d -p 1881:1881 frangoteam/fuxa:latest: 运行容器并映射端口。
• 若需持久化存储，可添加挂载卷，例如：

  docker run -d -p 1881:1881 \
      -v fuxa_appdata:/usr/src/app/FUXA/server/_appdata \
      -v fuxa_db:/usr/src/app/FUXA/server/_db \
      -v fuxa_logs:/usr/src/app/FUXA/server/_logs \
      -v fuxa_images:/usr/src/app/FUXA/server/_images \
      frangoteam/fuxa:latest
  

NPM 方式安装

• 确保Node.js版本为14, 16 或 18。
• 使用NPM全局安装（不包含S7连接）：

  npm install -g --unsafe-perm @frangoteam/fuxa-min
  fuxa
  

• 或者从源码安装：
  • 下载最新发布版本并解压。
  • 安装Node.js版本14, 16 或 18。
  • 去除server/package.json中的node-snap7库（如不需要连接Siemens PLC）。
  • 在server目录下运行：

  npm install
  npm start
  

3. 项目配置文件介绍

FUXA的主要配置位于server/config/default.json。这里通常包括服务器设置，如端口、数据库连接信息、日志设置等。默认配置已经包含了基本的启动参数，如果需要自定义设置，可以创建一个新的JSON文件覆盖默认值，然后在启动时指定该配置文件。

{
  "httpServer": {
    "host": "localhost",
    "port": 1881,
    ...
  },
  "mqtt": {
    "brokerUrl": "mqtt://localhost",
    ...
  },
  "database": {
    "engine": "sqlite",
    "path": "./_db/data.db",
    ...
  },
  ...
}

通过修改这些参数，你可以定制FUXA服务器的行为和交互方式。

请注意，FUXA还可以通过环境变量来覆盖配置文件中的某些选项。具体环境变量的名称和它们如何影响配置可以在项目源码中找到。

FUXAWeb-based Process Visualization (SCADA/HMI/Dashboard) software项目地址:https://gitcode.com/gh_mirrors/fu/FUXA