The easiest way to install StreamPipes is our Docker-based installation. For production-grade deployments, we also recommend looking at our Kubernetes support, which is also part of the installation kit.
The Docker-based installation requires Docker and Docker Compose to be installed on the target machine. Installation instructions can be found below.
Go to https://docs.docker.com/installation/ and follow the instructions to install Docker for your OS. Make sure docker can be started as a non-root user (described in the installation manual, don’t forget to log out and in again) and check that Docker is installed correctly by executing docker-run hello-world
By default, Docker uses only a limited number of CPU cores and memory. If you run StreamPipes on Windows or on a Mac you need to adjust the default settings. To do that, click on the Docker icon in your tab bar and open the preferences. Go to the advanced preferences and set the **number of CPUs to 6** (recommended) and the **Memory to 4GB**. After changing the settings, Docker needs to be restarted.
Supported operating systems
The Docker-based installation supports the operating systems Linux, Mac OS X and Windows 10. Older windows versions are not fully compatible with Docker. Linux VMs running under Windows might cause network problems with Docker, therefore some manual work might be needed to make StreamPipes run properly.
The StreamPipes application itself will be accessible through a web browser. We recommend a recent version of Chrome ( best experience), Firefox or Edge.
1Download the latest Apache StreamPipes release and extract the zip file to a directory of your choice.
File Version Release Date Signatures apache-streampipes-installer-0.68.0-incubating-source-release.zip 0.68.0 2021-07-22 SHA PGP
2In a command prompt, open the folder
docker-compose up -d.The folder contains two docker-compose files: The standard file contains the so-called lite installation, which includes less pipeline elements, but also requires for less performant hardware. The full version includes also the Apache Flink wrapper and more pipeline elements, but requires for more memory. See the Github README for complete usage instructions.
3Open your browser, navigate to http://localhost:80 (or the domain name of your server) and finish the setup according to the instructions below.
Once you've opened the browser at the URL given above, you should see StreamPipes application as shown below. To set up the system, enter an email address and a password and click on install. After the installation has finished, continue by clicking on "Go to login page", once all components are successfully configured.
On the login page, enter your credentials, then you should be forwarded to the home page.
Congratulations! You've successfully managed to install StreamPipes. Now we're ready to build our first pipeline!
In most cases, errors during the installation are due to an under-powered system.
If there is a problem with any of the components, please restart the whole system (
docker-compose down and eventually also delete the volumes).
Please also make sure that your system meets the hardware requirements as mentioned in the first section of the installation guide.
That's it! To ease your first steps with StreamPipes, we've created an interactive tutorial.