Docker

The Docker image file HighByte-Intelligence-Hub-X.X.X Docker (Build XXXX.X.X.X).tar includes the Intelligence Hub runtime and configuration components, and is built from the alpine linux image with OpenJDK 21. This section covers how to install and run the docker image.

This is an x86_64 image. Other CPU architectures such as arm64 require building your own image from the installer.

Install

Run the following docker command to load the docker image:

docker load -i "HighByte-Intelligence-Hub-X.X.X Docker (Build XXXX.X.X.X).tar"

Setup a volume to host the application configuration. This step is optional, but recommended so that you do not lose your configuration when performing future image updates.
```
docker volume create hb_vol
```
Run the image. The below command includes making all ports available, but you may choose to restrict the ports. Remove the –mount source=hb_vol if not using a volume.
```
docker run -p 45245:45245 -p 1885:1885 -p 8885:8885 -p 45345:45345 --name highbyte highbyte:X.X.X
```

Optional flags

If you wish to use a volume, add --mount source=hb_vol to the run command.

docker run -p 45245:45245 -p 1885:1885 -p 8885:8885 -p 45345:45345 --name highbyte --mount source=hb_vol,target=/usr/local/highbyte/appData highbyte:X.X.X

If you want the container to restart after a failure, add the --restart=on-failure flag.

docker run -p 45245:45245 -p 1885:1885 -p 8885:8885 -p 45345:45345 --name highbyte --restart=on-failure highbyte:X.X.X

Below is a list and description of each of the default ports.

Port	Description
45245	REST API used for configuration.
1885	Internal MQTT Broker.
8885	REST data server.
45345	MCP server.

Changes to the ports require the container to be recreated. Changing the ports from the user interface will not change the container ports and may interrupt connections.