quickhmi/runtime repository overview

⁠QuickHMI Runtime

Runtime for QuickHMI⁠, the browser-based HMI and SCADA software by Indi.An GmbH. You design the visualization in the QuickHMI Editor on Windows and export it as a project file (.qexp). This container runs the project, and operators open it in any web browser.

This image contains the Lynx product line (QuickHMI 14).

⁠Tags and platforms

There is no latest tag. docker pull quickhmi/runtime without a tag fails with manifest for quickhmi/runtime:latest not found. Always specify a tag, for example quickhmi/runtime:lynx.

Platforms: linux/amd64 and linux/arm64 (for example Raspberry Pi with a 64-bit operating system).

⁠Quick start

docker run -d --name quickhmi --hostname quickhmi --restart unless-stopped --stop-timeout 120 -e ACCEPT_EULA=Y -p 6068:6068 -p 6070:6070 -v qhmi_prog:/home/quickhmi -v qhmi_data:/usr/share/QuickHMI quickhmi/runtime:lynx

⁠Load a project

Copy the exported project into the container and import it:

docker cp project.qexp quickhmi:/usr/share/QuickHMI/import/project.qexp
docker exec -it quickhmi qhmiRM -i /usr/share/QuickHMI/import/project.qexp

Then open the project in a browser, for example https://<host>:6070.

If the import reports "Update available", the project comes from a newer QuickHMI Editor than the runtime in the container. Apply the update and start the instance:

docker exec -it quickhmi qhmiRM -v
docker exec -it quickhmi qhmiRM -start -instance=1

Keep project files in /usr/share/QuickHMI/import: the runtime reads them again during updates.

⁠Manage the runtime

docker exec -it quickhmi qhmiRM -r

opens the console RuntimeManager for instances, projects and certificates. After the container starts, wait 15 to 20 seconds until the projects are reachable before starting or stopping instances.

⁠Docker Compose

services:
  quickhmi:
    image: quickhmi/runtime:lynx
    container_name: quickhmi
    hostname: quickhmi
    restart: unless-stopped
    stop_grace_period: 120s
    environment:
      ACCEPT_EULA: "Y"
    ports:
      - "6068:6068"
      - "6070:6070"
    volumes:
      - qhmi_prog:/home/quickhmi
      - qhmi_data:/usr/share/QuickHMI

volumes:
  qhmi_prog:
    name: qhmi_prog
  qhmi_data:
    name: qhmi_data

The volume names match the docker run command above, so you can switch between both without losing your data.

⁠Updates

• Runtime: updates itself when you import a project from a newer QuickHMI Editor. A newer image does not change the runtime in an existing qhmi_prog volume.
• Operating system and Java: pull the image again and recreate the container with the same volumes. Your instances, projects and certificates remain.

⁠Data sources

Siemens S7 (including symbolic access), Modbus (master and slave), Beckhoff TwinCAT, Allen-Bradley, OPC UA, OPC UA PubSub, MQTT, BACnet, KNX, SQL databases, InfluxDB, web services, files, and a Java API for your own data sources.

⁠Limitations

• Allen-Bradley is not available on linux/arm64.
• Serial interfaces must be passed into the container with --device on a Linux host. Docker Desktop cannot pass them through.
• Use published ports (-p). Host networking (--network host) is not supported.

⁠Links

• Product⁠
• How QuickHMI works⁠
• Documentation⁠
• License activation⁠
• Community Mode⁠
• Forum⁠