Docker
Last updated
Was this helpful?
Last updated
Was this helpful?
The Stream Host Docker image is available from XMPro Platform v4.4.2+.
If your installation requires multiple Stream Hosts, please be aware that Stream Host must be applied as environment variables when running as a Container - enabling frictionless automation when creating multiple Stream Host instances.
A container runtime tool capable of running Docker images, such as .
The XMPro Docker Stream Host image has already met the rest of the and .
The following configuration settings are required to run the Docker Stream Host. Locate these values before you proceed.
xm__xmpro__Gateway__Id
xm__xmpro__Gateway__CollectionId
The ID of your Collection. This can be retrieved from a Data Stream Designer "Collection"
xm__xmpro__Gateway__Name
xm__xmpro__Gateway__Secret
The secret key of your Collection. This can be retrieved from a Data Stream Designer "Collection"
xm__xmpro__Gateway__ServerUrl
The server url for where Data Stream Designer is hosted. E.g. "https://mysampleserver/datastreamdesigner/". Please note that this URL needs to end in a forward slash.
xm__xmpro__Gateway__Rank
These settings can be found in Data Stream Designer:
Below is the XMPro Docker Stream Host repository.
All images are tagged with the release version number, starting from 4.4.2
. For example, use a version tag to reference the Stream Host for v4.4.2:
The latest
tag identifies the most recent XMPro Platform release version number, for example:
Using the latest
tag stores a copy of the image on your system. This cached version may not be the latest release if a newer release has since been published.
We recommend specifying the specific version or re-pulling the image if a newer release has occurred since your last Stream Host docker install.
A Stream Host running a Data Stream must provide the capabilities to run each Agents in the Data Stream. Choose your image depending on the capabilities that are required.
xmpro.azurecr.io/stream-host:[tag]
A lightweight Debian option capable of running most Agents. Available from v4.4.5.
xmpro.azurecr.io/stream-host-alpine:[tag]
A lightweight Alpine option capable of running most Agents. Available from v4.4.3.
xmprocontrib.azurecr.io/sh-ubuntu-python-nvidia:latest
xmprocontrib.azurecr.io/sh-alpine-python:latest
The docker image can be used to create a custom stream-host with additional Python modules installed. Use xmprocontrib.azurecr.io/sh-alpine-python:latest
as the base image for python workloads.
Example requirements.txt file
Example docker file
Please see the following examples to run Stream Host as a Container:
Run the Stream Host using the following command. Specify the version or add "--pull always
" to ensure you're using the newest release.
Stop the Stream Host using the following command.
In the same working directory ascompose.yaml
, run the following command to start the Stream Host.
In the same working directory ascompose.yaml
, run the following command to stop the Stream Host.
The stream host installation is complete. Please click below to install the default Agents & Connectors:
A unique identifier for a Stream Host instance. A can be used to generate a unique identifier.
The name that appears in Data Stream Designer when viewing . E.g. "SH1-Device1-Docker" or "SH2-Device2-Winx64".
An integer, by default is "0". See for further details
Ubuntu, Required when using the for CPU-only processing.
Alpine, Required when using the for CPU-only processing.
You may need a Stream Host that has capabilities that differ from the available such as additional Python modules (e.g. via pip).
Create an "envfile" containing the following (replacing <values>
with the actual )
Create a file called compose.yaml
in your working directory and paste the following (replacing <values>
with the actual ):
See for further details on how to use Docker Compose.