Docker
v4.4.19
Last updated
Was this helpful?
v4.4.19
Last updated
Was this helpful?
This guide covers the XMPro Stream Host Docker image available from version 4.4.19 onwards. The latest Stream Host images have been redesigned for improved security and usability.
A container runtime such as .
Stream Host
1 CPU, 4 GB RAM
2 CPU, 8GB RAM
4 CPU, 16GB RAM
Essential Environment Variables
xm__xmpro__Gateway__Id
Optional
Unique GUID identifier for this Stream Host instance.
Default: A new GUID
xm__xmpro__Gateway__Name
Optional
Display name in Data Stream Designer.
Default: "[Image-Version]-[Gateway Id]", e.g. "alpine3.21-python3.12-3bd462d4-4f1f-4cda-b6c5-d02f986beb6f"
xm__xmpro__Gateway__CollectionId
Required
ID of your Collection (available in Data Stream Designer)
xm__xmpro__Gateway__Secret
Required
Secret key of your Collection
(available in Data Stream Designer)
xm__xmpro__Gateway__ServerUrl
Required
The server URL for where Data Stream Designer is hosted. E.g. "https://dsserver/datastreamdesigner/". Please note that this URL needs to end in a forward slash.
xm__xmpro__Gateway__Rank
Optional
These settings can be found in Data Stream Designer:
Below is the XMPro Docker Stream Host repository.
All images are tagged with their version number. For example:
The latest
tag points to the most recent release:
Warning: Using the latest
tag caches the image locally. For guaranteed latest version, specify the exact version number or re-pull the image.
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:4.4.19-bookworm-slim
Debian (Default)
xmpro.azurecr.io/stream-host:4.4.19-bookworm-slim-python3.12
Debian with Python
xmpro.azurecr.io/stream-host:4.4.19-alpine3.21
Alpine
Alpine-based images offer a smaller footprint, ideal for environments where size matters
Debian-based images (Bookworm Slim) provide more comprehensive tools and libraries for general use
Python-enabled images come with Python pre-installed for running Python-based Agents and Connectors
For Python-enabled images, you can install packages using:
Either a requirements.txt
file,
Or the SH_PIP_MODULES
environment variable:
Specify the location of your requirements.txt
file using the PIP_REQUIREMENTS_PATH
environment variable:
Note: If not specified, the system will look for requirements.txt
in the default path /app
.
To install additional system packages (APK/APT), you can install it using environment variables:
Replace <values>
with your actual configuration settings.
With optional environment variables
Create a compose.yaml
file in your working directory:
With optional environment variables
Replace <values>
with your actual configuration settings.
Start the Stream Host:
Stop the Stream Host:
Your Stream Host installation is now complete. To install default Agents & Connectors, visit:
An integer, by default is "0". See for further details.
For more information on Docker Compose, see the .