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

Set up a local environment for StreamX

This guide explains how to set 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:

  1. Homebrew

  2. Docker

  3. Java 17+

Homebrew

To install Homebrew, follow official instructions on the home page: https://brew.sh/. Execution of post-installation actions suggested by the Homebrew installer is recommended to have brew permanently available in all new terminal windows.

Docker

  1. Usage of Docker Desktop is recommended. To install it, follow this official guide: https://docs.docker.com/desktop/setup/install/mac-install/.

  2. Docker can be also installed in a headless mode that is exclusively CLI version. However, the installation process for this option isn’t officially documented. If you decide to choose this option anyway, it is recommended to use Colima for that purpose. See official Colima installation guide for details: https://github.com/abiosoft/colima/blob/main/README.md.

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

    1. Ensure that Colima’s IP is reachable: https://github.com/abiosoft/colima/blob/main/docs/FAQ.md#the-virtual-machines-ip-is-not-reachable.

    2. Ensure the following environmental variables are set (among others, the lines below can be appended 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')"

  3. To verify that your Docker environment is fully functional, execute docker run hello-world command. If the hello-world container runs successfully, you’ll see the "Hello from Docker!" message.

  4. Depending on your system setup, you might have to prefix Docker commands with sudo, especially if you encounter permission errors. For example, instead of docker run hello-world, use sudo docker run hello-world.

Java 17+

  1. Ensure Java 17 or higher is installed on your machine.

  2. It is recommended to install Java 17+ with SDKMAN!. Alternatively to SDKMAN!, Java 17 can be installed following this official guide: https://docs.oracle.com/en/java/javase/17/install/index.html.

Linux

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

  1. Homebrew

  2. Docker

  3. Java 17+

Homebrew

To install Homebrew, follow this official guide: https://docs.brew.sh/Homebrew-on-Linux. Execution of post-installation actions suggested by the Homebrew installer is recommended to have brew permanently available in all new terminal windows.

Docker

  1. To install Docker, follow this official guide: https://docs.docker.com/engine/install/.

  2. To verify that your Docker environment is fully functional, execute docker run hello-world command. If the hello-world container runs successfully, you’ll see the "Hello from Docker!" message.

  3. Depending on your system setup, you might have to prefix Docker commands with sudo, especially if you encounter permission errors. For example, instead of docker run hello-world, use sudo docker run hello-world.

Java 17+

  1. Ensure Java 17 or higher is installed on your machine.

  2. It is recommended to install Java 17+ with SDKMAN!. Alternatively to SDKMAN!, Java 17 can be installed following this official guide: https://docs.oracle.com/en/java/javase/17/install/index.html.

Windows

On Windows, StreamX can be run either inside Windows Command Prompt (CMD) or inside a Linux VM terminal. In both cases, Docker and Java 17+ are required to be installed.

  1. Docker

    1. Usage of Docker Desktop is recommended. To install it, follow this official guide: https://docs.docker.com/desktop/setup/install/windows-install.

    2. Among available options of Docker Desktop installation, it is recommended to choose the one with WSL backend based on Ubuntu.

    3. In case of usage of Docker Desktop based on WSL with Ubuntu, go to Docker Desktop Settings → Resources → WSL Integration and ensure that both Enable integration with my default WSL distro and Enable integration with additional distros: Ubuntu options are enabled.

    4. To verify that your Docker environment is fully functional, execute docker run hello-world command. If the hello-world container runs successfully, you’ll see the "Hello from Docker!" message.

    5. Depending on your system setup, you might have to prefix Docker commands with sudo, especially if you encounter permission errors. For example, instead of docker run hello-world, use sudo docker run hello-world.

  2. Java 17+

    1. Ensure Java 17 or higher is installed on your machine.

    2. For CMD it is recommended to install Java 17+ with Scoop and for Linux VM terminal installation with SDKMAN! is advised. Alternatively, Java 17 can be installed following this official guide: https://docs.oracle.com/en/java/javase/17/install/index.html.

Windows Command Prompt (CMD)

To run StreamX locally on a Windows machine inside CMD, Scoop (scoop) package manager should be installed. To install Scoop, follow this official guide: https://github.com/ScoopInstaller/Install#readme.

Linux VM terminal

To run StreamX locally on a Windows machine inside a Linux VM terminal, GNU Compiler Collection (GCC) and Homebrew are required to be installed.

  1. GNU Compiler Collection (GCC)

    To install GNU Compiler Collection (GCC), follow this official guide: https://gcc.gnu.org/install/. On Debian-based Linux distributions, including Ubuntu, the installation can be performed with the following command:

    sudo apt install gcc -y

  2. Homebrew

    To install Homebrew, follow the official guide: https://docs.brew.sh/Homebrew-on-Linux. Execution of post-installation actions suggested by the Homebrew installer is recommended to have brew permanently available in all new terminal windows.

Next steps

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