- The lite version (if you simply want to run StreamPipes on a laptop for testing purposes) requires at least 4GB RAM, the full version requires at least 10 GB RAM.
- Docker (latest version, see instructions below)
- Docker Compose (latest version., see instructions below)
Supported operating systems
We rely on Docker and support three operating systems for the StreamPipes system
- Windows 10
- Please note that older Windows versions are not compatible with Docker. Also Linux VMs under Windows might not work, due to network problems with docker.
StreamPipes is a modern web application, therefore you need a recent version of Chrome (recommended), Firefox or Edge.
You need to have Docker installed on your system before you continue with the installation guide.
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 8GB**. After changing the settings, Docker needs to be restarted.
1Download the latest StreamPipes release from Github and extract the zip file to a directory of your choice.
2Linux/Mac: In a command prompt, open the folder
Windows 10: In a command prompt, open the folder
3When asked, enter the version (full or lite) and the IP address or hostname of your server (called SERVER_IP in the next step).
4Open your browser, navigate to http://SERVER_IP:80 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. At this point, it is not necessary to change anything in the advanced settings menu. The installation might take some time, 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 a wrongly configured IP address or an under-powered system.
If there is a problem with any of the components, please restart the whole system and delete the "config" directory on the server. This directory is in the same folder as the docker-compose.yml file.
Please also make sure that your system meets the hardware requirements as mentioned in the first section of the installation guide.
Now you can continue with the tutorial on page First steps.