This version is still in development and is not considered stable yet. For the latest stable version, please use StreamX Guides 1.1.0!

Set up a local environment for StreamX

This guide explains setting up a local environment to install and run StreamX.

macOS

To run StreamX locally on a macOS machine, the following applications are required to be installed:

Install Homebrew

Follow official instructions on the Homebrew homepage.

After installation, execute the suggested post-installation actions to ensure brew is available in all terminal windows.

Install Docker

Docker Desktop

The recommended approach is to use Docker Desktop. Follow the official installation guide.

Colima

Alternatively, you can install Docker in headless CLI mode by using Colima. If you choose this option, follow the Colima installation guide.

Running StreamX along with Colima-based Docker on macOS might result in certain errors. To avoid them:

  • Ensure Colima’s IP is reachable. See the Colima FAQ.

  • Set the following environment variables (add these lines to your $HOME/.zshrc file):

export DOCKER_HOST="unix:///Users/$(whoami)/.colima/default/docker.sock"
export TESTCONTAINERS_DOCKER_SOCKET_OVERRIDE="/var/run/docker.sock"
export TESTCONTAINERS_HOST_OVERRIDE="$(colima ls -j | jq -r '.address')"

Verify Docker installation

Run the following command to confirm Docker is working:

docker run hello-world

If the 'Hello from Docker!' message appears, the installation was successful and hello-world container runs correctly.

If you encounter permission errors, prefix the command with sudo:

sudo docker run hello-world

Install Java 17+

As recommended: Install Java 17+ with SDKMAN!.

Alternatively, follow the official Oracle installation guide.

Linux

To run StreamX locally on a Linux machine, install the following applications:

Install Homebrew

Follow official instructions on the Homebrew Documentation.

After installation, execute the suggested post-installation actions to ensure brew is available in all terminal windows.

Install Docker

Follow the official installation guide.

Verify Docker installation

Run the following command to confirm Docker is working:

docker run hello-world

If the 'Hello from Docker!' message appears, the installation was successful and hello-world container runs correctly.

If you encounter permission errors, prefix the command with sudo:

sudo docker run hello-world

Install Java 17+

As recommended: install Java 17+ using SDKMAN!.

Alternatively, follow the official Oracle installation guide.

Windows

To run StreamX locally on a Windows machine, install the following applications:

You will also need:

Install Docker

Use Docker Desktop. Follow the official installation guide.

Recommended configuration for WSL-based Docker

To use Docker Desktop with WSL and Ubuntu, enable integration in Docker Desktop Settings:

  • Go to Docker Desktop Settings → Resources → WSL Integration and configure WSL 2 distros you want to access Docker from:

    • Check Enable integration with my default WSL distro.

    • Under Enable integration with additional distros turn on Ubuntu option.

Verify Docker installation

Run the following command to confirm Docker is working:

docker run hello-world

If the 'Hello from Docker!' message appears, the installation was successful and hello-world container runs correctly.

If you encounter permission errors, prefix the command with sudo:

sudo docker run hello-world

Install Java 17+

There are the following options: * For CMD, install Java 17+ with Scoop. * For Linux VM, install with SDKMAN!. * Alternatively, follow the official Oracle installation guide.

Set up for Windows CMD

To run StreamX in Windows CMD, install Scoop - follow the official installation guide.

Set up for Linux VM terminal

Install GCC

Follow the official installation guide. On Debian-based distribution, install with:

sudo apt install gcc -y

Install Homebrew

Follow official instructions on the Homebrew Documentation.

After installation, execute the suggested post-installation actions to ensure brew is available in all terminal windows.

Summary

With the listed applications set up, your environment is ready to install and run StreamX.

Related content